updateDimensions

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

Ejemplo de rotación


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

updateDimVal.xml contents


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
     <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" />
   </dimension>
</dimensions>
</call>

Ejemplo de vinculación de un archivo XML



curl -i -X POST -H "Content-Type: multipart/form-data" -F "request=<C:/temp/requestCreateNewDimVal.xml" -F "content=@C:/temp/createNewDimVal.xml" https://api.adaptiveplanning.com/api/v17

requestCreateNewDimVal.xml content



<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
</call>

createNewDimVal.xml



<?xml version='1.0' encoding='UTF-8'?>
<dimensions>
  <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
    <dimensionValue id="" name="Graduate" description="Graduate degree" />
  </dimension>
</dimensions>

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

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
     <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName="" allVersions="0">
         <attribute name="Education Type" value="Tech1" />
         <version name="Budget 2017" available="1" />
     </dimensionValue>
     <dimensionValue id="33" name="Masters" description="Masters degree" shortName="" allVersions="0">
         <attribute name="Education Type" value="Management" />
         <version name="Budget 2017" available="1" />
     </dimensionValue>
     <dimensionValue id="34" name="Phd" description="Phd" shortName="" />
   </dimension>
   <dimension id="16" name="Geography" property1="Latitude" property2="Longitude">            
     <dimensionValue id="521" name="United States" description="USA" shortName="">                
       <dimensionValue id="555" name="Alabama" description="1" shortName="">                    
         <dimensionValue id="579" name="205" description="1" shortName="">                        
           <dimensionValue id="4718" name="35004" description="33" shortName="">                            
             <properties>                                
               <property name="Latitude" value="33.6015" />                                
               <property name="Longitude" value="86.4895" />                            
             </properties>                        
           </dimensionValue>                        
           <dimensionValue id="4719" name="35005" description="" shortName="" />                    
         </dimensionValue>                    
         <properties>                        
           <property name="Latitude" value="" />                        
           <property name="Longitude" value="86.9023" />                    
         </properties>                
       </dimensionValue>            
     </dimensionValue>        
   </dimension>
</dimensions>
</call>

Se aplican las siguientes condiciones a updateDimensions:

Tanto las dimensiones como los valores de dimensión se identifican para su actualización mediante su número de ID interno.

La moneda, una dimensión del sistema, no se puede actualizar a través de la API.

Para crear nuevas dimensiones y valores de dimensión, asígneles una propiedad de ID en blanco o que falte.

En una dimensión existente, puede cambiar un valor de dimensión existente (no nuevo) por un valor de dimensión nuevo. Al hacerlo, se crea el nuevo dimensionValue y se mueve el dimensionValue existente debajo de él como elemento secundario.

Todos los valores de dimensión creados para dimensiones planas están visibles en todas las versiones de plan por defecto. Para especificar la visibilidad, debe mencionarla explícitamente mediante una de las siguientes opciones:

El

allVersions

atributo en el

dimensionValue

etiqueta

O proporcionando un elemento secundario

version

etiquetas bajo

dimensionValue

para proporcionar visibilidad personalizada

updateDimensions solo actualiza la disponibilidad de la versión para las versiones de plan. No puede actualizar la disponibilidad de la versión para las versiones de cifras reales, aunque allVersions=1.

Formato de solicitud para crear un nuevo valor de dimensión

Para crear un nuevo valor de dimensión, incluya su principal por su ID. Por ejemplo, para añadir un nuevo valor secundario debajo de la

Engr

valor que tiene

id 7

, puede utilizar:


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
 <dimensions>
   <dimension id="7">
     <dimensionValue id="" name="Documentation" description="docs" shortName="" >
       <properties>                                
         <property name="OwnerID" value="58371998"/>                                                            
       </properties>        
     </dimensionValue>
   </dimension>
 </dimensions>  
</call>

Este método no cambia nada sobre el valor

id 7

. Crea un nuevo elemento secundario llamado

Docs

para

id 7

. Todos los elementos secundarios no mencionados se mueven al final de la lista de elementos secundarios. Esto es el equivalente a "establecer el elemento principal" para el nuevo valor, pero se logra al incluir ese elemento principal como elemento.

Formato de solicitud para crear un nuevo valor de dimensión con código y nombre

