updateLevels

HTTP	Descripción
Method	Post
Content-Type	text/xml

Ejemplo de rotación


curl -H "Content-Type: text/xml" -d @C:/temp/updateLevels.xml -X POST https://api.adaptiveplanning.com/api/v19

updateLevels.xml contents

Formato de solicitud

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd"/>
<levels>
<level id="1" name="HQ">
 <level id="2" name="Engineering" currency="USD" shortName="Engr">
   <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0"/>
   <level id="9" name="QA" currency="INR" eliminationTradingPartner="1"/>
   <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1">
      <version name="Budget 2011" available="1"/>
      <version name="Budget 2012" available="0"/>
      <version name="Budget 2013" available="1"/>
   </level>
 </level>
 <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1">
     <attribute name="Corporate Discount" value="Available"/>
     <attribute name="Transfers Restricted" value="Yes"/>
     <dimension name="Region" value="C-US"/>
 </level>
</level>
</levels>
</call>

Para cargas útiles grandes, puede publicar archivos XML comprimidos (en zip). Consulte Actualización masiva de metadatos.

Se aplican las siguientes condiciones a updateLevels:

Los niveles se identifican para su actualización mediante su número de ID interno.

Para crear nuevos niveles, asígneles una propiedad de ID en blanco o que falte.

Puede mover un elemento existente (no nuevo) para que se convierta en elemento secundario de un elemento nuevo. Al hacerlo, se crea el nuevo elemento y se mueve el elemento existente debajo de él como elemento secundario.

La disponibilidad de hojas y el acceso de usuario no se pueden actualizar mediante

updateLevels

.

Formato de solicitud para crear un nuevo nivel

Para crear un nuevo nivel, incluya su principal por su ID. Por ejemplo, para añadir un nuevo nivel secundario por debajo del

Engr

valor que tiene

id 7

, puede utilizar:

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateLevels" callerName="Steve C">
 <credentials login="stevec@greenco.com" password="password"/>
 <levels>
   <level id="7">
     <level id="" name="Documentation" description="docs" shortName="" >
     </level>
   </level>
 </levels>
</call>

Este método no cambia nada sobre el nivel

id 7

. Crea un nuevo elemento secundario llamado

Documnentation

para

id 7

. Todos los elementos secundarios no mencionados de

Engr

pasar al final de la lista de elementos secundarios. Esto es el equivalente a "establecer el nivel principal" para el nuevo nivel.

Formato de entrada 1: carga útil incluye todo el árbol

La API updateLevels funciona mejor cuando una persona que llama quiere proporcionar el nuevo estado de árbol sin preocuparse por los cambios.

La API updateLevels determina los cambios en la estructura de niveles y solo se actualizan los niveles recién añadidos o modificados. Tenga en cuenta que el

levels

el elemento contiene solo un elemento secundario directo

level

elemento A continuación, ese elemento secundario contiene el resto de la jerarquía.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<levels>
   <level id="1" name="HQ">
      <level id="2" name="Engineering" currency="USD" shortName="Engr">
         <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" />
         <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" />
         <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" />
      </level>
      <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1" />
   </level>
</levels>
</call>

Formato de entrada 2: carga útil incluye estructura de subárbol de nivel

Este formato admite casos de uso en los que los cambios se limitan a solo una parte de la estructura de árbol de niveles.

Por ejemplo, los cambios están dentro del nivel Ingeniería. Nuevamente, el

levels

el elemento solo contiene un elemento secundario directo

level

elemento Ese nivel contiene el resto de los niveles de la estructura de subárbol. El subárbol más pequeño para este formato incluye solo un elemento principal y un elemento secundario.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<levels>
   <level id="2" name="Engineering" currency="USD" shortName="Engr">
      <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" />
      <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" />
      <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" />
   </level>
</levels>
</call>

Formato de entrada 3: actualización de un solo nivel

Este formato admite la gestión del caso de uso cuando los cambios se limitan a un solo nivel. El

levels

el elemento solo contiene un elemento secundario directo

level

elemento

Utilice solo el formato de entrada 3 al actualizar un solo nivel. El formato de entrada 3 no es el formato preferido para actualizar varios niveles. No puede crear un nuevo nivel con este formato. Utilice el formato de entrada 2 para añadir nuevos niveles secundarios.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<levels>
   <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1" />
</levels>
</call>

Formato de entrada 4: formato plano que contiene todas las etiquetas de nivel en la etiqueta de niveles

Este formato contiene

level

etiquetas debajo de

levels

etiqueta en un formato plano sin jerarquía. Solo actualiza las propiedades de cada nivel de la lista, sin alterar las jerarquías de niveles.

