内部 ID 参照

API リクエストに内部 ID を含めることで、作成、更新、読み取り方法のメタデータを取得できます。これらのメソッドのリクエストを行う場合は、関連する Export API コールを使ってリクエストに必要な ID を取得します。以下のテーブルのすべての API に対するリクエストには、認証情報要素が必要です。

例

updateDimensionsAPI リクエストで属性を更新するには、属性 ID を渡す必要があります。属性 ID "7" を渡すと、"学歴
" 属性を更新できます。


<dimensions>
      <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
      --------------------------
      </dimension>
</dimensions>

"学歴" の属性 ID "7" は、exportDimensionsAPI 応答から取得されます。


<response success="true">
 <output>
   <dimensions>
     <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35">
      --------------------------------------------
    </dimension>
  </output>
 </response>

API および応答 ID のエクスポート

API	Adaptive Planning 回答に含まれる内部 ID	取得済メタデータ
exportAccounts	"科目 ID" と "科目特性 ID" 科目 ID は、exportDimensionFamilies などの他の API 呼び出しで科目を識別するために使用できます。シート要素は任意です。シート要素を含める場合は、リクエストにシートの内部システム ID を渡す必要があります。exportSheets を参照してください。	すべての科目タイプ (前提条件、キューブ科目、カスタム科目、総勘定元帳科目、メトリック科目、モデル科目) を含むすべての科目のリストです。
exportActiveCurrencies	通貨 ID これは通貨を一意に識別するために使用でき、customReportValuesAPI で使用できます。	システムで設定されているすべての通貨のリスト
exportAttributes	"特性 ID" と "attributeValue" の要素 ID	システム内のすべての特性のリスト。
exportDimensions	属性 ID とその dimensionValue 要素 ID これは、exportDimensionFamilies などの、他の API コールで属性を識別するために使用できます。	システム内のすべての属性のリスト。
exportGroups	ユーザーグループ ID と、このユーザーグループを所有するユーザー ID (isGlobal="false" の場合にのみ設定)。	指定されたインスタンスに対して定義されたすべてのグループのリストです。これには、インスタンス全体でグローバルに定義されたグループと、ユーザーによって定義されたグループが含まれます。
exportLevels	組織 ID	システムにおけるすべての組織のリスト。
exportPermissionSets API v25+ で使用できます。	権限セット ID これは、exportUsers API コールでユーザーに割り当てられた権限セットを識別するために使用されます。	インスタンス内のすべての権限セットのリストです。
exportRoles API v25 以前で使用できます。 API v25+ では使用できません。	ロール ID これは、exportUsers API コールでユーザーに割り当てられたロールを識別するために使用されます。	インスタンス内のすべてのロールのリスト。
exportSheets	シート ID (標準、キューブ、モデルシートの要素) これは、exportSheetDefinition などの他の API 呼び出しでシートを識別するために使用できます。	指定されたインスタンスに定義された全シートのリストです。これには、"未完了" シートだけでなく、ユーザー割当シートも含まれます。
exportTime	初期の残高期間 ID	特定のバージョンまたは指定されていない場合はすべてのバージョンの時間メタデータ。
exportTransactionDefinition	属性、テキストセレクター、値の要素の ID。	インスタンス内のトランザクションの定義 (使用可能な列)。
exportUsers	このユーザーに割り当てられたユーザー ID とロール ID	インスタンス内の全ユーザーのリストです。
exportVersions	バージョンまたはフォルダ ID すべての ID は、すべてのバージョン、サブバージョン、およびフォルダ間で一意になります。	検証後にリクエスト元ユーザーに対して非表示にされることのない、インスタンス内で定義されたすべてのバージョンのセットを示す XML ドキュメント。