メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
updateAssociations

updateAssociations

カテゴリ
メタデータの変更
説明
エンティティ (組織など) の所有権/関連付けを更新します。複数の値を持つ複数の関連付けを 1 回の呼び出しで更新できます。成功した場合、API は成功メッセージを返します。API が失敗すると、エラーとその原因の包括的なリストが返されます。
起動に必要な権限
モデル管理: モデル モデル管理: 組織構造: すべての組織の管理アクセス: ユーザー
リクエストに応じてパラメータが必要
認証情報
以下の条件が updateAssociations に適用されます。
  • 各関連付けには、タイプ、任意の操作、および属性値 ID (エンティティ ID) のセットがあります。
  • 新しい関連付けを作成するには、所有権を付与するエンティティ ID (組織 ID など) とユーザー識別子 (ID、WID、ユーザー名) のリストを指定します。
  • 関連付けでは、同じエンティティ ID が複数回指定された場合、最後のものが使用されます。
  • リクエストで指定されたがシステムに存在しないユーザーは無視されます。リクエスト内の残りの有効なユーザーが処理され、関連付けの詳細が更新されます。
  • カスタム属性関連付けの場合、コード、名前、dimId は必須フィールドです。
  • リクエストには、組織所有権の関連付けをゼロか、1 つのみ含めることができます。他の組織の関連付けには、code、name、dimId の追加フィールドが必要です。

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


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateAssociations" callerName="me">
<credentials login="sampleuser@greenco.com" password="my_pwd"/>
<associations>
  <association type="level" operation = "update">
   <dimValueIds>
     <dimValueId id = "2">
         <users>
             <id> 1, 2, 3 , 87654</id>
         </users>        
     </dimValueId>
     <dimValueId id = "24">
         <users>
             <WID>23,12</WID>
             <username>stevec@grEENco.com</username>
         </users>
     </dimValueId>
     <dimValueId id = "6">
         <users>
             <id> 1, 2, 3 </id>
             <username>johno@greenco.com, johnstevec@greenco.com</username>
             <WID> ABC, CSD </WID>
         </users>
     </dimValueId>
     <dimValueId id = "12">          
     </dimValueId>      
   </dimValueIds>
 </association>
 <association type="customdimension" code= "CD1" name="CustomDim1" operation="replaceAll" dimId="8">
   <dimValueIds>
     <dimValueId id = "86">
         <users>
             <id> 14, 45</id>
         </users>        
     </dimValueId>
     <dimValueId id = "92">
         <users>
             <id>20, 21</id>
             <WID>ABCD</WID>
             <username>stevec@grEENco.com</username>
         </users>
     </dimValueId>
   </dimValueIds>
 </association>
 <association type="customdimension" code= "CD2" name="CustomDim2" operation="update" dimId="4">
   <dimValueIds>
     <dimValueId id = "16">
         <users>
             <id> 20, 21</id>
         </users>        
     </dimValueId>
   </dimValueIds>
 </association>
 <association type="level" code= "TL2" name="TestLevels2" operation="update" dimId="-1">
   <dimValueIds>
     <dimValueId id = "1">
         <users>
             <id> 15</id>
         </users>        
     </dimValueId>
   </dimValueIds>
 </association>
</associations>
</call>
認証情報要素
タグ名
認証情報
説明
すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功:
要素の特性
特性名
必須？
値
例
ログイン
あり
API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。
sampleuser@company.com
password
あり
API メソッドを呼び出すユーザーのパスワード。
my_password
ロケール
なし
入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。
fr_FR
instanceCode
なし
認証情報で指定されたユーザーが Adaptive Planning の複数のインスタンスにアクセスできる場合、この属性を使用して、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。
MYINSTANCE1
エレメントの内容
(なし)
関連付け要素
タグ名
関連付け
説明
ペイロードごとに許可される関連付けエレメント リクエストは 1 つのみです。1 つまたは複数の関連付け要素が含まれています。
要素の特性
特性名
必須？
値
例
エレメントの内容
1 つ以上の関連付け要素が含まれます。
関連付け要素
タグ名
関連付け
説明
エンティティのリストに対して作成/更新される関連付けを指定します。
要素の特性
特性名
必須？
値
例
type
y
関連付けを作成/更新するエンティティのタイプ。次の値のみを取得できます。
  • level
  • customdimension