Utilice únicamente el formato plano para cambios incrementales o deltas en porciones muy pequeñas de la jerarquía. El formato de entrada 1 ofrece el mejor rendimiento para cargar toda la jerarquía de niveles.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateLevels" callerName="a string that identifies your client application">
<credentials login="steve@steveco.com" password="" />
<levels>
   <level id="2" name="Engineering" currency="USD" shortName="Engr" />
   <level id="8" name="Development" currency="USD" shortName="Dev" inWorkflow="0" />
   <level id="9" name="QA" currency="INR" eliminationTradingPartner="1" />
   <level id="10" name="Documentation" currency="PKR" shortName="Doc" actualsStart="05/2013" actualsEnd="12/2018" inWorkflow="1" propagateToDescendants="1">
      <version name="Budget 2011" available="1" />
      <version name="Budget 2012" available="0" />
      <version name="Budget 2013" available="1" />
   </level>
</levels>
</call>

Gestión de varios cambios de nombre en una sola llamada a updateLevels

Se pueden realizar varios cambios de nombre de la misma entidad en un sistema remoto entre

updateLevels

llamadas Los nombres de las entidades del sistema remoto pueden intercambiarse por los mismos ID de entidad. Cuándo

updateLevels

las llamadas tienen lugar después del intercambio de nombre, el

updateLevels

call gestiona estos cambios realizando un seguimiento de los ID en los cambios de nombre. La llamada también puede gestionar la introducción de un nuevo ID que utilice un nombre existente.

Para que cada uno de los ejemplos sea correcto, el intercambio completo de IDs debe realizarse con los valores exclusivos.

Ejemplo 1: un simple intercambio de nombres en el sistema remoto.


ID     Unique Value   New Unique Value
1      AA             BB
2      BB             AA

Ejemplo 2: una secuencia de 3 cambios de nombre en el sistema remoto.


ID     Unique Value   New Unique Value
1      AA             BB
2      BB             CC
3      CC             AA

Ejemplo 3: una nueva entidad que utiliza un valor exclusivo existente.


ID     Unique Value   New Unique Value
4                     AA
1      AA             BB
2      BB             Old BB

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 niveles
Nombre de etiqueta		niveles
Descripción		Solo se permite una solicitud de elemento de niveles por carga útil. Contiene uno o varios elementos de nivel.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
retainExisitingOrder Disponible en API v26+	No	RetainExistingOrder="1" indica que la API de updateLevels debe ignorar el orden de los elementos en la carga útil XML y se conservará el orden definido existente. RetainExistingOrder="0" indica que la API updateLevels debe actualizar el orden de los elementos en función de la posición de la etiqueta en relación con otros elementos del mismo nivel en la carga útil XML. El atributo retainExistingOrder se ignora en la versión de API anterior a API v26. El valor por defecto de retainExistingOrder es "0" para v26. Para la versión API v27 y posteriores, el valor por defecto de preserveExistingOrder es "1".	1
displayNameEnabled Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	displayNameEnabled=1 indica que updateLevels 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=0 indica que la API updateLevels 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 updateLevels ignora las propiedades de nombre de visualización code , displayNameType y description . El valor por defecto de displayNameEnabled es "0".	1
Contenido del elemento
Contiene uno o varios elementos de nivel.

elemento de nivel
Nombre de etiqueta		nivel
Descripción		Especifica un nivel para crear.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El ID del nivel que se está actualizando.	34
código Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	El código exclusivo del nivel. Esta propiedad solo está disponible cuando la opción Activar nombre de visualización está activada para la instancia.	NewLevelName
nombre	No	El nombre del nivel. Cuando Activar nombre de visualización está activado para una instancia con API v30 o superior, el nombre permite valores duplicados. Cuando Activar nombre de visualización está desactivado para una instancia, el código no está disponible y el nombre debe ser exclusivo.	NewLevelName
shortName actualizado en API v30	No	Título visualizable de la columna, tal como se ve en la hoja.	NewLevelShortName
moneda	No	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.	USD
publishCurrency Disponible en API v24+	No	PublishCurrency define la moneda de empresa de Workday al publicar un plan financiero. La moneda de publicación se carga a través del cargador de niveles de Planning en la integración de Workday Adaptive Planning como un atributo de moneda adicional para un nivel. PublishCurrency indica una de las monedas configuradas para la instancia, que se encuentra en la llamada exportActiveCurrency y en la interfaz de usuario del administrador de niveles. Solo está disponible cuando define Adaptive Planning para Workday. Consulte la sección Publicación de planes de Pasos: configuración de Adaptive Planning para HCM y Financials.	CAD
inWorkflow	No	Indica si este nivel participa en un flujo de trabajo.	1
propagateToDescendants	No	Indica si los cambios se propagan a los elementos secundarios de este nivel. 0 para no, 1 para sí. No todas las propiedades de nivel están cubiertas por propagateToDescendants. Para obtener una lista de las propiedades afectadas por propagateToDescendants , consulte Comportamiento de propagateToDescendants durante las solicitudes UpdateLevels.	0
eliminaciónLevel	No	Indica si este nivel es un nivel de eliminación para su uso en eliminaciones interempresa. Un nivel puede ser un nivel de eliminación o un socio comercial de eliminación, pero no ambos.	1
eliminationTradingPartner	No	Indica si este nivel es un socio comercial de eliminación. Un nivel puede ser un socio comercial de eliminación o un nivel de eliminación, pero no ambos.	0
actualsStart	No	Indica el inicio de las cifras reales de este nivel. Debe ser un código de horas existente de Administración de tiempos en el estrato temporal por defecto.	Mayo de 2013
actualsEnd	No	Indica el final de las cifras reales de este nivel. Debe ser un código de horas existente de Administración de tiempos en el estrato temporal por defecto.	Dic-2018
descripción Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	La descripción del nivel. Esta propiedad solo está disponible cuando la opción Activar nombre de visualización está activada para la instancia.	El departamento de nivel superior.
Contenido del elemento
Uno o varios elementos de atributo si desea definir uno o varios atributos de nivel asociados al nivel.

