exportCalendar

この API は API v33+ でサポートされています。

API v40 (2024 年 9 月 21 日) に更新。

カテゴリ	Metadata retrieval
説明	カレンダーのメタデータを返します。
起動に必要な権限	なし (インスタンスに対して有効な認証情報である必要があります)
リクエストに応じてパラメータが必要	認証情報

このメソッドのリクエストには、呼び出し元のユーザーを識別し、認証するための認証情報タグが含まれています。呼び出し元が確認されると、このメソッドはカレンダー情報の完全なリストを示す XML ドキュメントを返します。

リクエストのフォーマット

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportCalendar" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
</call>

認証情報要素
タグ名		認証情報
説明		すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功:
要素の特性
特性名	必須？	値	例
ログイン	あり	API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。	sampleuser@company.com
password	あり	API メソッドを呼び出すユーザーのパスワード。	my_password
instanceCode	なし	認証情報で指定されたユーザーが Adaptive Planning の複数のインスタンスにアクセスできる場合、この属性を使用して、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンスコードを決定するには、exportInstances API を使用します。	MYINSTANCE1
エレメントの内容
(なし)

回答フォーマット


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<output>
<calendars>
  <calendar id="1" isDefault="true" name="DefaultTimeHierarchy" />
</calendars>
</output>
</response>

回答エレメント
タグ名		response
要素の特性
特性名	必須？	値	例
成功	あり	"true" または "false"。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。	真
エレメントの内容
正確に 1 つの出力要素が必要です。

出力要素
タグ名	出力
要素の特性
(なし)
エレメントの内容
単一の必須カレンダー要素。この出力ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。

カレンダーエレメント
タグ名		カレンダー
説明		1 つ以上のカレンダー要素のコンテナです。
要素の特性
特性名	必須？	値	例
(なし)
エレメントの内容
1 つ以上のカレンダー要素

カレンダー要素
タグ名		カレンダー
説明		カレンダーを表します。
要素の特性
特性名	必須？	値	例
ID	あり	特定のカレンダーの特定の整数識別子を保持します。	1
isDefault	あり	"true" または "false" のいずれかで、特定のカレンダーがデフォルトカレンダーであるかどうかを示します。	真
名前	あり	カレンダー名を含みます。	DefaultTimeHierarchy
code API v40 以上で使用可能	なし	カレンダーコードが存在する場合は、カレンダーコードが含まれます。	DefaultTimeHierarchy
エレメントの内容
(なし)