Para crear un nuevo valor de dimensión, incluya su principal por su ID. Por ejemplo, para añadir un nuevo valor secundario debajo del valor Engr con el ID 7, puede usar lo siguiente:

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="Steve C">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions displayNameEnabled="1">
   <dimension id="7">
      <dimensionValue id="" code ="Doc" name="Documentation" description="docs" shortName="">
         <properties>
            <property name="OwnerID" value="58371998" />      
         </properties>
      </dimensionValue>
   </dimension>
</dimensions>
</call>

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

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

La API updateDimensions determina los cambios en la estructura de dimensión y solo se actualizan los valores de dimensión/dimensión nuevos o modificados. El

dimensions

el elemento solo contiene un elemento secundario directo

dimension

o

dimensionValue

elemento

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimension id="16" name="Geography" property1="Latitude" property2="Longitude">
      <dimensionValue id="521" name="United States" description="USA" shortName="">
         <dimensionValue id="555" name="Alabama" description="1" shortName="">
            <dimensionValue id="579" name="205" description="1" shortName="">
               <dimensionValue id="4718" name="35004" description="33" shortName="">
                  <properties>
                     <property name="Latitude" value="33.6015" />
                     <property name="Longitude" value="86.4895" />
                  </properties>
               </dimensionValue>
               <dimensionValue id="4719" name="35005" description="" shortName="" />
            </dimensionValue>
            <properties>
               <property name="Latitude" value="" />
               <property name="Longitude" value="86.9023" />
            </properties>
         </dimensionValue>
      </dimensionValue>
   </dimension>
</dimensions>
</call>

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

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

La API updateDimensions determina los cambios en la estructura de dimensión y solo se actualizan los valores de dimensión/dimensión nuevos o modificados. El

dimensions

el elemento solo contiene un elemento secundario directo

dimensionValue

elemento

Por ejemplo, los cambios se realizan en Alabama:

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimensionValue id="555" name="Alabama" description="1" shortName="">
      <dimensionValue id="579" name="205" description="1" shortName="">
         <dimensionValue id="4718" name="35004" description="33" shortName="">
            <properties>
               <property name="Latitude" value="33.6015" />
               <property name="Longitude" value="86.4895" />
            </properties>
         </dimensionValue>
         <dimensionValue id="4719" name="35005" description="" shortName="" />
      </dimensionValue>
   </dimensionValue>
</dimensions>
</call>

En el caso de las dimensiones planas, debe proporcionar el elemento principal

dimension

etiqueta debajo de

dimensions

seguida de uno o varios valores de dimensión.

dimensions

el elemento solo contiene un elemento secundario directo

dimension

elemento

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimension id="16" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
      <dimensionValue id="521" name="Graduate" shortName="" description="Graduate degree" />
      <dimensionValue id="522" name="Masters" shortName="" description="Masters degree" />
   </dimension>
</dimensions>
</call>

Formato de entrada 3: actualización de un valor de dimensión individual

Este formato admite casos de uso en los que los cambios se limitan a un solo valor de dimensión.

El

dimensions

el elemento solo contiene un elemento secundario directo

dimensionValue

elemento

Utilice únicamente el Formato de entrada 3 al actualizar un valor de dimensión único. El formato de entrada 3 no es el formato preferido para actualizar varios valores de dimensión. No puede crear nuevas dimensiones ni valores de dimensión con este formato. Utilice el Formato de entrada 2 para añadir nuevas dimensiones/valores de dimensión.

<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimensionValue id="555" name="Alabama" description="1" shortName=""/>
</dimensions>
</call>

Gestión de varios cambios de nombre en una sola llamada de updateDimensions

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

updateDimensions

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

updateDimensions

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

updateDimensions

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 dimensiones
Nombre de etiqueta		dimensiones
Descripción		Contiene una o varias dimensiones o valores de dimensión.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
retainExistingOrder Disponible en API v27+	No	RetainExistingOrder="1" indica que la API de updateDimensions 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 de updateDimensions 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 indicador de preserveExistingOrder se ignora cuando Dimension tiene activado el indicador keepSorted. El valor por defecto de retainExistingOrder es "1".	1
displayNameEnabled Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	displayNameEnabled=1 indica que updateDimensions 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 updateDimensions 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 de updateDimensions ignora las propiedades de nombre de visualización. code , displayNameType y description . El valor por defecto de displayNameEnabled es "0".
Contenido del elemento
Contiene una o varias dimensiones o valores de dimensión.