elemento de versión
Nombre de etiqueta		versión
Descripción		Especifica la disponibilidad de la versión de un nivel. Requiere una versión preexistente.
Atributos del elemento
Nombre de atributo	¿Obligatorio?		Ejemplo
nombre	Sí	El nombre de la versión, tal como aparece en Administración de versiones.	Presupuesto 2015
disponible	Sí	Si es 1, esta versión está disponible en este nivel.	1
Contenido del elemento
Uno o varios elementos de versión para cada nivel

elemento de atributo
Nombre de etiqueta		atributo
Descripción		Especifica un atributo para actualizar.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre actualizado en API v30	Sí	El nombre del atributo.	Ubicación
valor actualizado en API v34	Sí	El valor de atributo para este atributo. Para API v32 y v33, este atributo solo es significativo cuando la configuración de Nombre de visualización está desactivada para la instancia. Para API v34 y posteriores: Se admite cuando el parámetro Nombre de visualización efectivo está activado. La presencia de valueCode y valueName generará un error. Cuando la importación de nivel crea automáticamente valores de atributo está activada en la interfaz de usuario de administración de atributos, la cadena de valor se convierte en el código y el nombre si el valor aún no existe. Defina value="" para eliminar este etiquetado de atributo.	170
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.	Sí	El código de valor de atributo para este atributo. La entrada valueCode solo es significativa cuando displayNameEnabled=1 y el parámetro Nombre de visualización está activado para la instancia en API v32 y API v33. Defina valueCode="" para eliminar este etiquetado de atributo.	SFO
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.	No	El atributo valueName solo es significativo cuando: valueCode contiene un valor de atributo que no existe. El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1 Llamando a API v32 y API v33. valueName se ignora cuando valueCode contiene un valor de atributo existente.	San Francisco
Contenido del elemento
(ninguno)

elemento de dimensión
Nombre de etiqueta		dimensión
Descripción		Especifica las asignaciones de valor de dimensión de nivel.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre actualizado en API v30	Sí	El nombre de la dimensión.	Presupuesto 2015
valor actualizado en API v34	Sí	El valor de dimensión para esta dimensión disponible en este nivel. Para API v32 y API v33, el valor solo es significativo cuando la configuración de Nombre de visualización está desactivada para la instancia. Para API v34 y posteriores: Se admite cuando el parámetro Nombre de visualización efectivo está activado. La presencia de valueCode y valueName generará un error. Cuando la importación de datos crea automáticamente valores de dimensión está activada en la interfaz de usuario de administración de dimensión, la cadena de valor se convierte en el código y el nombre si el valor aún no existe.	Lahore
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.	Sí	El código de valor de dimensión para esta dimensión disponible en este nivel. Para API v32 y API v33, valueCode solo es significativo cuando: El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1	LHE
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.	No	El nombre de un valor de dimensión recién creado automáticamente. Para API v32 y API v33, valueName solo es significativo cuando valueCode contiene un valor de dimensión inexistente. El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1	Lahore
Contenido del elemento
(ninguno)

Proceso de carga útil de arriba a abajo

Los atributos de los niveles agrupan valores y etiquetan niveles de forma lógica. Dado que la API updateLevels procesa la carga útil XML de arriba abajo, asigne un atributo de nivel para el nivel principal antes de cambiar los valores de nivel de atributo secundario. Los niveles secundarios se pueden etiquetar con cualquier valor de atributo cuando el valor de atributo del nivel principal está en blanco. Si los atributos de nivel no se alinean con el atributo principal, se produce un error de validación de compatibilidad.

Tenga en cuenta la siguiente estructura de árbol, donde el elemento principal "California" tiene dos niveles secundarios, "Palo Alto" y "Pleasanton". Los atributos de nivel "Palo Alto" y "Pleasanton" son del mismo nivel.


