exportLevels

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

exportLevels

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 niveles de organización 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 contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama y una etiqueta de inclusión opcional para indicar qué niveles incluir en la respuesta. Una vez verificadas las credenciales de usuario, el método devuelve un documento XML que describe el conjunto de niveles de organización en el sistema correspondiente a la solicitud. Los niveles se devuelven en forma de árbol anidado, con una etiqueta de nivel que encierra a otra si el nivel representado por la etiqueta envolvente es el principal del nivel incluido.

Filtrado de nivel

El filtrado de nivel/versión no disponible siempre se aplica cuando se especifica una versión.

Si un usuario especifica una hoja asignada al usuario en la solicitud:

Los niveles se muestran si el usuario tiene acceso a esa hoja. En el caso de los usuarios administradores, si

inaccessibleValues

es verdadero, se devolverán los niveles para la hoja.

Todos los niveles de la hoja muestran si el usuario tiene acceso a la hoja, independientemente del nivel de acceso del usuario.

Si un usuario especifica una hoja asignada a nivel en la solicitud:

El filtrado de acceso de usuario se aplica cuando lo requiere

inaccessibleValues,

lo que determina si la respuesta debe incluir niveles a los que el usuario no tiene acceso.

A continuación, se aplica el filtrado de hojas.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportLevels" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_pwd"/>
   <include versionID="3" inaccessibleValues="false"/>
   <sheet id="3" />
</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
Nombre de etiqueta		incluir
Descripción		Representa un conjunto de indicadores que indican qué aspectos de la información de los niveles deben incluirse o excluirse de la respuesta. Este elemento es opcional: si no está presente, el valor por defecto es false para inaccessibleValues y está en blanco (o todas las versiones) para versionName/versionID.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
grupos Disponible en versiones superiores a la versión 23 de API	No	Indica si los elementos de nivel de la respuesta incluyen un atributo groupIds. Si es verdadero, los groupIds de la respuesta contienen una lista separada por comas de todos los grupos en los que se encuentra el nivel. Si el atributo no está presente, o si su valor es distinto de verdadero o falso, se utiliza el valor por defecto de falso.	verdadero
inaccessibleValues Disponible en API v18+.	No	Si la respuesta debe incluir niveles a los que el usuario no tiene acceso. Verdadero o falso. El valor por defecto, si el elemento o su atributo no está presente, es falso. Si se establece en falso, la respuesta solo incluirá los niveles a los que el usuario tiene acceso a datos, ya sea directo o implícito. Tenga en cuenta que esto significa que la respuesta ya no puede ser un árbol de niveles con raíz única, sino una serie de subárboles separados del árbol global. Solo los usuarios con los permisos "Estructura de organización: todos los niveles" o "Importar a todos los niveles" pueden definir esta opción como verdadera.	falso
inaccessibleLevels Disponible en API v17 y anteriores. No disponible en API v18+.	No	Verdadero o falso. Si la respuesta debe incluir niveles a los que el usuario no tiene acceso. El valor por defecto, si el elemento o su atributo no está presente, es verdadero. Si se establece en falso, la respuesta solo incluirá los niveles a los que el usuario tiene acceso a datos, ya sea directo o implícito. Tenga en cuenta que esto significa que la respuesta ya no puede ser un árbol de niveles con raíz única, sino una serie de subárboles separados del árbol global.	verdadero
versionName Actualizado en API v18	No	Indica si la respuesta solo debe incluir niveles que estén disponibles para el nombre de versión solicitado. El valor por defecto, si el elemento o su atributo no está presente, es devolver todos los niveles. Si se especifica un nombre de versión, solo se devolverán los niveles que estén disponibles para la versión especificada. Si está presente, también se aplicará el atributo inaccessibleValues y solo se devolverán los niveles que estén disponibles en la versión especificada y accesibles para el usuario solicitante. Si no se encuentra el nombre de versión especificado, esta API devuelve un error. Si se pasan los atributos versionName y versionID, se ignora el valor de versionID. Al especificar una versión, la llamada solo se realizará correctamente si el usuario tiene acceso a la versión.	Ingeniería
versionID Actualizado en API v18	No	Igual que versionName (anterior), excepto que se toma un número de ID de versión como parámetro. Indica si la respuesta solo debe incluir niveles que estén disponibles para la versión solicitada. El valor por defecto, si el elemento o su atributo no está presente, es devolver todos los niveles. Si se especifica un ID de versión, solo se devolverán los niveles que estén disponibles para la versión especificada. Si está presente, también se aplicará el atributo inaccessibleValues y solo se devolverán los niveles que estén disponibles en la versión especificada y accesibles para el usuario solicitante. Si no se encuentra el ID de versión especificado, esta API devuelve un error. Si se pasan los atributos versionName y versionID, se ignora el valor de versionID. Al especificar una versión, la llamada solo se realizará correctamente si el usuario tiene acceso a la versión.	3
sin categorizar Se admite en API v22+ cuando la instancia utiliza reglas de acceso por seguridad.	No	Indica si se deben incluir los niveles ficticios en la respuesta. El valor por defecto es falso. Los niveles ficticios se incluyen en la respuesta solo 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 exportLevels debe respetar las propiedades de nombre de visualización de code , displayNameType y description cuando Activar nombre de visualización está activado para la instancia. displayNameEnabled=false indica que la API exportLevels 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 exportLevels ignora las propiedades de nombre de visualización code , displayNameType y description . El valor por defecto de displayNameEnabled es "false".	falso
Contenido del elemento
(ninguno)

