updateAssociations

Adaptive Planning

updateAssociations

Categoría	Modificación de metadatos
Descripción	Actualice la propiedad/asociación de las entidades (por ejemplo, Nivel). Se pueden actualizar varias asociaciones con varios valores en una llamada. Si se realiza correctamente, la API devuelve un mensaje de éxito. Si la API falla, se devuelve una lista completa de errores y sus causas.
Permisos obligatorios para invocar	Gestión de modelos : Modelo Gestión de modelos : Estructura de organización : Todos los niveles Acceso de administrador : Usuarios
Parámetros obligatorios bajo petición	Credenciales

Consulte Concepto: asociaciones y Importar asociaciones.

Estas condiciones se aplican a updateAssociations:

Cada asociación tiene un tipo, una operación opcional y un conjunto de IDs de valor de dimensión (IDs de entidad).

Para crear una nueva asociación, especifique el ID de entidad (por ejemplo, ID de nivel) a la que desea otorgar propiedad y la lista de identificadores de usuario (ID, WID o nombre de usuario).

Para una asociación, si el mismo ID de entidad se menciona varias veces, se utiliza el último.

Se ignorarán los usuarios especificados en la solicitud pero que no estén presentes en el sistema. Los usuarios válidos restantes de la solicitud se procesarán y se actualizarán sus detalles de asociación.

Para las asociaciones de dimensiones personalizadas, el código, el nombre y el dimId son campos obligatorios.

La solicitud puede contener cero o solo una asociación para la propiedad de nivel. Cualquier otra asociación de nivel requiere los campos adicionales de código, nombre y dimId.

Formato de solicitud


<?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 credenciales
Nombre de etiqueta		credenciales
Descripción		Todas las llamadas a la API deben contener un único elemento de credenciales para identificar al usuario que invoca la API. A continuación, la llamada a la API se realiza como este usuario (cualquier pista de auditoría o historial de acciones en el sistema mostrará que este usuario ha realizado la acción) y, por lo tanto, el usuario debe tener los permisos necesarios para realizar la acción a fin de que la llamada a la API se lleve a cabo. correcta
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
inicio de sesión	Sí	El nombre de conexión del usuario que invoca el método API. Este usuario debe tener los permisos necesarios para invocar el método.	sampleuser@company.com
contraseña	Sí	La contraseña del usuario que invoca el método API.	my_password
configuración regional	No	Especifique la configuración regional que se utilizará para interpretar los números y las fechas de entrada, y para dar formato a los números y las fechas de salida (utilizando el separador de miles, los nombres de mes y el formato de fecha adecuados). La configuración regional también se utiliza para especificar el idioma en el que deben aparecer los mensajes del sistema en la respuesta. Si no se especifica, se utiliza en_US (inglés americano).	fr_FR
instanceCode	No	Si el usuario especificado en las credenciales tiene acceso a más de una instancia de Adaptive Planning, este atributo se puede utilizar para especificar que el usuario tiene intención de acceder a una instancia distinta a la instancia por defecto. Si no se especifica, se utilizará la instancia por defecto del usuario. Para determinar los códigos de instancia disponibles, utilice la API exportInstances.	MYINSTANCE1
Contenido del elemento
(ninguno)

elemento de asociaciones
Nombre de etiqueta		asociaciones
Descripción		Solo se permite una solicitud de elemento de asociaciones por carga útil. Contiene uno o varios elementos de asociación.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo

Contenido del elemento
Contiene uno o varios elementos de asociación.

