exportLevels
この API はユーザーのみをサポートします 概念: アクセス ルール API v22 以上
カテゴリ | Metadata retrieval |
説明 | システムにおけるすべての組織レベルの完全なリストのメタデータを返します。 |
起動に必要な権限 | なし (インスタンスに対して有効な認証情報である必要があります) |
リクエストに応じてパラメータが必要 | 認証情報 |
このメソッドのリクエストには、呼び出したユーザーを識別し、認証する認証情報タグと、どの組織を回答に含めるかを示すオプションの含めるタグが含まれています。ユーザー認証情報が確認されると、このメソッドはリクエストに対応するシステム内の組織レベルのセットを示す XML ドキュメントを返します。ある組織タグが別の組織タグを囲む中、ネストされたツリー形式で組織が返されます。ある組織は、そのタグで表される組織が、その組織の親である場合に役立ちます。
組織のフィルタリング
- バージョンが指定されている場合、使用不可の組織/バージョンのフィルタリングが常に適用されます。
- ユーザーがリクエストでユーザー割当シートを指定した場合:
- ユーザーがそのシートへのアクセス権がある場合は、組織が返されます。管理ユーザーの場合inaccessibleValuesが真の場合、組織はシートについて返されます。
- ユーザーの組織アクセス権に関係なく、ユーザーがシートへのアクセス権がある場合は、シート上のすべての組織が返されます。
- ユーザーがリクエストで組織割当シートを指定した場合、次のようになります。
- ユーザー アクセスのフィルタリングは、によって必要な場合に適用されますinaccessibleValues,ユーザーがアクセスできない組織を回答に含めるかどうかを決定します。
- その後、シートのフィルタリングが適用されます。
リクエストのフォーマット
<?xml version='1.0' encoding='UTF-8'?> <call method="exportLevels" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <include versionID="3" inaccessibleValues="false"/> <sheet id="3" /> </call>
認証情報要素 | |||
タグ名 | 認証情報 | ||
説明 | すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行することを示します)。そのため、このユーザーは API を利用してアクションを実行するために必要な権限を持っている必要があります。を呼び出してください。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
ログイン | あり | API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。 | sampleuser@company.com |
password | あり | API メソッドを呼び出すユーザーのパスワード。 | my_password |
ロケール | なし | 入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。 | fr_FR |
instanceCode | なし | 認証情報で指定されたユーザーが の複数のインスタンスにアクセスできる場合、 Adaptive Planning 、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。 | MYINSTANCE1 |
エレメントの内容 | |||
(なし) | |||
要素を含める | |||
タグ名 | 含める | ||
説明 | 組織の情報のどの側面を回答に含めるか、または回答から除外するかを示すフラグのセットを表します。この要素は任意です。存在しない場合のデフォルト値は、inactiveValues のデフォルト値は false で、versionName/versionID のデフォルト値は空白 (またはすべてのバージョン) になります。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
グループ API v23+ で使用可能 | なし | 応答内の組織の要素に groupIds 特性が含まれるかどうかを示します。True の場合、応答の groupIds には、組織が属しているすべてのグループのカンマ区切りリストが含まれます。特性が存在しない場合、またはその値が true または False 以外の場合は、デフォルト値の False が使用されます。 | 真 |
inaccessibleValues API v18+ で使用できます。 | なし | ユーザーにアクセス権のない組織を応答に含めるかどうか。True または False のいずれかです。 要素またはその特性が存在しない場合のデフォルトは false です。 false に設定すると、直接的であるか暗黙的に、ユーザーがデータにアクセスできる組織のみが応答に含まれます。これは、応答が組織の単一ルート ツリーではなく、ツリー全体における一連の異なるサブツリーである可能性があることを意味しています。 このオプションを true に設定できるのは、"組織構造: すべての組織" または "すべての組織にインポートする" 権限を持つユーザーのみです。 | false |
inaccessibleLevels API v17 以前で使用できます。API v18+ では使用できません。 | なし | True または False のいずれかです。ユーザーにアクセス権のない組織を応答に含めるかどうか。 要素またはその特性が存在しない場合のデフォルト値は true です。false に設定すると、直接的であるか暗黙的に、ユーザーがデータにアクセスできる組織のみが応答に含まれます。これは、応答が組織の単一ルート ツリーではなく、ツリー全体における一連の異なるサブツリーである可能性があることを意味しています。 | 真 |
versionName API v18 で更新済 | なし | リクエストされたバージョン名で使用可能な組織のみを回答に含めるかどうかを示します。要素またはその特性が存在しない場合のデフォルトでは、すべての組織が返されます。バージョン名が指定されている場合、指定されたバージョンで使用可能な組織のみが返されます。 存在する場合は、inactiveValues 特性も適用され、指定されたバージョンで使用可能で、リクエスト元のユーザーがアクセスできる組織のみが返されます。 指定したバージョン名が見つからない場合、この API はエラーを返します。versionName 特性と versionID 特性の両方が渡された場合、versionID は無視されます。 バージョンを指定した場合、ユーザーがそのバージョンへのアクセス権を持っている場合にのみ、呼び出しが成功します。 | Engineering |
versionID API v18 で更新済 | なし | パラメータとしてバージョン ID 番号を取ることを除き、versionName (上記) と同じ。リクエストされたバージョンで使用可能な組織のみを応答に含めるかどうかを示します。要素またはその特性が存在しない場合のデフォルトでは、すべての組織が返されます。バージョン ID が指定されている場合、指定されたバージョンで使用可能な組織のみが返されます。 存在する場合は、inactiveValues 特性も適用され、指定されたバージョンで使用可能で、リクエスト元のユーザーがアクセスできる組織のみが返されます。 指定されたバージョン ID が見つからない場合、この API はエラーを返します。versionName 特性と versionID 特性の両方が渡された場合、versionID は無視されます。 バージョンを指定した場合、ユーザーがそのバージョンへのアクセス権を持っている場合にのみ、呼び出しが成功します。 | 3 |
未分類 インスタンスがセキュリティのために アクセス ルール を使用する場合、API v22+ でサポートされます。 | なし | 回答に仮想組織を含めるかどうかを示します。デフォルトは false です。仮想組織は、ユーザーがアクセス権を持っている場合のみ、応答に含まれます。 | false |
displayNameEnabled
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | displayNameEnabled=true は、exportLevels が の表示名プロパティに従う必要があることを示します code , displayNameType 、および description インスタンスで "表示名の有効化" がオンの場合。displayNameEnabled=false は、インスタンスで "表示名の有効化" がオンになっている場合でも、exportLevels API が v30 前の API 契約に従う必要があることを示します。exportLevels API は表示名プロパティを無視します code , displayNameType および description 。displayNameEnabled のデフォルト値は "false" です。 | false |
エレメントの内容 | |||
(なし) | |||
シート要素 | |||
タグ名 | シート | ||
説明 | シートを表します。そのシートで使用可能な組織のみが回答に含まれます。この要素は任意です。存在しない場合、API は特定のシートとは関係ない組織情報を返します。指定されたシートが組織割当シートの場合、このフィルタリングは、バージョンとユーザー アクセス フィルタリング (存在する場合) の最上位に適用されます。指定されたシートが、現在のユーザーがアクセスできるユーザー割当シートの場合、バージョンをフィルタリングした後に、そのシートのすべての組織が返されます。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
ID | あり | シートの内部システム ID 番号です。 | 234 |
エレメントの内容 | |||
(なし) | |||
回答フォーマット
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <levels seqNo="21"> <level id="1" name="Corporate Rollup" currency="USD" isImportable="1" workflowStatus="I"> <level id="2" name="Engineering" currency="USD" shortName="Engr" isImportable="1" workflowStatus="I"> <level id="7" name="Development" currency="USD" shortName="Dev" isImportable="1" workflowStatus="I"/> <level id="8" name="QA" currency="INR" isImportable="0" workflowStatus="L"/> <level id="9" name="Documentation" currency="PKR" shortName="Doc" isImportable="1" workflowStatus=R"/> </level> <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" isImportable="0" workflowStatus="A"> <attributes> <attribute name="Corporate Discount" value="Available" attributeId="20" valueId="188" /> <attribute name="Transfers Restricted" value="Yes" attributeId="21" valueId="194" /> </attributes> </level> </level> </levels> </output> </response>
回答エレメント | |||
タグ名 | response | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
成功 | あり | 真偽のいずれか。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。 | 真 |
廃止 | なし | レスポンス タグに存在し、true に設定されている場合、この属性は呼び出しているメソッドまたは API のバージョンが廃止されており、正式に廃止されたことを示します。現時点では機能し続けていますが、まもなく機能が停止する可能性があります。通常、この属性は存在しません。 | false |
エレメントの内容 | |||
単一の任意のメッセージ要素と、厳密に 1 つの必須の出力要素。 | |||
出力要素 | |
タグ名 | 出力 |
要素の特性 | |
(なし) | |
エレメントの内容 | |
単一の科目要素この出力ラベンダーはすべての API 応答の標準であり、成功した API 呼び出しの有効な出力を囲みます。 | |
組織要素 | |||
タグ名 | 組織 | ||
説明 | 組織要素のコンテナです。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
連番 API v17 で追加されましたが、将来の使用のために予約されています。 | |||
エレメントの内容 | |||
1 つ以上の組織要素アクセスできない組織がリクエストに含まれている場合、組織要素は 1 つしかなくなりません。これは組織の最上位組織を表します。 | |||
組織要素 | |||
タグ名 | level | ||
説明 | exportLevels API 呼び出しに対する応答で返される単一の組織を表します。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
ID | あり | 組織の内部システム ID 番号。 | 7 |
code
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | 組織のコード。 | 開発 |
名前 | あり | レポートおよびシートに表示される組織の名前です。 | 開発 |
displayName
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | displayNameType から派生した組織の表示名。 | 開発 |
通貨 | あり | 組織のこの組織に割り当てられる通貨の通貨コード。通貨は、exportActiveCurrencies コールで検出された、インスタンスに設定された通貨の 1 つになります。 | INR |
publishCurrency API v24+ で使用可能 | なし | この組織からパブリッシュに割り当てられた通貨の通貨コード。このプロパティは、インスタンスで "Power of One" が有効になっている場合にのみ適用されます。通貨は、exportActiveCurrencies コールで検出された、インスタンスに設定された通貨の 1 つになります。 | USD |
shortName | なし | "組織の管理" で入力された組織の略語 (存在する場合)。 | 偏差 |
availableStart | なし | 実績バージョンの組織の使用可否の開始期間を指定します。リクエストで実績バージョンが指定されている場合にのみ適用されます。値は、"01/2012" などの期間コードか、バージョンの開始を示す特殊値 "Start" のいずれかです。 | 01/2013 |
availableEnd | なし | 実績バージョンの組織の使用可否の終了期間です。リクエストで実績バージョンが指定されている場合にのみ適用されます。値は、"12/2013" などの期間コードか、バージョンの終了を示す特殊値 "END" のいずれかです。 | 12/2013 |
isImportable | なし | 関連する組織が指定したバージョンでインポート可能であるかどうかを示します。"0" はインポート不可を意味し、"1" はインポート可能を意味します。指定されたバージョンで少なくとも 1 つのタイム スロットがインポート可能である場合、組織をインポートできます。 isImportable 特性は、リクエストで versionName または versionID が指定されている場合にのみ送信されます。 注: isImportable は、組織が指定されたバージョンでインポート可能であることのみを示すものであり、API を呼び出しているユーザーがバージョンまたは組織にインポートする権限を持っていることを示すものではありません。exportVersions を使用して、ユーザーがインポートに使用できるバージョンを確認します。 | 1 |
workflowStatus | なし | 関連する組織のワークフローのステータスを送信します。"処理中" の I、"送信済" の S、"却下" の R、"承認済" の A、"ロック済" の L。この会社に対してワークフローが有効で、計画のバージョン名またはバージョン ID がリクエストで指定されている場合のみ、応答に含まれます。実績バージョンではワークフローを使用できません。 | I |
isLinked | あり | 組織がリンク組織の場合は 1。それ以外の場合は 0。 | 1 |
相殺消去 | あり | 組織が相殺消去組織の場合は 1。それ以外の場合は 0。 | 0 |
hasChildren | なし | 組織に子があるかどうかを示します。いいえの場合は "false"、はいの場合は "true"。この特性は、子がアクセス可能かどうかに関係なく、子を持つすべての組織に対して設定されます。組織に子が含まれていても、その子にアクセスできない場合でも、hasGreen 特性は true に設定されています。 | 真 |
説明
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | "組織の管理" で入力された組織の説明 (存在する場合)。 | |
エレメントの内容 | |||
この組織の直接の子組織ごとに 1 つのネストされた組織要素この組織が関連付けられている場合、1 つの特性要素 | |||
特性要素 | |||
タグ名 | 特性 | ||
説明 | 1 つ以上の特性要素のコンテナです。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
(なし) | |||
エレメントの内容 | |||
1 つ以上の特性要素 | |||
特性要素 | |||
タグ名 | 特性 | ||
説明 | 組織が関連付けられている、空白ではない単一の組織の特性マッピングを表します。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
名前 | あり | 組織の特性の名前 | 法人割引 |
値
有効な表示名設定がオンの場合、API v34 でサポートされます。 | あり | 組織に関連付けられた組織の特性の値。 | はい |
valueCode
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 "有効な表示名" 設定がオンの場合、API v34 ではサポートされません。 | なし | この特性の特性値コード。
API v32 および v33 では、valueCode が意味を持つのは次の場合のみです。
| あり |
valueName
表示名が有効になっているインスタンスの API v32 および API v33 でのみ使用できます。 "有効な表示名" 設定がオンの場合、API v34 ではサポートされません。 | なし | この特性の特性値名。
API v32 および API v33 では、valueName が意味を持つのは、以下の場合のみです。
| はい |
valueDisplayName
表示名を有効にするインスタンスの API v32 以上でのみ使用できます。 | あり | 特性値の表示名。
API v32 以降では、valueDisplayName が意味を持つのは、以下の場合に限られます。
| はい |
attributeID | あり | 組織特性の内部システム ID 番号。 | 20 |
valueID | あり | 組織の特性値の内部システム ID 番号。 | 188 |
エレメントの内容 | |||
(なし) | |||