exportAttributes

Adaptive Planning

Documentación de Workday Adaptive Planning (Workday 2025R2)
Integración
Gestión de integración de datos
Documentación de API
Métodos de creación, actualización y lectura de metadatos y datos

Última actualización: 2023-06-23

exportAttributes

Esta API solo admite usuarios Concepto: reglas de acceso en API v22 y superior.

Categoría	Metadata retrieval
Descripción	Devuelve los metadatos de la lista completa de todos los atributos del sistema.
Permisos obligatorios para invocar	Ninguna (deben ser credenciales válidas para la instancia)
Parámetros obligatorios bajo petición	Credenciales

La solicitud de este método solo contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama. Una vez verificado, el método devuelve un documento XML que describe el conjunto completo de todos los atributos personalizados (excepto el atributo de sistema de socio comercial para las instancias de consolidación), incluidos todos sus valores de miembro. Los valores de miembro dentro de un atributo se devuelven en forma de árbol, y los miembros principales contienen a sus elementos secundarios.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportAttributes" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"/>
</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 API llamada 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 la 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)

incluir elemento Compatible con API v17 +
Nombre de etiqueta		incluir
Descripción		Representa un conjunto de indicadores que indican qué aspectos de la información de "valores de atributo" deben incluirse o excluirse de la respuesta. Este elemento es opcional: si no está presente, todos los atributos aparecerán en la respuesta.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
IDs de atributo Compatible con API v17 +	No	Una lista de IDs que aparecerán en la respuesta de API. Esto actúa como un filtro.	"1,2,3,14"
inaccessibleValues Compatible con API v18 +	No	Indica si la respuesta debe incluir valores inaccesibles para el usuario actual. El valor por defecto es falso. Solo los usuarios con los permisos "Modelado" o "Importar a todos los niveles" pueden definir esta opción como verdadera.	falso
sin categorizar Se admite en API v22+ cuando la instancia utiliza reglas de acceso por seguridad.	No	Indica si la respuesta debe incluir los nodos ficticios en la respuesta de cada atributo. El valor por defecto es falso. Los nodos ficticios solo se incluyen en la respuesta cuando el usuario tiene acceso a ellos.	falso
displayNameEnabled Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	displayNameEnabled=true indica que exportAttributes debe respetar las propiedades de nombre de visualización cuando la opción Activar nombre de visualización está activada para la instancia. displayNameEnabled=false indica que la API exportAttributes debe seguir el contrato de la API anterior a la v30 aunque la opción Activar nombre de visualización esté activada para la instancia. La API exportAttributes ignora las propiedades de nombre de visualización. El valor por defecto de displayNameEnabled es "false".	verdadero
Contenido del elemento
(ninguno)

Formato de respuesta


<?xml version='1.0' encoding='UTF-8'?>
  <response success="true">
   <output>
     <attributes>
       <attribute id="13" name="AP Eligible" type="account" seqNo="21">
         <attributeValue id="118" name="No" />
         <attributeValue id="117" name="Yes">
           <attributeValue id="136" name="Full" />
           <attributeValue id="135" name="Partial" />
         </attributeValue>
       </attribute>
       <attribute id="11" name="Product Line" type="account" seqNo="3">
         <attributeValue id="34" name="A" />
         <attributeValue id="35" name="B" />
       </attribute>
       <attribute id="9" name="Corporate Discount" type="level" seqNo="11">
         <attributeValue id="56" name="Available" />
         <attributeValue id="54" name="Not Applicable" />
         <attributeValue id="57" name="Not Available" />
         <attributeValue id="55" name="TBD" />
       </attribute>
       <attribute id="10" name="Tax Code" type="level" seqNo="33">
         <attributeValue id="146" name="TT-PYT" />
         <attributeValue id="145" name="TT-TRE" />
       </attribute>
       <attribute id="16" name="Industry" type="dimension" dimension-id="15" seqNo="43">
         <attributeValue id="335" name="Apparel">
            <attributeValue id="354" name="Mens Apparel" />
            <attributeValue id="355" name="Shoes" />
            <attributeValue id="356" name="Womens Apparel" />
         </attributeValue>
       </attribute>
     </attributes>
   </output>
</response>

elemento de respuesta
Nombre de etiqueta		respuesta
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. Incluso las llamadas correctas pueden contener mensajes de aviso en su respuesta.	verdadero
obsoleto	No	Si está presente en la etiqueta de respuesta y se establece en verdadero, este atributo indica que la versión del método o API que se está invocando ha quedado obsoleta y está oficialmente desaprobada. Aunque sigue funcionando en este momento, es posible que deje de funcionar en un breve periodo de tiempo. Normalmente, este atributo no está presente.	falso
Contenido del elemento
Un único elemento de mensajes opcional y exactamente un elemento de resultado obligatorio.

