メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
メタデータの一括更新

メタデータの一括更新

API v17 以上でサポート
メタデータ一括更新 API の主な利点は、 内で組織、属性、総勘定元帳科目を同期できることです。
Adaptive Planning
 外部システムの担当者と定期的にスケジュールに従ってこれらの API を使用すると、個々の要素を 1 つずつ呼び出す代わりに、生の XML ファイルまたは圧縮 (ZIP 形式) XML を送信して、要素の更新、並べ替え、作成を行うことができます。
メタデータ バルク API を使用すると、新しいバージョンの既存の要素のツリーが にインポートされます。
Adaptive Planning
。
メタデータ一括更新 API:
  • 削除しないアップロードされたバージョンに含まれていない要素はそのまま残ります。
  • アップロードで見つかった新しい要素を作成します (できる場合)。
  • アップロードされる要素のプロパティ (親プロパティを含む) を更新します。
  • アップロード中の属性割当を更新してください。
  • 特に限定的に、部分的なツリーのアップロードを許可します (削除は実行されないため、部分的なアップロードは非破棄的です)。
  • 内部 ID 番号または「元の」 (更新前) の一意の識別子フィールドのいずれかによって、ツリー内の既存の要素を識別できます。
  • 重大なエラーで停止し、ロールバックします。重大なエラーには以下が含まれます。
    • 階層内でサイクルを作成しようとしています
    • 識別フィールドがシステムに既に存在する要素と競合する新しい要素を作成しようとする (使用中のコードで新しい科目を作成するなど)
    • 要素の識別フィールドを更新することを試み、すでにシステムにある識別フィールドと競合します。
  • インポートを停止しない無視できるエラー レベルに進み、結果応答に警告として報告します。無視できるエラーには、連鎖的な影響を与える可能性の低い、以下のようなものがあります。
    • 特性の割当を存在しない値に変更しようとします。
    • フィールドに対して長すぎる組織名を設定しようとしています。

圧縮 XML (ZIP 形式) を使用した一括アップロード

ペイロードが大きい場合は、サブディレクトリ、フォルダ、その他のコンテンツを含めずに、更新の xml のみを含む圧縮コンテンツを ZIP ファイルとしてアップロードできます。Post 時の ZIP ファイルでフォルダまたはサブディレクトリが検出された場合、リクエストは却下されます。

圧縮 XML (ZIP 形式) ファイル 丸の添付ファイルの例


curl -i -X POST -H "Content-Type: multipart/form-data" -F "request=<C:/temp/requestUpdateDimVal.xml" -F "content=@C:/temp/updateDimensions.zip" https://api.adaptiveplanning.com/api/v20
requestUpdateDimVal.xml content

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
    <credentials login="sampleuser@company.com" password="my_password"/>
</call>
updateDimVal.zip/content.xml

<?xml version='1.0' encoding='UTF-8'?>
 <dimensions>
     <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
       <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" />
     </dimension>
 </dimensions>
添付ファイルを使用せずに、API 呼び出しの本文で API リクエストを行うことはできます。

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
    <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
     <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
       <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" />
     </dimension>
</dimensions>
</call>