elemento de dimensión
Nombre de etiqueta		dimensión
Descripción		Especifica una dimensión para crear.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El ID de la dimensión que se está actualizando.	34
nombre	No	El nombre de la dimensión. El nombre debe ser exclusivo.	NewDimensionName
código Disponible en API v39+.		El código de la dimensión. El código debe ser exclusivo.	NewDimensionCode
shortName	No	Título visualizable de la columna, tal como se ve en la hoja.	NewDimensionShortName
listDimension	No	"1" significa que se trata de una dimensión de lista, "0" (o no especificado) significa que no lo es.	0
useOnLevels	No	"1" significa que esta dimensión se puede usar en niveles, "0" (o no especificado) significa que no.	0
autoCreate	No	"1" significa que los valores de esta dimensión se pueden crear mediante la importación, "0" (o no especificado) significa que no.	0
keepSorted	No	"1" significa que los valores de esta dimensión siempre se ordenan alfabéticamente, "0" (o no especificado) significa que se pueden ordenar manualmente. Cualquier cambio en los componentes de un nombre de visualización modifica el criterio de ordenación de los elementos, incluso con Mantener ordenado activado.	0
displayNameType Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	Controla la visualización de los valores de dimensión. Los valores posibles son NAME, CODE, NAME_CODE o CODE_NAME. El valor por defecto es NAME cuando se deja en blanco o no se proporciona. Esta propiedad solo está disponible cuando la opción Activar nombre de visualización está activada para la instancia.	"CODE_NAME"
descripción Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	La descripción de la dimensión. Esta propiedad solo está disponible cuando la opción Activar nombre de visualización está activada para la instancia.	"La descripción sobre dim"
propiedad1, propiedad2, ...	No	Las propiedades de la dimensión, si las hay, tal como se han introducido en Administración de dimensiones. Cada dimensión puede tener hasta cinco propiedades.	"Latitude"
Contenido del elemento
Elementos dimensionValue opcionales.

elemento dimensionValue
Nombre de etiqueta		dimensionValue
Descripción		Especifica un valor de dimensión para actualizar.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El ID del valor de dimensión.	34
código Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	El código exclusivo del valor de dimensión.	NewDimensionValue
nombre	Sí	El nombre del valor de dimensión. 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. Caracteres de nueva línea ( ) que se encuentran entre palabras se sustituyen por un solo espacio durante el procesamiento de la carga útil. Los caracteres de nueva línea que se encuentran al principio o al final del nombre también se sustituyen por espacios simples. Estos espacios no aparecen en la interfaz de usuario debido a la reducción de espacios en blanco durante el procesamiento de la carga útil.	NewDimensionValue
shortName	No	El nombre corto del valor de dimensión.	NewDimensionValueShortName
descripción	No	La descripción del valor de dimensión.	Este es un NewDimensionValue
allVersions	No	"1" significa que el valor de dimensión está disponible en todas las versiones de plan, "0" significa que no lo está. Si falta allVersions, el valor por defecto es 1. updateDimensions solo actualiza la disponibilidad de la versión para las versiones de plan. No puede actualizar la disponibilidad de la versión para las versiones de cifras reales, aunque allVersions=1. Para indicar la disponibilidad de una versión específica, defina allVersions como 0 y proporcione la disponibilidad del valor de dimensión para cada versión. Ejemplo: suponiendo que hay versiones 2018a, 2018b, 2018c, 2018d Para incluir un valor de dimensión solo en la versión 2018b: <dimensionValue .... allVersions="0"> <version name="2018a" available="0"> <version name="2018c" available="0"> <version name="2018d" available="0" > En el ejemplo anterior, si allVersions="1", se ignoran los elementos de la versión secundaria que se encuentran debajo.	0
Contenido del elemento
Puede contener el elemento de propiedades opcional.

elemento de atributo
Nombre de etiqueta		atributo
Descripción		Contenedor para un elemento de atributo de dimensión. Requiere un nombre y un valor de atributo preexistentes.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre del atributo de dimensión	Ubicación
valor actualizado en API v34	Sí	El valor del atributo de dimensión. Si la importación de dimensión crea automáticamente valores de atributo está activada en la interfaz de usuario del administrador de atributos de dimensión, cualquier valor de atributo que aún no exista se convierte en un nuevo valor de atributo en la dimensión raíz. 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 dimensión crea automáticamente valores de atributo está activada en la interfaz de usuario del administrador 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.	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. 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 nombre de un valor de atributo recién creado automáticamente. El atributo 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 versión
Nombre de etiqueta		versión
Descripción		Especifica la disponibilidad de la versión de plan de un valor de dimensión. Requiere una versión de plan preexistente. La disponibilidad de la versión no se puede cambiar para las versiones virtuales, ocultas, reales, bloqueadas o archivadas.
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
disponible	Sí	Si es 1, este valor de dimensión está disponible en esta versión.	1
Contenido del elemento
Uno o varios elementos de versión para cada valor de dimensión.

