updateAssociations

Adaptive Planning

updateAssociations

Categoria	Modificação de metadados
Descrição	Atualize a propriedade/associação de entidades (por exemplo, Nível). Várias associações com vários valores podem ser atualizadas em uma chamada. Se for bem-sucedida, a API retorna uma mensagem de êxito. Se a API falha, uma lista abrangente de erros e suas causas é retornada.
Permissões obrigatórias para invocar	Gerenciamento de modelos : Gerenciamento de modelos de modelo : Estrutura organizacional : Acesso administrativo a todos os níveis : Usuários
Parâmetros obrigatórios na solicitação	Credenciais

Consulte Conceito: associações e Importar associações.

Estas condições se aplicam a updateAssociations:

Cada associação tem um tipo, uma operação opcional e um conjunto de IDs de valores de dimensão (IDs de entidade).

Para criar uma nova associação, especifique a ID da entidade (por exemplo, ID do nível) à qual queremos atribuir a propriedade e a lista de identificadores de usuário (ID, WID ou nome de usuário).

Para uma associação, se a mesma ID de entidade é mencionada várias vezes, a última é usada.

Os usuários especificados na solicitação, mas não presentes no sistema, serão ignorados. Os usuários válidos restantes na solicitação serão processados e terão seus detalhes de associação atualizados.

Para associações de dimensão personalizada, os campos código, nome e dimId são obrigatórios.

A solicitação pode conter zero ou apenas uma associação para a propriedade de nível. Todas as outras associações de nível exigem os campos adicionais de código, nome e dimId.

Formato da solicitação


<?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>

elemento de credenciais
Nome da etiqueta		credenciais
Descrição		Todas as chamadas de API devem conter um único elemento de credenciais para identificar o usuário que invoca a API. A chamada à API é então executada como este usuário (qualquer trilha de auditoria ou histórico de ações no sistema mostrará que este usuário executou a ação) e, portanto, o usuário deve ter as permissões necessárias para executar a ação para que a chamada à API funcione. bem-sucedido.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
login	S	O nome de logon do usuário que invoca o método de API. Esse usuário deve ter as permissões necessárias para invocar o método.	sampleuser@company.com
senha	S	A senha do usuário que invoca o método de API.	my_password
parâmetros regionais	N	Especifique os parâmetros regionais a serem usados para interpretar números e datas de entrada e para formatar números e datas de saída (usando o separador de milhares, nomes de meses e formatação de data adequados). Os parâmetros regionais também são usados para especificar o idioma em que as mensagens do sistema na resposta devem ser exibidas. Se não especificado, en_US (inglês americano) é usado.	fr_FR
instanceCode	N	Se o usuário especificado nas credenciais tem acesso a mais de uma instância do Adaptive Planning, esse atributo pode ser usado para especificar que o usuário pretende acessar uma instância diferente da instância por padrão. Se não for especificada, a instância por padrão do usuário será usada. Para determinar os códigos de instância disponíveis, use a API exportInstances.	MYINSTANCE1
Conteúdo do elemento
(nenhum)

elemento de associações
Nome da etiqueta		associações
Descrição		Somente uma solicitação de elemento de associação é permitida por carga. Ele contém um ou mais elementos de associação.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo

Conteúdo do elemento
Contém um ou mais elementos de associação.

elemento de associação
Nome da etiqueta		associação
Descrição		Especifica a associação a ser criada/atualizada para a lista de entidades.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
type	y	O tipo da entidade para a qual a associação deve ser criada/atualizada. Ele pode usar apenas estes valores: level customdimension	level
operação	N	O modo de operação para esta associação. Ele pode usar apenas estes valores - (update ousubstituirAll) Se Operation="replaceAll", todas as entradas de propriedade existentes para esse tipo de associação serão excluídas e somente os detalhes de propriedade mencionados na solicitação serão salvos. Se Operation="update", somente as IDs de entidade (por exemplo, IDs de nível) mencionadas na solicitação serão atualizadas. Se a operação não é mencionada, o valor por padrão é o comportamento "atualizar".	atualizar
código	Condicionalmente	O código da associação que está sendo criada/atualizada. O único caso em que isso não é obrigatório é no caso da propriedade de nível. Obrigatório para todos os outros casos.	TL1
nome	Condicionalmente	O nome da associação que está sendo criada/atualizada. O único caso em que isso não é obrigatório é no caso da propriedade de nível. Obrigatório para todos os outros casos.	TestLevels1
dimId	Condicionalmente	A ID para cujos dimValueIds os detalhes de propriedade serão atualizados. Obrigatório no caso de dimensão personalizada.	12
Conteúdo do elemento
Contém um elemento dimValueIds.

