updateDimension

No se admite en API v20 +. Utilice updateDimensions.

Categoría	Modificación de metadatos
Descripción	Actualice una dimensión. Si se realiza correctamente, la API devuelve los detalles de la dimensión que se acaba de actualizar.
Permisos obligatorios para invocar	Informes modelo
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. El usuario debe tener permiso de modelo para crear la dimensión.

Se aplican las siguientes condiciones a esta API:

Este método devuelve un error si hay cambios no publicados.

No puede desactivar listDimension si tiene atributos de dimensión definidos o si los valores no están disponibles en todas las versiones.

No puede desactivar listDimension si tiene valores de dimensión jerárquicos.

No puede activar tanto useOnLevels como listDimension. (Es posible desactivar una y activar la otra en el mismo comando).

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimension" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <dimension id="34"
       name="Updated Dimension Name"
     />
</call>

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

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
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
creación automática	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.	0
Contenido del elemento
(ninguno)

Formato de respuesta


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <output>
       <dimensions>
           <dimension id="41" name="New Dimension Name" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0">
           </dimension>
       </dimensions>
   </output>
</response>

elemento de dimensiones
Nombre de etiqueta	dimensiones
Descripción	Contenedor para uno o varios elementos de dimensión.
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos 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 exportDimensions.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El número de ID de sistema interno para la dimensión. Esto se puede utilizar para identificar dimensiones en otras llamadas a la API, como exportDimensionFamilies.	16
nombre	Sí	El nombre de la dimensión, tal como aparece en informes y hojas.	Cliente
shortName	No	El nombre corto de la dimensión, si lo hay, tal como se ha introducido en Administración de dimensiones	cliente
creación automática	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
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.

dimensionValue element
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í	El número de ID de sistema interno para este valor de miembro de la dimensión.	34
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
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 atributos
Nombre de etiqueta		atributos
Descripción		Contenedor para uno o varios elementos de atributo de dimensión.
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		Contenedor para un elemento de atributo de dimensión.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
attributeID	Sí	El ID del atributo de dimensión generado por el sistema.	20
nombre	Sí	El nombre del atributo de dimensión	Tipo de estudios
valueID	Sí	El ID exclusivo del valor de atributo de dimensión generado por el sistema.	170
valor	Sí	El valor del atributo de dimensión.	Tech1
Contenido del elemento
(ninguno)