elemento de propiedades Compatible con API v22
Nombre de etiqueta	propiedades
Descripción	Elemento opcional que contiene elementos de propiedad.
Atributos del elemento
(ninguno)
Contenido del elemento
Contiene hasta cinco elementos de propiedad.

elemento de propiedad Compatible con API v22
Nombre de etiqueta		propiedad
Descripción		Especifica una propiedad personalizada para actualizar. Los valores de los elementos de propiedad solo pueden contener caracteres numéricos.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre de la propiedad.	Latitud
valor	Sí	El valor de la propiedad. Un valor vacío borrará el valor de propiedad del valor de dimensión.	33,6015
Contenido del elemento
(ninguno)

Formato de respuesta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
 <message type="INFO">Dimension was saved successfully.</message>
</messages>
<output>
 <dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" status="">
     <dimensionValue id="44" name="Documentation" description="docs" shortName="" status="created">
     </dimensionValue>
   </dimension>
   <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" property1="Latitude" property2="Longitude" status="">                
     <dimensionValue id="521" name="United States" shortName="" description="USA" status="">                    
       <dimensionValue id="555" name="Alabama" shortName="" description="1" status="">                        
         <dimensionValue id="579" name="205" shortName="" description="1" status="">                            
           <dimensionValue id="4718" name="35004" shortName="" description="33" status="">                                
             <properties>                                    
               <property name="Latitude" value="33.6015" status="created" />                                    
               <property name="Longitude" value="86.4895" status="" />                                
             </properties>                            
           </dimensionValue>                            
           <dimensionValue id="4719" name="35005" shortName="" description="" status="" />                        
         </dimensionValue>                        
         <properties>                            
           <property name="Latitude" value="" status="deleted" />                            
           <property name="Longitude" value="86.9023" status="updated" />                        
         </properties>                    
       </dimensionValue>                
     </dimensionValue>            
   </dimension>
 </dimensions>
</output>
</response>

elemento de dimensiones
Nombre de etiqueta			dimensiones
Descripción			Contiene una o varias dimensiones o valores de dimensión.
Atributos del elemento
(ninguno)
Contenido del elemento
Contiene una o varias dimensiones o valores de dimensión.
retainExistingOrder	No	Si es 0, la API de updateDimensions debe actualizar el criterio de ordenación en función del contenido de la carga útil XML. Si es 1, la API de updateDimensions 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.		displayNameEnabled=1 indica que updateDimensions 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 de updateDimensions debe continuar siguiendo el contrato de API anterior a 2021.42 aunque la opción Activar nombre de visualización esté activada para la instancia. La API de updateDimensions ignora las propiedades de nombre de visualización. code , displayNameType y description . La compatibilidad con displayNameEnabled comenzará en 2021.42. El valor por defecto de displayNameEnabled es "0".	1

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 exportDimensions.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Para crear, se proporcionará el nuevo ID.	16
nombre	Sí	El nombre de la dimensión, tal como aparece en informes y hojas.	Cliente
código Disponible en API v39+.	No	El código de la dimensión.	Cliente
shortName	No	El nombre corto de la dimensión, si lo hay, tal como se ha introducido en Administración de dimensiones	cliente
autoCreate	Sí	1 si la dimensión seleccionada tiene definido el campo "La importación de datos crea automáticamente valores de dimensión"; 0 en caso contrario.	0
listDimension	Sí	1 si la dimensión seleccionada es una dimensión de lista; 0 en caso contrario.	1
keepSorted	Sí	1 si la dimensión seleccionada se mantiene ordenada, 0 en caso contrario.	1
useOnLevels	Sí	1 si la dimensión seleccionada se puede utilizar en niveles; 0 en caso contrario.	1
displayNameType Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	Controla la visualización de los valores de dimensión. Los valores posibles son NAME, CODE, NAME_CODE o CODE_NAME. El valor por defecto es NAME cuando se deja en blanco o no se proporciona. Esta propiedad solo está disponible cuando la opción Activar nombre de visualización está activada para la instancia.	CODE_NAME
descripción Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	La descripción de la dimensión.
property1,propert2,...	No	Las propiedades personalizadas de la dimensión.
Contenido del elemento
Cero o más elementos dimensionValue. Cada elemento dimensionValue incluido representa un "valor de dimensión raíz" en la dimensión, un valor que no tiene ningún valor principal.

