createDimensionValue

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

No se admite en API v20 +. Utilice updateDimensions.

Categoría	Modificación de metadatos
Descripción	Cree un valor de dimensión. Si se realiza correctamente, la API devuelve los detalles de la dimensión y todos los valores de dimensión, incluido el que se acaba de crear.
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. Este método devuelve un error si hay cambios no publicados.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="createDimensionValue" callerName="fred">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensionValue
dimensionId="10"
name="New Dimension Value">
<attributes>
<attribute attributeId="20" valueId="170" />
</attributes>
</dimensionValue>
</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)

dimensionValue element
Nombre de etiqueta	dimensionValue
Descripción	Especifica un valor de dimensión para crear.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
dimensionId	Sí	El ID de la dimensión. Debe especificarse dimensionId o parentId.	34
parentId	No	El ID del valor de dimensión principal. Debe especificarse dimensionId o parentId.	220
nombre	Sí	El nombre del valor de dimensión.	NewDimensionValue
shortName	No	La descripción del valor de dimensión.	NewDimensionValue - ShortName
descripción	No	La descripción del valor de dimensión.	Este es un NewDimensionValue
Contenido del elemento
(ninguno)

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
Contenido del elemento
Uno o varios elementos de atributo

elemento de atributos
Nombre de etiqueta	atributo
Descripción	Contenedor para uno o varios elementos 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
valueID	Sí	El ID exclusivo del valor de atributo de dimensión generado por el sistema. Si este valor es 0, este atributo se elimina de la cuenta.	170
Contenido del elemento
(ninguno)

Formato de respuesta

Estos son ejemplos de respuestas para la creación correcta y no correcta de un valor de dimensión.

Ejemplo de éxito


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
<dimensions>
<dimension id="6" name="Department" shortName="" autoCreate="0" listDimension="0" keepSorted="0"
useOnLevels="1">
<dimensionValue id="7" name="Engr" description="Engineering" shortName="">
<dimensionValue id="52" name="QA" description="Quality Assurance" shortName="" />
<dimensionValue id="53" name="Dev" description="Development" shortName="" /></dimensionValue>
</dimension>
<dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0"
useOnLevels="0">
<dimensionValue id="32" name="Graduate" description="Graduate degree" shortName="">
<attributes>
<attribute attributeId="21" name="Education Type" valueId="197" value="Tech1" />
</attributes>
</dimensionValue>
<dimensionValue id="33" name="Masters" description="Masters degree" shortName="">
<attributes>
<attribute attributeId="21" name="Education Type" valueId="196" value="Management" />
</attributes>
</dimensionValue>
<dimensionValue id="34" name="Phd" description="Phd" shortName="" />
</dimension>
</dimensions>
</output> 
</response>

Ejemplo de error


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
<messages>
<message type="ERROR" key="invalid-attributevalueid" values="-50">Invalid attribute value id: "-50"</message>
</messages>
</response>

Las dimensiones se ordenan por nombre.

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 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	descripció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 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.	Techl
Contenido del elemento
(ninguno)

createDimension

createLevel

¿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