elemento de hoja
Nombre de etiqueta		hoja
Descripción		Representa una hoja, donde solo se incluirán en la respuesta los niveles disponibles para esa hoja. Este elemento es opcional: si no está presente, la API devolverá información de nivel independiente de una hoja en particular. Si la hoja dada es una hoja asignada a nivel, este filtro se aplicaría además del filtrado de versión y acceso de usuario, si está presente. Si la hoja dada es una hoja asignada al usuario a la que el usuario actual tiene acceso, se devolverán todos los niveles de esa hoja después de cualquier filtro de versión.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno de la hoja.	234
Contenido del elemento
(ninguno)

Formato de respuesta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
 <levels seqNo="21">
   <level id="1" name="Corporate Rollup" currency="USD" isImportable="1" workflowStatus="I">
     <level id="2" name="Engineering" currency="USD" shortName="Engr" isImportable="1" workflowStatus="I">
       <level id="7" name="Development" currency="USD" shortName="Dev" isImportable="1" workflowStatus="I"/>
       <level id="8" name="QA" currency="INR" isImportable="0" workflowStatus="L"/>
       <level id="9" name="Documentation" currency="PKR" shortName="Doc" isImportable="1" workflowStatus=R"/>
     </level>
     <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" isImportable="0" workflowStatus="A">
       <attributes>
         <attribute name="Corporate Discount" value="Available" attributeId="20" valueId="188" />
         <attribute name="Transfers Restricted" value="Yes" attributeId="21" valueId="194" />
       </attributes>
     </level>
   </level>
 </levels>
</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
(ninguno)
Contenido del elemento
Un solo elemento de cuentas 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 niveles
Nombre de etiqueta		niveles
Descripción		Contenedor para el elemento de nivel.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
seqNo Añadido en API v17, pero reservado para uso futuro.
Contenido del elemento
Uno o varios elementos de nivel Si la solicitud incluye niveles inaccesibles, solo habrá un elemento de nivel, que representa el nivel superior de la organización.

