exportVersions
API v40 で更新されました。(2024 年 9 月 21 日)。
この API はユーザーのみをサポートします 概念: アクセス ルール API v22 以上
カテゴリ | Metadata retrieval |
説明 | 検証されると、このメソッドはリクエスト元のユーザーに対して非表示になっていないインスタンス内で定義されたすべてのバージョンのセットを示す XML ドキュメントを返します。 |
起動に必要な権限 | なし (インスタンスに対して有効な認証情報である必要があります) |
リクエストに応じてパラメータが必要 | 認証情報 |
このメソッドのリクエストには、呼び出し元のユーザーを識別して認証するための認証情報タグのみが含まれています。検証されると、このメソッドはリクエスト元のユーザーに対して非表示になっていないインスタンス内で定義されたすべてのバージョンのセットを示す XML ドキュメントを返します。
リクエストのフォーマット
<?xml version='1.0' encoding='UTF-8'?> <call method="exportVersions" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> </call>
認証情報要素 | |||
タグ名 | 認証情報 | ||
説明 | すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功: | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
ログイン | あり | API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。 | sampleuser@company.com |
password | あり | API メソッドを呼び出すユーザーのパスワード。 | my_password |
ロケール | なし | 入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。 | fr_FR |
instanceCode | なし | 認証情報で指定されたユーザーが の複数のインスタンスにアクセスできる場合、 Adaptive Planning 、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。 | MYINSTANCE1 |
エレメントの内容 | |||
(なし) | |||
要素を含める | |||
タグ名 | 含める | ||
説明 | バージョンの情報のどの側面を応答に含めるか、または応答から除外するかを示すフラグのセットを表します。この要素は任意です。存在しない場合、API はすべてのバージョン情報を返します。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
rootActuals 2019.3 時点では、どの API バージョンでもサポートされていません。 | なし | バージョン セレクターから実績が非表示になっているときにルート実績バージョンを含めるかどうかを示します。 | false |
シナリオ | なし | 非公開の What-If シナリオを回答に含めるかどうかを示します。 | false |
currencyVersions
API v40 以上で使用可能 | なし | 換算実績の通貨バージョンを回答に含めるかどうかを示します。
お使いのインスタンスがこの機能の対象となるかどうかを確認するには、指定サポート連絡先にご連絡ください。 | false |
エレメントの内容 | |||
(なし) | |||
回答フォーマット
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <versions seqNo="32"> <version id="1" name="Actuals" shortName="" type="ACTUALS" isVirtual="false" description="Total Actuals" isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="0" startVer="2012" completedValuesThru="03/2012" startScroll="01/2012" endVer="2016" lockLeading="" > <version id="5" name="Adjusted Actuals" shortName="SV-13" type="ACTUALS" isVirtual="false" description="Actuals SubVersion" isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="0" > <version id="6" name="Original Import" shortName="SSV-13" type="ACTUALS" isVirtual="false" description="Values Imported from the GL" isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="1" /> <version id="8" name="Manual Adjustments" shortName="SSV-14" type="ACTUALS" isVirtual="false" description="Actuals Sub-Version for Manual Adjustments" isDefaultVersion="false" isLocked="false" hasAuditTrail="true" isImportable="1" /> </version> <version id="9" name="Eliminations" shortName="ELIM" type="ACTUALS" isVirtual="false" description="Eliminating entries" isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="0" /> </version> <version id="2" name="Budget 2013" shortName="" type="PLANNING" isVirtual="false" description="This is the budget for 2013 with a five-year span." isDefaultVersion="true" isLocked="false" hasAuditTrail="true" isImportable="1" leftScroll="2013" startPlan="01/2013" endPlan="2017" lockLeading="05/2013" /> <version id="10" name="Worst Case" shortName="S13-A-WC" type="SCENARIO" isVirtual="false" description="Worst Case for Budget 2013" isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="0" isPredictive="false" /> </version> <version id="3" name="Budget 2014" shortName="B-14" type="PLANNING" isVirtual="false" description="This is the budget for 2014 with a five-year span." isDefaultVersion="false" isLocked="false" hasAuditTrail="false" isImportable="1" leftScroll="2014" startPlan="01/2014" endPlan="2018" lockLeading="" /> </versions> </output> </response>
回答エレメント | |||
タグ名 | response | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
成功 | あり | 真偽のいずれか。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。 | 真 |
廃止 | なし | レスポンス タグに存在し、true に設定されている場合、この属性は呼び出されているメソッドまたは API のバージョンが廃止され、廃止予定であることを示します。現時点では機能し続けていますが、まもなく機能が停止する可能性があります。通常、この属性は存在しません。 | false |
エレメントの内容 | |||
単一の任意のメッセージ要素と、厳密に 1 つの必須の出力要素。 | |||
出力要素 | |
タグ名 | 出力 |
要素の特性 | |
(なし) | |
エレメントの内容 | |
単一の科目要素この出力ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。 | |
バージョン要素 | |||
タグ名 | バージョン | ||
説明 | 1 つ以上のバージョン要素のコンテナです。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
連番 API v17 で追加されましたが、将来の使用のために予約されています。 | |||
エレメントの内容 | |||
1 つ以上のバージョン要素 | |||
バージョン要素 | |||
タグ名 | バージョン | ||
説明 | exportVersions API 呼び出しへの応答で返される単一のバージョンを表します。 | ||
要素の特性 | |||
特性名 | 必須？ | 値 | 例 |
ID | あり | バージョンまたはフォルダの内部システム ID 番号。すべての ID は、すべてのバージョン、サブバージョン、およびフォルダ間で一意になります。 | 2 |
名前 | あり | "バージョンの管理" に表示されるバージョンまたはフォルダの名前。 | 2015 年予算 |
shortName | なし | バージョンの管理で入力されたバージョンの短縮名 (存在する場合) | B2015 |
type
API v37 で更新されました。 | あり | 次の値のいずれかを選択します。
| 実績 |
isVirtual API v16 以上で使用可能 | あり | 仮想バージョンかどうかを示す true または False | false |
説明 | あり | "バージョンの管理" に表示されるバージョンまたはフォルダの説明。 | これは、5 年スパンの 2015 年の予算です。 |
isDefaultVersion | あり | バージョンがデフォルト バージョンであるかどうかを示します。バージョンがデフォルト バージョンである場合は真、それ以外の場合は偽です。 | 真 |
isLocked | なし | バージョンが「グローバルにロック」されている ("ロック済バージョン" チェックボックスがオンになっている) かどうかを示します。存在しない場合、そのバージョンはロック済とは見なされません。実績バージョンまたはフォルダでは、常に "false" になります。 | 真 |
hasAuditTrail | あり | バージョンで "変更履歴" が有効になっているかどうかを示します。 | 真 |
enabledForWorkflow API v17 以上で使用可能 | なし | ワークフローに対してバージョンが有効かどうかを示します。 | 1 |
isImportable | なし | この API をリクエストしているユーザーが、バージョンにデータをインポートすることを許可されているかどうかを示します。0 はそのバージョンでインポートを受け入れることができないことを意味し、1 はインポートを受け入れることを意味します。指定されたバージョンの少なくとも 1 つのタイムスロットがこのユーザーに対してインポート可能である場合、そのバージョンはインポート可能です。 | 1 |
startVer | なし | バージョンが開始するルート期間のコード。バージョン管理ページの "バージョンの開始" に相当します。この特性は、ルート実績バージョンに対してのみ表示されます。この属性は、ルート実績バージョンの場合は必須です。 | 2015 |
endVer | なし | バージョンが終了するルート期間のコード。バージョン管理ページの "バージョンの終了" に相当します。この特性は、ルート実績バージョンに対してのみ表示されます。この属性は、ルート実績バージョンの場合は必須です。 | 2015 |
startScroll | なし | 計画が開始される最下位期間のコード。バージョン管理ページのスクロールの開始場所と同じです。この特性は、ルート実績バージョンに対してのみ表示されます。この属性は、ルート実績バージョンの場合は必須です。 | 2015/01 |
completedValuesThru | なし | ルート実績にデータが入力された最新の最下位期間のコード。標準カレンダーでは、これは月になります。バージョン管理ページの で入力された値と同じです。この特性は、ルート実績バージョンに対してのみ表示されます。この属性は、ルート実績バージョンでは任意です。 | 03/2015 |
leftScroll | なし | バージョンが開始するルート期間のコード。バージョン管理ページの表示開始月と同じです。この特性は、プランニング バージョンにのみ表示されます。この特性は、計画バージョンに必要です。 | 2015 |
startPlan | なし | 計画が開始される最下位期間のコード。バージョン管理ページの "計画の開始" に相当します。この特性は、Planning バージョンでのみ表示され、Planning バージョンでは必須です。 | 02/2015 |
endPlan | なし | バージョンが終了するルート期間のコード。バージョン管理ページの "計画の終了" に相当します。この特性は、プランニング バージョンにのみ表示されます。この特性は、計画バージョンに必要です。 | 2015 |
lockLeading | なし | バージョン値がロックされる最下位期間のコード。バージョン管理ページで次の時点までのすべての月をロックするのに相当します。この特性は、ルート実績バージョンと計画バージョンにのみ表示されます。この属性は、ルート実績バージョンと計画バージョンでは任意です。 | 05/2015 |
isPredictive API v28 以上で使用可能 | あり | バージョンが予測バージョンであるかどうかを示します。 | false |
エレメントの内容 | |||
このバージョンの直接の子バージョンごとに 1 つのネストされたバージョン要素 | |||