elemento de resultado
Nombre de etiqueta		salida
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Un solo elemento de atributos obligatorios. Este contenedor de salida es estándar en todas las respuestas de API e incluye la salida válida de cualquier llamada API correcta.

elemento de atributos
Nombre de etiqueta		atributos
Descripción		Contenedor para cero o más elementos de atributo. Los atributos se ordenarán de forma que tengan el siguiente orden según el tipo: "cuenta", "nivel" y "dimensión". Los atributos con el mismo tipo se ordenarán por nombre.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Cero o más elementos de atributo.

elemento de atributo
Nombre de etiqueta		atributo
Descripción		Representa un solo atributo que se devuelve en la respuesta a una llamada a la API exportAttributes.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno para el atributo.	16
nombre	Sí	El nombre del atributo tal y como aparece en la página de administración de atributos.	Sector
displayNameType Solo está disponible en API v30+ para instancias que activan el nombre de visualización.		La representación interna del formato de nombre de visualización seleccionado para los valores en las páginas Administración de atributos. NOMBRE CODE NAME_CODE CODE_NAME	NOMBRE
tipo	Sí	El tipo del atributo. Será "account" si el atributo es para una cuenta, "level" si el atributo es para un nivel o "dimension" si el atributo es para una dimensión.	dimensión
creación automática Compatible con API v20+	Sí	1 si el atributo seleccionado tiene definido el campo "La importación de nivel/cuenta/dimensión crea automáticamente valores de atributo"; de lo contrario, 0.	0
keepSorted Compatible con API v20+	Sí	"1" indica que los valores de este atributo siempre se ordenan alfabéticamente. "0" (o no especificado) significa que los valores de atributo se ordenan en función de su posición en la carga útil de la solicitud. Si el XML contiene tanto el elemento principal como al menos un elemento del mismo nivel de un valor de atributo jerárquico no listado, el valor no listado se mueve al final de los elementos del mismo nivel enumerados durante la actualización (al reordenar los elementos secundarios del elemento principal, todos los elementos del mismo nivel enumerados van primero, en el orden en que se especifican en el XML. Todos los elementos del mismo nivel que no figuran en la lista aparecen en último lugar, en el orden en el que ya están en el sistema). keepSorted se aplica a los elementos secundarios de cada valor de atributo principal.	1
dimension-id	No	El ID de la dimensión si el atributo es del tipo "dimensión".	15
seqNo Añadido en API v17, pero reservado para uso futuro.
Contenido del elemento
Cero o más elementosAttributeValue opcionales. Cada elemento de valor de atributo adjunto representa un "valor de atributo raíz" en el atributo, un valor que no tiene ningún valor principal.

elementoAttributeValue
Nombre de etiqueta		attributeValue
Descripción		Representa un valor de miembro único de un atributo que se devuelve en la respuesta a una llamada a la API exportAttributes.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno para este valor de miembro del atributo.	34
código Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	El código del valor de miembro del atributo.	Disponibles
nombre	Sí	La etiqueta del valor de miembro del atributo que se muestra en la página de administración de atributos.	Disponibles
displayName Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	El displayName del valor de miembro del atributo derivado del displayNameType del atributo.	Disponibles
descripción Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	La descripción del valor de miembro del atributo tal como se muestra en la página de administración de atributos.
Contenido del elemento
Cero o más elementosAttributeValue opcionales. Cada elemento de valor de atributo adjunto representa un "valor de atributo secundario" de este valor de atributo, cuyos miembros se agrupan implícitamente en este valor.

exportActiveCurrencies

exportCalendar

¿Ha resultado útil?

¿Qué requiere nuestra atención? Es correcta Responde a mi pregunta Fácil de encontrar Fácil de entender Me ayuda a completar mi tarea Es completa y detallada

¿Qué requiere nuestra atención? No es correcta No responde a mi pregunta No es fácil de encontrar No es fácil de entender No me ayuda a completar mi tarea Es incompleta o poco detallada

Díganos la tarea que está realizando. ¿Qué información adicional podría mejorar este contenido? ¿Algún detalle adicional que quiera compartir?

Nombre y apellidos

Correo electrónico

Workday utilizará su nombre y correo electrónico para proporcionarle respuestas relacionadas con sus comentarios. Su información se tratará de acuerdo con nuestra Declaración de privacidad.

Gracias por el feedback