elemento dimensionValue
Nombre de etiqueta		dimensionValue
Descripción		Representa un valor de miembro único de una dimensión personalizada que se devuelve en la respuesta a una llamada a la API exportDimensions.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	Para crear, se proporcionará el nuevo ID.	16
código Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	No	El código exclusivo del valor de dimensión.	Empresa A
nombre	Sí	La etiqueta del valor de miembro de la dimensión, tal como se muestra en los informes y se utiliza en las fórmulas.	Empresa A
shortName	No	El nombre corto del valor de dimensión, si lo hay, tal como se ha introducido en Administración de dimensiones	A
descripción	No	La descripción del valor de dimensión, si lo hay, tal como se ha introducido en Administración de dimensiones	Corporación A
estado	Sí	El estado del valor de dimensió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
mensaje	No	El mensaje de error de una entrada de dimensionValue no válida.	El nombre de dimensión ProductsFirst01234567890123456... no puede tener más de 64 caracteres.
Contenido del elemento
Cero o más elementos dimensionValue opcionales. Cada elemento dimensionValue incluido representa un "valor de dimensión secundario" de este valor de dimensión, cuyos miembros se agrupan implícitamente en este valor.

elemento de atributo
Nombre de etiqueta		atributo
Descripción		Contenedor para un elemento de atributo de dimensión.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre del atributo de dimensión	Ubicación
valor actualizado en API v32	Sí	El valor del atributo de dimensión. Para API v32 y posteriores, este atributo solo es significativo cuando la configuración de Nombre de visualización está desactivada para la instancia.	San Francisco
valueCode Solo está disponible en API v32+ para instancias que activan el nombre de visualización.	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+ para instancias que activan el nombre de visualización.	No	El nombre de un valor de atributo recién creado automáticamente. El atributo 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 valor de dimensió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
mensaje	No	El mensaje de error de una entrada de atributo no válida.
Contenido del elemento
(ninguno)

elemento de versión
Nombre de etiqueta		versión
Descripción		Especifica la disponibilidad de la versión de plan de un valor de dimensión.
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
disponible	Sí	Si es 1, este valor de dimensión está disponible en esta versión de plan.	1
estado	Sí	El estado del valor de dimensió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
mensaje	No	El mensaje de error de una entrada de versión no válida.
Contenido del elemento
Uno o varios elementos de versión para cada valor de dimensión.

elemento de propiedades
Nombre de etiqueta	propiedades
Descripción	Contiene hasta cinco elementos de propiedad.
Atributos del elemento
(ninguno)
Contenido del elemento
Contiene hasta cinco elementos de propiedad.

elemento de propiedad
Nombre de etiqueta		propiedad
Descripción		Especifica una propiedad personalizada para actualizar.
Atributos del elemento
Nombre de atributo	Valor		Ejemplo
nombre	El nombre de la propiedad.		Latitud
valor	El valor de la propiedad. Un valor vacío borrará el valor de propiedad del valor de dimensión.		33,6015
Estado	El estado de la propiedad después de la actualización. En el caso de error, el elemento de mensaje incluye el contenido del mensaje de error. El estado actualizado no devuelve ningún contenido de mensaje. Error: se ha encontrado un error en la entidad. Creado: la entidad se ha creado correctamente. Actualizado: la entidad se ha actualizado correctamente. Nada ha cambiado: un estado vacío significa que no se ha cambiado nada en la entidad.
Mensaje	El mensaje de error de una entrada de propiedad no válida.		La etiqueta de propiedad requiere un atributo de nombre.

Categoría	Modificación de metadatos
Descripción	Actualice un conjunto de dimensiones existentes y sus valores de dimensión. Se pueden actualizar varias dimensiones y varios valores en una llamada. Si se realiza correctamente, la API devuelve los detalles de las dimensiones que se acaban de actualizar.
Permisos obligatorios para invocar	Modelo y permisos en cada dimensión
Parámetros obligatorios bajo petición	Credenciales