elemento de asociación
Nombre de etiqueta		asociación
Descripción		Especifica la asociación que se creará/actualizará para la lista de entidades.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
tipo	y	El tipo de entidad para la que se va a crear/actualizar la asociación. Solo puede tomar los siguientes valores: nivel customdimension	nivel
operación	No	El modo de operación de esta asociación. Solo puede tomar estos valores (update o replaceAll) Si Operation="replaceAll", se eliminarán todas las entradas de propiedad existentes para ese tipo de asociación y solo se guardarán los detalles de propiedad mencionados en la solicitud. Si Operation="update", solo se actualizarán los ID de entidad (por ejemplo, los ID de nivel) mencionados en la solicitud. Si no se menciona la operación, se establecerá por defecto el comportamiento de "actualización".	actualizar
código	Condicionalmente	El código de la asociación que se va a crear/actualizar. El único caso en el que no es obligatorio es en el caso de la propiedad de nivel. Obligatorio para todos los demás casos.	TL1
nombre	Condicionalmente	El nombre de la asociación que se va a crear/actualizar. El único caso en el que no es obligatorio es en el caso de la propiedad de nivel. Obligatorio para todos los demás casos.	TestLevels1
dimId	Condicionalmente	El ID para cuyos dimValueIds se actualizarán los detalles de propiedad. Obligatorio en caso de dimensión personalizada.	12
Contenido del elemento
Contiene un elemento dimValueIds.

dimValueIds element
Nombre de etiqueta		dimValueIds
Descripción		Especifica la lista de dimValueId.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo

Contenido del elemento
Contiene uno o varios elementos dimValueId.

dimValueId element
Nombre de etiqueta		dimValueId
Descripción		Especifica
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno de la entidad.	23
Contenido del elemento
Contiene como máximo un elemento de usuarios. Si no se menciona el elemento users, se eliminará toda la propiedad existente de dmiValueId.

elemento de usuarios
Nombre de etiqueta		usuarios
Descripción		Especifica los identificadores de usuario en los elementos id, WID o nombre de usuario.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo

Contenido del elemento
Contiene la lista de identificadores de usuario separados por comas. Los usuarios que no estén presentes en el sistema serán ignorados/omitidos. Si no se menciona ninguno de los identificadores de usuario, se eliminará toda la propiedad existente de la entidad (dimValueId). Si se proporciona la misma etiqueta de identificador varias veces en una etiqueta de usuario en particular, la llamada devolverá una condición de error. <id> 1, 2, 3 </id> : especifica que la propiedad se otorgará a los usuarios con los ID 1, 2 y 3. <username>johno@greenco.com</username>: especifica que la propiedad se debe otorgar al usuario con el nombre de usuario johno@greenco.com. <WID> ABC, CSD </WID> : especifica que la propiedad se otorgará a los usuarios con ID de Workday ABC y CSD.

Formato de respuesta


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

Elemento de respuesta
Nombre de etiqueta		respuesta
Descripción		Especifica
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito	Sí	"Verdadero" o "falso", que indica si la llamada a la API se ha realizado correctamente o no.	verdadero
Contenido del elemento
Un único elemento de mensajes opcional.

Elemento de mensajes
Nombre de etiqueta		mensajes
Descripción		Contenedor para uno o varios elementos de mensaje
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo

Contenido del elemento
Contiene uno o varios elementos de mensaje.

Elemento de mensaje
Nombre de etiqueta		mensaje
Descripción		Representa un mensaje que se envía desde el sistema a la persona que llama. Los mensajes se utilizan para mensajes de error con solicitudes no satisfactorias y para mensajes de confirmación en caso de éxito.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
tipo	No	Especifica el tipo del mensaje.	AVISO DE ERROR DE INFORMACIÓN
Contenido del elemento

Descripciones de mensajes de error

Tipo	Mensaje	Ejemplo/Descripción
Error	error: elemento "Y" incompleto; falta el elemento obligatorio "Y"	Falta el elemento obligatorio en la solicitud, por ejemplo, asociación, dimValueId.
Error	el valor del atributo "tipo" no es válido; debe ser igual a "nivel"	La asociación tiene asociado un tipo incorrecto.
Error	El ID de DimValue puede tener como máximo un elemento de usuario.	El dimValueId puede tener como máximo un elemento de usuarios.
Aviso	El ID de usuario -5 no está presente en el sistema. WID -98A no presente en el sistema. El ID de nombre de usuario stevec@comp no está presente en el sistema.	Los valores del identificador de usuario son incorrectos. Se han omitido y se han procesado los usuarios válidos restantes.
Error	El ID de DimValue -123 no está presente en el sistema.	El ID de valor de dimensión es incorrecto.