dimValueIds element
Nome da etiqueta		dimValueIds
Descrição		Especifica a lista de dimValueId.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo

Conteúdo do elemento
Contém um ou mais elementos dimValueId.

dimValueId element
Nome da etiqueta		dimValueId
Descrição		Especifica
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
ID	S	O número da ID do sistema interno da entidade.	23
Conteúdo do elemento
Contém no máximo um elemento de usuário. Se o elemento de usuários não é mencionado, todas as propriedades existentes de dmiValueId são removidas.

elemento de usuários
Nome da etiqueta		usuários
Descrição		Especifica as IDs de usuário nos elementos id, WID ou username.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo

Conteúdo do elemento
Contém a lista de identificadores de usuário separados por vírgulas. Os usuários não presentes no sistema serão ignorados/pulados. Se nenhuma das IDs de usuário for mencionada, toda a propriedade existente da entidade (dimValueId) será removida. Se a mesma etiqueta identificadora é fornecida várias vezes na etiqueta de um usuário específico, a chamada retorna uma condição de erro. <id> 1, 2, 3 </id>: especifica que a propriedade deve ser atribuída a usuários com IDs 1, 2 e 3. <username>johno@greenco.com</username>: especifica que a propriedade deve ser atribuída ao usuário com o nome de usuário johno@greenco.com. <WID> ABC, CSD </WID>: especifica que a propriedade deve ser atribuída a usuários com as IDs Workday ABC e CSD.

Formato da resposta


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
 <messages>
     <message type="INFO">Associations were saved successfully.</message>
 </messages>
</response>

Elemento de resposta
Nome da etiqueta		resposta
Descrição		Especifica
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
êxito	S	"True" ou "false", indicando se a chamada à API foi bem-sucedida ou não.	verdadeiro
Conteúdo do elemento
Um único elemento de mensagens opcionais.

Elemento de mensagens
Nome da etiqueta		mensagens
Descrição		Contêiner para um ou mais elementos de mensagem
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo

Conteúdo do elemento
Contém um ou mais elementos de mensagem.

Elemento da mensagem
Nome da etiqueta		mensagem
Descrição		Representa uma mensagem que está sendo enviada pelo sistema de volta para o autor da chamada. As mensagens são usadas para mensagens de erro com solicitações não bem-sucedidas e para mensagens de confirmação em caso de êxito.
Atributos do elemento
Nome do atributo	Obrigatório?	Valor	Exemplo
type	N	Especifica o tipo da mensagem.	AVISO DE ERRO DE INFORMAÇÕES
Conteúdo do elemento

Descrições de mensagens de erro

Tipo	Mensagem	Exemplo/Descrição
Erro	erro: elemento "Y" incompleto; elemento obrigatório "Y" ausente	O elemento obrigatório está ausente na solicitação - por exemplo, associação, dimValueId
Erro	o valor do atributo "type" é inválido; deve ser igual a "nível"	A associação tem um tipo incorreto anexado a ela.
Erro	DimValueId pode ter no máximo um elemento de usuário.	O dimValueId pode ter no máximo um elemento de usuário.
Aviso	ID de usuário -5 não presente no sistema. WID -98A não presente no sistema. ID de nome de usuário stevec@comp não presente no sistema.	Os valores da ID de usuário estão incorretos. Eles foram ignorados e os usuários válidos restantes foram processados.
Erro	ID de DimValue -123 não presente no sistema.	A ID do valor de dimensão está incorreta.