跳至主要内容
文档
文档
Adaptive Planning
上次更新时间 ：2023-06-23
updateAssociations

updateAssociations

种类
元数据修改
描述
更新实体的所有权/关联关系（例如层级）。可以在一个调用中更新具有多个值的多个关联。如果成功，API 将返回成功消息。如果 API 失败，系统会返回错误及其原因的完整列表。
调用所需的权限
模型管理：模型 模型管理：组织结构：所有层级 管理员访问权限：用户
请求时需要的参数
凭据
请参见 概念：关联 和 导入关联。
以下条件适用于 updateAssociations：
  • 每个关联都有一个类型、一个可选运算和一组暗淡值编号（实体编号）。
  • 要创建新关联，请指定我们要授予所有权的实体编号（例如层级编号），以及用户识别号（编号、WID 或用户名）列表。
  • 对于关联，如果多次提及同一实体编号，则使用最后一个编号。
  • 将忽略在请求中指定但系统中不存在的用户。系统将处理申请中剩余的有效用户，并更新其关联详细信息。
  • 对于自定义维度关联，代码、名称和 dimId 为必填字段。
  • 请求可以包含零个或一个层级所有权关联。任何其他层级关联都需要额外的字段，即代码、名称和 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
密码
是
调用 API 方法的用户的密码。
my_password
区域设置
否
指定用于解释传入数字和日期的区域设置，以及用于设置传出数字和日期格式的区域设置（使用正确的千位分隔符、月份名称和日期格式）。区域设置还用于指定回复中的任何系统消息应使用的语言。如果未指定，则使用 en_US（美式英语）。
fr_FR
instanceCode
否
如果凭据中指定的用户有权访问多个 Adaptive Planning 实例，则此属性可用于指明该用户打算访问默认实例以外的实例。如果未指定，则将使用用户的默认实例。要确定可用的实例代码，请使用 exportInstances API。
MYINSTANCE1
元素的内容
（无）
关联元素
标记名称
关联
描述
每个负载仅允许 1 个关联元素请求。它包含一个或多个关联元素。
元素的属性
属性名称
必填？
值
示例
元素的内容
包含一个或多个关联元素。
关联元素
标记名称
关联
描述
指定要为实体列表创建/更新的关联。
元素的属性
属性名称
必填？
值
示例
type
y
要创建/更新关联的实体的类型。它只能采用以下值：
  • level
  • customdimension
level
操作
否
此关联的操作模式。只能采用以下值 -（update 或 replaceAll）
  • 如果 Operation="replaceAll"，则系统将删除该关联类型的所有现有所有权条目，并且仅保存请求中提及的所有权详细信息。
  • 如果 Operation="update"，则仅更新请求中提及的实体编号（例如层级编号）。
  • 如果未提及操作，则默认为“更新”行为。
更新
代码
有条件地
要创建/更新的关联的代码。唯一不需要的情况是层级所有权。对于所有其他工单均为必填。
TL1
名称
有条件地
要创建/更新的关联的名称。唯一不需要的情况是层级所有权。对于所有其他工单均为必填。
TestLevels1
dimId
有条件地
将为其更新所有权详细信息的 dimValueIds 编号。如果是自定义维度，则为必填字段。
12
元素的内容
包含一个 dimValueIds 元素。
dimValueIds element
标记名称
dimValueIds
描述
指定 dimValueId 列表。
元素的属性
属性名称
必填？
值
示例
元素的内容
包含一个或多个 dimValueId 元素。
dimValueId element
标记名称
dimValueId
描述
指定
元素的属性
属性名称
必填？
值
示例
编号
是
实体的内部系统编号。
23
元素的内容
至多包含一个用户元素。如果未提及 users 元素，则系统将移除 dmiValueId 的所有现有所有权。
users 元素
标记名称
用户
描述
指定 id、WID 或 username 元素中的用户识别号。
元素的属性
属性名称
必填？
值
示例
元素的内容
包含以逗号分隔的用户识别号列表。系统将忽略/跳过不存在的用户。如果未提及任何用户识别号，则实体 (dimValueId) 的所有现有所有权都将被移除。如果在特定用户标记中多次提供相同的标识符标记，则此调用将返回错误条件。
<id> 1, 2, 3 </id>：这指定要将所有权授予编号为 1、2 和 3 的用户。
<username>johno@greenco.com</username>：此字段用于指定将所有权授予用户名为“johno@greenco.com”的用户。
<WID> ABC, CSD </WID>：指定为 Workday 编号为 ABC 和 CSD 的用户授予所有权。

回复格式


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
 <messages>
     <message type="INFO">Associations were saved successfully.</message>
 </messages>
</response>
回复元素
标记名称
回复
描述
指定
元素的属性
属性名称
必填？
值
示例
成功
是
“true”或“false”，指明 API 调用是否成功。
True
元素的内容
单个可选的 messages 元素。
消息元素
标记名称
消息
描述
一个或多个消息元素的容器
元素的属性
属性名称
必填？
值
示例
元素的内容
包含一个或多个消息元素。
消息元素
标记名称
消息
描述
表示从系统发回给调用方的消息。消息用于发送请求未成功时的错误消息，以及请求成功时的确认消息。
元素的属性
属性名称
必填？
值
示例
type
否
指定消息的类型。
信息错误警告
元素的内容

错误消息描述

类型
消息
示例/描述
错误
错误：元素“Y”不完整；缺少必需元素“Y”
请求缺少必需的元素 - 例如关联、dimValueId
错误
属性“type”的值无效；必须等于“level”
关联的附加类型不正确。
错误
DimValueId 最多可以具有一个用户元素。
dimValueId 至多可以有一个 users 元素。
警告
用户编号 -5 在系统中不存在。Workday 编号 -98A 在系统中不存在。用户编号 stevec@comp 在系统中不存在。
用户识别号值不正确。这些有效用户已被跳过，并已处理剩余的有效用户。
错误
-123 DimValue 编号在系统中不存在。
dim 值编号不正确。