Location
|__USA                              
|__California
   |__Palo Alto
   |__Pleasanton

Muestra de XML de solicitud original con atributos de nivel

Tenga en cuenta que el valor de atributo de ubicación "Palo Alto" se asigna tanto a "Ingeniería" como a "Desarrollo".


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <attribute name="Location" value="" />
   <level id="2" name="Engineering">
      <attribute name="Location" value="Palo Alto" />
      <level id="8" name="Development">
         <attribute name="Location" value="Palo Alto" />
      </level>
   </level>  
</level>
</levels>

Ejemplo de orden incorrecto para proceso de carga útil

La siguiente carga útil XML genera un error, "

The attribute value Pleasanton is not compatible with the parent's attribute value

". El proceso de carga útil de arriba a abajo considera que el nivel principal "Ingeniería" tiene el valor de atributo de ubicación "Palo Alto" del bloque de código anterior y procesa "Pleasanton" como el elemento secundario de "Palo Alto". El error se genera porque el nivel secundario "Desarrollo" solo puede tener el atributo de ubicación "Palo-Alto", como se indica en la estructura de árbol.


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <level id="2" name="Engineering">
      <level id="8" name="Development">
         <attribute name="Location" value="Pleasanton" />
      </level>
      <attribute name="Location" value="California" /> <!-- Level Attribute change ignored due to placement order-->
   </level>
   <attribute name="Location" value="" />
</level>
</levels>

Ejemplo de orden válida para proceso de carga útil

Reorganizar el orden de ubicación del atributo "California" debajo de "Ingeniería" permite que la API procese primero el atributo de nivel principal, lo que permite que el nivel secundario "Desarrollo" tenga el valor de atributo de ubicación "Palo Alto" o "Pleasanton". .


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <attribute name="Location" value="" /> <!-- Level Attribute change processed due to correct placement order-->
   <level id="2" name="Engineering">
      <attribute name="Location" value="California" />
      <level id="8" name="Development">
         <attribute name="Location" value="Pleasanton" />
      </level>
   </level>
</level>
</levels>

La disponibilidad de versión de un nivel funciona de la misma manera. Defina la disponibilidad de la versión de un nivel antes de modificar los niveles secundarios para evitar errores de compatibilidad.

XML de solicitud original de muestra con versiones

Tenga en cuenta que la disponibilidad de la versión "Budget 2020" para los niveles "Ingeniería" y "Desarrollo" está establecida en "0".


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <version name="Budget 2020" available="0" />
   <level id="2" name="Engineering">
      <version name="Budget 2020" available="0" />
      <level id="8" name="Development">
         <version name="Budget 2020" available="0" />
      </level>
   </level>
</level>
</levels>

Ejemplo de orden incorrecto para proceso de carga útil