level
操作
なし
この関連付けの操作モード。次の値のみを取ることができます (update orreplaceAll)
  • Operation="replaceAll" の場合、その関連付けタイプの既存の所有権エントリがすべて削除され、リクエストに記載された所有権の詳細のみが保存されます。
  • Operation="update" の場合、リクエストに記載されたエンティティ ID (組織 ID など) のみが更新されます。
  • 操作が説明されていない場合、デフォルトで「更新」動作になります。
更新
code
条件付き
作成/更新される関連付けのコード。これが必須でない唯一のケースは組織所有権の場合です。その他のすべてのケースでは必須です。
TL1
名前
条件付き
作成/更新中の関連付けの名前これが必須でない唯一のケースは組織所有権の場合です。その他のすべてのケースでは必須です。
TestLevels1
dimId
条件付き
dimValueIds の所有権の詳細が更新される ID です。カスタム属性の場合は必須です。
12
エレメントの内容
1 つの dimValueIds 要素を含みます。
dimValueIds element
タグ名
dimValueIds
説明
dimValueId のリストを指定します。
要素の特性
特性名
必須？
値
例
エレメントの内容
1 つ以上の dimValueId 要素が含まれます。
dimValueId element
タグ名
dimValueId
説明
指定
要素の特性
特性名
必須？
値
例
ID
あり
エンティティの内部システム ID 番号。
23
エレメントの内容
最大で 1 つのユーザー要素が含まれます。ユーザー要素が指定されていない場合、dmiValueId の既存の所有権はすべて削除されます。
ユーザー要素
タグ名
ユーザー
説明
"id"、"WID"、または "username" の要素でユーザー ID を指定します。
要素の特性
特性名
必須？
値
例
エレメントの内容
カンマ区切りのユーザー ID のリストが含まれます。システムに存在しないユーザーは無視されるかスキップされます。ユーザー ID がいずれも指定されていない場合、エンティティの既存の所有権 (dimValueId) はすべて削除されます。特定のユーザー タグに同じ識別子タグが複数回指定された場合、呼び出しはエラー条件を返します。
<id> 1, 2, 3 /id>: ID が 1、2、3 のユーザーに所有権を付与することを指定します。
<username>johno@greenco.com/username>: ユーザー名が johno@greenco.com のユーザーに所有権が付与されることを指定します。
<WID> ABC、CSD <WID>: Workday ID が ABC および CSD を持つユーザーに所有権が付与されることを指定します。

回答フォーマット


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
 <messages>
     <message type="INFO">Associations were saved successfully.</message>
 </messages>
</response>
回答要素
タグ名
response
説明
指定
要素の特性
特性名
必須？
値
例
成功
あり
"true" または "false"。API 呼び出しが成功したかどうかを示します。
真
エレメントの内容
単一のオプション メッセージ要素
メッセージ要素
タグ名
メッセージ
説明
1 つ以上のメッセージ要素のコンテナ
要素の特性
特性名
必須？
値
例
エレメントの内容
1 つ以上のメッセージ要素が含まれます。
メッセージ要素
タグ名
message
説明
システムから呼び出し元に送り返されるメッセージを表します。メッセージは、リクエストが成功しないというエラー メッセージや、成功した場合の確認メッセージに使用されます。
要素の特性
特性名
必須？
値
例
type
なし
メッセージのタイプを指定します。
情報エラー警告
エレメントの内容

エラー メッセージの説明

タイプ
メッセージ
例/説明
エラー
エラー: 要素 "Y" が未完了です。必須エレメント "Y" がありません
リクエストに必須エレメントがありません - 関連付けなどの dimValueId
エラー
特性 "type" の値が無効です。 "組織" と等しくなければなりません
関連付けに正しくないタイプが関連付けられています。
エラー
DimValueId にはユーザー要素を 1 つだけ含めることができます。
dimValueId にはユーザー要素を 1 つだけ含めることができます。
警告
ユーザー ID -5 はシステムに存在していません。システムに WID -98A は存在していません。ユーザー名 ID stevec@comp がシステムに存在していません。
ユーザー ID 値が正しくありません。これらのユーザーはスキップされ、残りの有効なユーザーが処理されました。
エラー
DimValue ID -123 はシステムに存在していません。
dim 値 ID が正しくありません。