elemento de nivel
Nombre de etiqueta		nivel
Descripción		Representa un solo nivel de organización que se devuelve en la respuesta a una llamada a la API exportLevels.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno para el nivel.	7
código Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	El código del nivel.	Desarrollo
nombre	Sí	El nombre del nivel, tal como aparece en informes y hojas.	Desarrollo
displayName Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	El nombre de visualización del nivel derivado de displayNameType.	Desarrollo
moneda	Sí	El código de moneda de la moneda asignada a este nivel de la organización. La moneda será una de las monedas configuradas para la instancia, que se encuentra en la llamada exportActiveCurrencies.	INR
publicarMoneda Disponible en API v24+	No	El código de moneda de la moneda asignada para publicar desde este nivel. Esta propiedad solo es aplicable cuando se ha activado Poder de uno para la instancia. La moneda será una de las monedas configuradas para la instancia, que se encuentra en la llamada exportActiveCurrencies.	USD
shortName	No	La abreviatura del nivel, si la hay, tal como se ha introducido en Administración de niveles.	Dev
availableStart	No	El periodo inicial de la disponibilidad del nivel para la versión de cifras reales, aplicable solo cuando se especifica la versión ACTUALS en la solicitud. El valor puede ser un código de periodo, como "01/2012", o el valor especial "START" que indica el inicio de la versión.	01/2013
availableEnd	No	El periodo temporal final para la disponibilidad del nivel para la versión de cifras reales, aplicable solo cuando se especifica la versión ACTUALS en la solicitud. El valor puede ser un código de periodo, como "12/2013", o el valor especial "END" que indica el final de la versión.	12/2013
isImportable	No	Indica si el nivel asociado se puede importar en la versión especificada. '0' significa que no se puede importar y '1' significa que se puede importar. Un nivel se puede importar si se puede importar al menos un intervalo de tiempo de la versión especificada. El atributo isImportable solo se emite si se especifica versionName o versionID en la solicitud. Nota: isImportable solo indica que un nivel está disponible para importar en la versión especificada, no que el usuario que realiza la llamada a la API tenga permiso para importar a la versión o al nivel. Utilice exportVersions para ver qué versiones están disponibles para que el usuario las importe.	1
workflowStatus	No	Emite el estado del workflow para el nivel asociado. I para "En curso", S para "Enviado", R para "Rechazado", A para "Aprobado" y L para "Bloqueado". Solo se incluye en la respuesta si el flujo de trabajo está activado para esta empresa y se especifica un versionName o versionID de planificación en la solicitud. El flujo de trabajo no está disponible en las versiones de cifras reales.	I
isLinked	Sí	1 si el nivel es un nivel vinculado; de lo contrario, 0.	1
isElimination	Sí	1 si el nivel es un nivel de eliminación; de lo contrario, 0.	0
hasChildren	No	Indica si el nivel tiene elementos secundarios. "falso" para no, "verdadero" para sí. Este atributo se establece para cualquier nivel que tenga elementos secundarios, independientemente de que los elementos secundarios sean accesibles o no. Si un nivel tiene elementos secundarios, pero los elementos secundarios no son accesibles, el atributo hasChildren se sigue estableciendo en verdadero.	verdadero
descripción Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	La descripción del nivel, si la hay, tal como se ha introducido en Administración de niveles.
Contenido del elemento
Un elemento de nivel anidado para cada nivel secundario directo de este nivel. Un elemento de atributos si este nivel tiene uno o más atributos asociados.

elemento de atributos
Nombre de etiqueta		atributos
Descripción		Contenedor para uno o varios elementos de atributo.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Uno o varios elementos de atributo

elemento de atributo
Nombre de etiqueta		atributo
Descripción		Representa una sola asignación de atributo de nivel que no está en blanco a la que se asocia un nivel.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre del atributo de nivel	Descuento corporativo
valor Se admite en API v34 cuando el parámetro Nombre de visualización efectivo está activado.	Sí	El valor del atributo de nivel asociado al nivel.	Sí
valueCode Solo está disponible en API v32 y API v33 para instancias que activan el nombre de visualización. No se admite en API v34 cuando el parámetro Nombre de visualización efectivo está activado.	No	El código de valor de atributo para este atributo. Para API v32 y v33, valueCode solo es significativo cuando: El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1	Sí
valueName Solo está disponible en API v32 y API v33 para instancias que activan el nombre de visualización. No se admite en API v34 cuando el parámetro Nombre de visualización efectivo está activado.	No	El nombre de valor de atributo para este atributo. Para API v32 y API v33, valueName solo es significativo cuando: El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1value	Sí
valueDisplayName Solo está disponible en API v32+ para instancias que activan el nombre de visualización.	Sí	El nombre de visualización del valor de atributo. Para API v32 y posteriores, valueDisplayName solo es significativo cuando: El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1value	Sí
attributeID	Sí	El número de ID de sistema interno del atributo de nivel.	20
valueID	Sí	El número de ID de sistema interno del valor de atributo de nivel.	188
Contenido del elemento
(ninguno)

exportInstances

exportLocales

¿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