La siguiente carga útil XML genera un error, ya que el proceso de carga útil de arriba a abajo considera que el elemento principal "Ingeniería" no está disponible ("

available=0")

para la versión "Budget 2020" del bloque de código anterior y procesa la disponibilidad del nivel secundario "Desarrollo" como "1". El nivel secundario "Desarrollo" no puede estar disponible cuando el nivel principal "Ingeniería" no lo está.


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <level id="2" name="Engineering">
      <level id="8" name="Development">
         <version name="Budget 2020" available="1" />
      </level>
      <version name="Budget 2020" available="1" /><!-- Parent version availability change ignored due to placement order-->
   </level>
   <version name="Budget 2020" available="1" />
</level>
</levels>

Ejemplo de orden válida para proceso de carga útil

Reorganizar el orden de ubicación para la versión "Budget 2020" por debajo del nivel principal "Ingeniería" permite que la API procese primero la disponibilidad principal, lo que permite que "Desarrollo" tenga el valor de disponibilidad de la versión de "1" o "0".


<levels deleteWorkflowSilently="0" deleteActualsSilently="0">
<level id="1" name="HQ" proceedWithWarnings="0">
   <version name="Budget 2020" available="1" />
   <level id="2" name="Engineering"><!-- Parent Version availability change processed due to correct placement order-->
      <version name="Budget 2020" available="1" />
      <level id="8" name="Development">
         <version name="Budget 2020" available="1" />
      </level>
   </level>
</level>
</levels>

Formato de respuesta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<levels>
  <level id="1" name="HQ" currency="CAD" shortName="" eliminationLevel="1" eliminationTradingPartner="0" inWorkflow="0" status="">
    <level id="2" name="Engineering" currency="USD" shortName="Engr" eliminationLevel="0" eliminationTradingPartner="1" inWorkflow="0" status="updated">
      <level id="8" name="Development" currency="USD" shortName="Dev" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="0" status="updated" />
      <level id="9" name="QA" currency="INR" shortName="" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="0" status="updated" />
      <level id="10" name="Documentation" currency="PKR" shortName="Doc" eliminationLevel="0" eliminationTradingPartner="0" inWorkflow="1" propagateToDescendants="1" actualsStart="05/2013" actualsEnd="12/2018" status="updated">
        <version name="Budget 2011" available="1" status="" />
        <version name="Budget 2012" available="0" status="updated" />
        <version name="Budget 2013" available="1" status="" />
      </level>
    </level>
    <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" eliminationLevel="1" eliminationTradingPartner="0" inWorkflow="0" status="updated">
      <attribute name="Corporate Discount" value="Available" status="" />
      <attribute name="Transfers Restricted" value="Yes" status="" />
      <dimension name="Region" value="C-US" status="" />
    </level>
  </level>
</levels>
</output>
</response>

elemento de resultado
Nombre de etiqueta	salida
Atributos del elemento
(ninguno)
Contenido del elemento
Un solo elemento de nivel obligatorio. 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 uno o varios elementos de nivel.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
RetainExisting Order	No	0 La API updateLevels debe actualizar el criterio de ordenación en función del contenido de la carga útil XML. 1 API de updateLevels debe mantener el criterio de ordenación existente.	1
displayNameEnabled Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	displayNameEnabled=1 indica que updateLevels 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.	1
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 de updateLevels.
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 exclusivo del nivel. Esta propiedad solo está disponible cuando la opción Activar nombre de visualización está activada para la instancia.	HQ
nombre	Sí	El nombre del nivel, tal como aparece en informes y hojas.	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
publishCurrency Disponible en API v24+	No	PublishCurrency define la moneda de empresa de Workday al publicar un plan financiero. La moneda de publicación se carga a través del cargador de niveles de Planning en la integración de Workday Adaptive Planning como un atributo de moneda adicional para un nivel. La moneda de publicación indica una de las monedas configuradas para la instancia, que se encuentra en la llamada exportActiveCurrencies y se indica en la interfaz de usuario de administrador de nivel. Requiere Workday Power of One activado mediante aprovisionamiento.	CAD
shortName	No	La abreviatura del nivel, si la hay, tal como se ha introducido en Administración de niveles.	Dev
eliminaciónLevel	No	Indica si el nivel es un nivel de eliminación. 0 para no, 1 para sí.	1
eliminationTradingPartner	No	descripción	1
inWorkflow	No	Indica si el nivel está en un workflow. 0 para no, 1 para sí.	1
propagateToDescendants	No	Indica si los cambios se propagan a los elementos secundarios de este nivel. 0 para no, 1 para sí. Para obtener más información sobre el comportamiento de propagateToDescendants, consulte Comportamiento de propagateToDescendants durante las solicitudes UpdateLevels.	1
actualsStart	No	El código de entrada de horas definido en Administración de horas para el inicio de la versión de cifras reales de este nivel.	05/2013
actualsEnd	No	El código de entrada de horas definido en Administración de horas para el final de la versión de cifras reales de este nivel.	12/2018
descripción Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	La descripción del nivel. Esta propiedad solo está disponible cuando la opción Activar nombre de visualización está activada para la instancia.	El departamento de nivel superior.
estado	Sí	El estado del nivel después de la actualización. En el caso de los avisos y los errores, el elemento de mensaje incluye el contenido del mensaje. El estado actualizado no devuelve ningún contenido de mensaje. Error: se ha encontrado un error en la entidad. Aviso: se ha encontrado un aviso en la entidad. Creado: la entidad se ha creado correctamente. Actualizado: la entidad se ha actualizado correctamente.	Actualizado
mensaje	No	El mensaje de error de entrada de nivel no válida	El nivel UKregion2 está duplicado en la carga útil o ya existe en el sistema con el ID 6.
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 atributo
Nombre de etiqueta		atributo
Descripción		Contenedor para un elemento de atributo de nivel.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre del atributo de nivel	Ubicación
valor	Sí	El valor del atributo de nivel.	SFO
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.	Sí	El código de valor de atributo para este atributo. Para API v32 y posteriores, valueCode solo es significativo cuando: El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1	SFO
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.	No	El nombre de un valor de atributo recién creado automáticamente. El atributo valueName solo es significativo cuando: valueCode contiene un valor de atributo que no existe. El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1value Name se ignora cuando valueCode contiene un valor de atributo existente.	San Francisco
estado	Sí	El estado del atributo después de la actualización. En el caso de los avisos y los errores, el elemento de mensaje incluye el contenido del mensaje. El estado actualizado no devuelve ningún contenido de mensaje. Error: se ha encontrado un error en la entidad. Aviso: se ha encontrado un aviso en la entidad. Creado: la entidad se ha creado correctamente. Actualizado: la entidad se ha actualizado correctamente.	actualizado
mensaje	No	El mensaje de error de una entrada de atributo no válida.	El nivel UKregion2 está duplicado en la carga útil o ya existe en el sistema con el ID 6.
Contenido del elemento
(ninguno)

elemento de versión
Nombre de etiqueta		versión
Descripción		Especifica la disponibilidad de la versión de un nivel.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre de la versión, tal como aparece en Administración de versiones.	Presupuesto 2015
valor	Sí	Si es 1, este nivel está disponible en esta versión.	1
estado	Sí	El estado de la versión después de la actualización. En el caso de los avisos y los errores, el elemento de mensaje incluye el contenido del mensaje. El estado actualizado no devuelve ningún contenido de mensaje. Error: se ha encontrado un error en la entidad. Aviso: se ha encontrado un aviso en la entidad. Creado: la entidad se ha creado correctamente. Actualizado: la entidad se ha actualizado correctamente.	actualizado
Contenido del elemento
Uno o varios elementos de versión para cada valor de dimensión.

elemento de dimensión
Nombre de etiqueta		dimensión
Descripción		Representa una sola dimensión personalizada que se devuelve en la respuesta a una llamada a la API de updateLevels.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre de la dimensión, tal como aparece en informes y hojas.	Región
valor	No	El valor de dimensión disponible para este nivel.	C-USA
valueCode Solo está disponible en API v32+ para instancias que activan el nombre de visualización.	Sí	El código de valor de dimensión para esta dimensión. Para API v32 y posteriores, valueCode solo es significativo cuando: El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1	CUS
valueName Solo está disponible en API v32+ para instancias que activan el nombre de visualización.	No	El nombre de un valor de dimensión recién creado automáticamente. Para API v32 y posteriores, valueName solo es significativo cuando: valueCode contiene un valor de dimensión inexistente. El parámetro Nombre de visualización está activado para la instancia. displayNameEnabled=1 valueName se ignora cuando valueCode contiene un valor de dimensión existente.	C-USA
estado	No	El estado de la versión después de la actualización. En el caso de los avisos y los errores, el elemento de mensaje incluye el contenido del mensaje. El estado actualizado no devuelve ningún contenido de mensaje. Error: se ha encontrado un error en la entidad. Aviso: se ha encontrado un aviso en la entidad. Creado: la entidad se ha creado correctamente. Actualizado: la entidad se ha actualizado correctamente.	Actualizado
Contenido del elemento
(ninguno)

Descripción de mensajes de error y aviso

Tipo	Mensaje	Ejemplo/Descripción
Error	Se ha producido un error de sistema. Póngase en contacto con el servicio de asistencia técnica para obtener más información.	Error de sistema
Error	No ha sido posible encontrar el archivo "content.xml".	Ya existe en la API de updateDimensions
Error	La entrada proporcionada no contiene etiquetas de nivel.	A la carga útil le falta la etiqueta de nivel.
Error	{0} no se reconoce como {1} definido.	Se utiliza cuando se desconoce el nombre o el valor de la versión.
Error	El {0} no puede estar vacío.	El nombre de la versión está vacío.
Error	La disponibilidad de la versión no se puede cambiar para las cifras reales.	Cuando el usuario intenta modificar la visibilidad de la versión de cifras reales.
Error	La disponibilidad de la versión no se puede cambiar para el nivel raíz {0}.	Cuando el usuario intenta modificar la visibilidad de la versión para el nivel raíz.
Error	La visibilidad de la versión {0} en el nivel {1} no es compatible con la principal de {1}.	Cuando la visibilidad de la versión proporcionada del nivel no es compatible con el nivel principal.
Error	No tiene acceso para actualizar uno o más de los niveles o las versiones especificados en la solicitud.	Cuando el usuario intenta actualizar la información de nivel no accesible.
Error	{0} no se reconoce como {1} definido.	Se utiliza cuando se desconoce el nombre o el valor de la dimensión.
Error	El {0} no puede estar vacío.	El nombre de dimensión está vacío.
Error	La dimensión de lista no se puede utilizar en el nivel.	El usuario intenta asignar un valor de dimensión plana para un nivel.
Error	La dimensión {0} está desactivada para el nivel.	La dimensión está desactivada para este nivel.
Error	El valor de dimensión {0} no es compatible con el valor de dimensión del elemento principal.	Cuando la asignación de dimensión de nivel proporcionada no es compatible con el nivel principal.
Error	{0} no se reconoce como {1} definido.	Se utiliza cuando se desconoce el nombre o el valor del atributo.
Error	El valor de atributo {0} no es compatible con el valor de atributo del elemento principal.	Cuando el valor de atributo de nivel proporcionado del nivel no es compatible con el nivel principal.
Error	El {0} no puede estar vacío.	El nombre de atributo está vacío.
Error	Se ha producido una excepción al procesar la solicitud de API updateLevels.	Error de sistema
Error	El ID {0} no existe.	ID de nivel inexistente proporcionado en la carga útil de la solicitud.
Error	Un {0} no puede tener el mismo ID que su elemento principal.	Los niveles principal y secundario tienen el mismo ID.
Error	{0} no puede ser el elemento secundario de {1}.	Un nivel específico no puede ser secundario de otro nivel específico.
Error	Falta el ID de nivel de raíz.	No se ha proporcionado el ID para el nivel raíz.
Error	El ID de nivel raíz {0} con el nombre de nivel {1} no puede convertirse en un nivel secundario.	El nivel raíz no puede convertirse en un nivel secundario.
Error	La moneda del nivel raíz no se puede cambiar.	La moneda no se puede cambiar para el nivel raíz.
Error	La moneda {0} no es válida.	Nombre de moneda desconocido proporcionado en la etiqueta de nivel.
Error	El nivel {0} está duplicado para los ID {1}.	Se ha proporcionado un nombre de nivel duplicado.
Error	El nivel {0} está duplicado en la carga útil {1} {2}.	Varios niveles nuevos contienen el mismo nombre.
Error	El flujo de trabajo del nivel raíz no se puede cambiar.	El estado InWorkflow no se puede cambiar para el nivel raíz.
Error	La asignación de atributo del nivel {0} no es compatible con el valor de atributo del elemento principal.	El valor de atributo de nivel proporcionado del nivel no es compatible con el nivel principal.
Error	El nivel con ID {0} no existe.	No existe ningún nivel con el ID proporcionado en Planning.
Error	No tiene acceso para actualizar uno o más de los niveles o las versiones especificados en la solicitud.	Falta el permiso de usuario para un nivel mencionado en la carga útil.
Error	La visibilidad de la versión del nivel {0} no es compatible con {0} principal {1}.	La visibilidad de la versión proporcionada del nivel no es compatible con el nivel principal.
Error	El nivel {0} tiene una disponibilidad de cifras reales que contiene más periodos que su principal {1}.	Se ha cambiado el rango de cifras reales del nivel actual. El rango de cifras reales modificado lo hace más pequeño que uno de los rangos de cifras reales de su descendiente.
Error	No puede desactivar el flujo de trabajo para el nivel ({0}) si deleteWorkflowSilently es 0. Si establece deleteWorkFlowSilently en 1, se eliminarán todas las tareas de flujo de trabajo asociadas a este nivel.	Cuando la opción Eliminar flujo de trabajo de forma silenciosa está desactivada, no puede desactivar el flujo de trabajo. Si la opción Eliminar flujo de trabajo de forma silenciosa está activada, se eliminan todas las tareas de flujo de trabajo del nivel.
Error	No se ha podido actualizar la fecha inicial y final de cifras reales para {0} porque el rango de fechas es más pequeño que las fechas iniciales y finales definidas para la versión de cifras reales, y deleteActualsSilently está definido como falso, lo que impide que se eliminen las cifras reales de {1}.	El usuario intenta reducir el rango de cifras reales sin el indicador deleteActualsSilently definido.
Error	El flujo de trabajo no se puede activar para el nivel {0} porque su elemento principal tiene el flujo de trabajo desactivado.	El flujo de trabajo no se puede activar para el nivel porque su elemento principal tiene el flujo de trabajo desactivado.
Error	No se puede activar TradingPartner ni eliminationLevel para el nivel {0} porque su elemento principal tiene tradingPartner activado.	Cuando el socio comercial ya está activado para un elemento principal, sus elementos secundarios no pueden tener activado el socio comercial o el nivel de eliminación.
Error	No existe un elemento principal con ID {0}.	Se ha proporcionado un ID inexistente para un nivel principal.
Error	El nodo principal {0} se está convirtiendo en secundario de su nodo secundario directo/indirecto actual {1}.	Se está creando una relación cíclica entre un elemento principal y uno secundario.
Error	Un nivel no puede ser su propio elemento principal.	Un nivel no puede convertirse en su propio elemento principal en una carga útil.
Error	No existe un nivel con ID {0}.	La entidad proporcionada no existe en Planning.
Error	Eliminación y TradingPartner no pueden ser verdaderos al mismo tiempo.	Un nivel puede ser un nivel de eliminación o un socio comercial, pero no ambos a la vez.
Error	Solo puede modificar Eliminación en este nivel mientras su elemento principal tenga la opción TradingPartner desactivada.	La modificación de la eliminación de un nivel solo puede tener lugar cuando el nivel principal de ese nivel tiene desactivado el socio comercial.
Error	Un subnivel de este nivel es un nivel de eliminación, luego este nivel no puede marcarse como socio comercial.	El nivel actual no se puede marcar como socio comercial porque un nivel por debajo de él es un nivel de eliminación.
Error	No puede activar el flujo de trabajo en este nivel mientras su elemento principal tenga el flujo de trabajo desactivado.	El elemento principal del nivel tiene el flujo de trabajo desactivado.
Error	{0} solo se puede activar de forma conjunta para un nodo y sus descendientes. Para realizar cambios en ellos, defina propagateToDescendants=1.	Para obtener más información sobre el comportamiento de propagateToDescendants, consulte Comportamiento de propagateToDescendants durante las solicitudes UpdateLevels.
Error	No se puede convertir el nivel "{0}" en un nivel de eliminación porque tiene datos en una o varias cuentas interempresa.	Un nivel no puede convertirse en un nivel de eliminación si contiene datos en cuentas interempresa.
Error	actualsStart o actualsEnd no se pueden cambiar para el nivel raíz {0}.	El usuario intenta cambiar el rango de cifras reales para el nivel raíz.
Error	No se pueden añadir elementos secundarios a un nivel vinculado.	El usuario intenta añadir un nivel secundario a un nivel vinculado.
Error	No existe un código de tiempo {0}.	El código de horas proporcionado no existe.
Error	La fecha inicial de cifras reales {0} no puede ser posterior a la fecha final de cifras reales {1}.	La hora de inicio de cifras reales proporcionada es posterior a la hora de finalización. La hora de inicio de las cifras reales debe ser anterior a la hora de finalización.
Error	Código de horas "{0}" no válido. Los códigos de tiempo establecidos para actualsStart y actualsEnd deben coincidir con los estratos más bajos disponibles en Administración de tiempo.	El código de tiempo proporcionado no está en el nivel de estrato más bajo.
Error	Código de horas "{0}" no válido. El valor actualsStart {0} es anterior a actualsStart {1}.	La hora de inicio de cifras reales proporcionada es anterior a la hora de inicio de cifras reales del nivel principal.
Error	Código de horas "{0}" no válido. El valor actualsEnd {0} es posterior a actualsEnd {1}.	La hora de finalización de cifras reales proporcionada va más allá de la hora de finalización de cifras reales del nivel principal.
Error	El valor actualsStart de {0} es anterior al inicio de la versión de Actuals de {1}. actualsStart debe ir después de {1}.	La hora actualsStart proporcionada es anterior a la hora de inicio de la versión de cifras reales.
Error	El valor realsEnd de {0} es posterior al final de la versión de cifras reales de {1}. El valor actualsEnd debe ir antes de {1}.	La hora de finalización de cifras reales proporcionada va más allá de la hora de finalización de la versión de cifras reales.
Error	Valor "{0}" no válido "{1}". El valor debe ser "0" o "1".	El usuario ha proporcionado un valor distinto de "0" o "1" para una propiedad booleana.
Error	{0} {1} no válido.	El usuario ha proporcionado un valor no válido.
Error	{0} NO está permitido como nombre.	La palabra reservada "this", la palabra que termina en "(+)" o "(-)" se ha proporcionado como nombre de nivel.
Error	El ID "{0}" no existe.	La entidad proporcionada no existe en Planning.
Aviso	El nivel {0} no se puede mover a otro nivel principal mientras procedaWithWarnings=0.	El usuario intenta cambiar de nivel sin procederWithWarning="1". procedaWithWarning="1" significa que la visibilidad de la versión, la asignación de atributos y los datos se ajustarán para que coincidan con el nuevo nivel principal.
Aviso	El rango de disponibilidad de cifras reales se ha reducido para el nivel {0}. Los datos de cifras reales excluidos del intervalo se han eliminado.	El rango de disponibilidad de cifras reales se ha reducido. Los datos fuera del rango se eliminan.
Aviso	deleteWorkflowSilently es un indicador global. Debería estar en la etiqueta de niveles.	Eliminar flujo de trabajo de forma silenciosa es un indicador global. Pertenece a la etiqueta de niveles, no a otra etiqueta.
Aviso	deleteActualsSilently es un indicador global. Debería estar en la etiqueta de niveles.	Eliminar cifras reales de forma silenciosa es un indicador global. Pertenece a la etiqueta de niveles, no a otra etiqueta.
Aviso	Los niveles no se pueden modificar porque hay cambios no publicados.	Planning tiene cambios pendientes para la publicación del administrador.

Categoría	Modificación de metadatos
Descripción	Actualice un conjunto de niveles existentes o cree nuevos niveles y sus propiedades. Se pueden actualizar varios niveles con varios valores en una llamada. Si se realiza correctamente, la API devuelve detalles de los niveles que se han actualizado/creado. Si la API falla, se devuelve una lista completa de errores y sus causas.
Permisos obligatorios para invocar	Modelo y permisos en cada nivel
Parámetros obligatorios bajo petición	Credenciales