importDimensionMapping

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

Compatible con API v19 +

Categoría	Envío de metadatos
Descripción	La API importDimensionMapping se puede utilizar para importar valores de dimensión derivados.
Permisos obligatorios para invocar
Parámetros obligatorios bajo petición	Credenciales

La API importDimensionMapping se puede utilizar para importar las condiciones de asignación que determinan los valores de dimensión de asignación que se rellenarán automáticamente en las filas de la hoja modelada. Se puede utilizar para crear, actualizar y eliminar condiciones de asignación. Los valores de dimensión derivados en filas de la hoja modelada no admiten versiones virtuales.

Formato de solicitud

<?xml version='1.0' encoding='UTF-8'?>
<call method="importDimensionMapping" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
  <version name="Budget 2017" id="7"/>
  <dimensions>
        <dimension id="345" name="Area">
            <mappingCriteria>
                <mappingCriterion id="121">
                    <mapTo dimensionValueId="877" dimensionValue="East"/>
                    <dimension name="Level" valueId="1" value="HQ"/>
                    <dimension name="State" valueId="15" value="MA"/>
                </mappingCriterion>
                <mappingCriterion id="122">
                    <mapTo dimensionValueId="876" dimensionValue="West"/>
                    <dimension name="Level" valueId="1" value="HQ"/>
                    <dimension name="State" id="5">
                        <dimensionValue id="900" code="CA"/>
                        <dimensionValue id="901" code="CO"/>
                    </dimension>
                </mappingCriterion>
            </mappingCriteria>
        </dimension>
    </dimensions>
</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 periodo 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 el método de API exportInstances .	MYINSTANCE1
Contenido del elemento
(ninguno)

Elemento de versión
Nombre de etiqueta		versión
Descripción		Especifica la versión para la que se importan las asignaciones.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
Nombre	Obligatorio cuando no se especifica el ID.	El nombre de la versión.	Presupuesto 2017
ID	Obligatorio cuando no se especifica el nombre.	El ID de versión	7
Contenido del elemento
Contiene uno o varios elementos de nivel.

Elemento de dimensiones
Nombre de etiqueta		dimensiones
Descripción		Contenedor de una lista de elementos <dimension>.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
elementos de dimensión

elemento de dimensión
Nombre de etiqueta		dimensión
Descripción		Describe una dimensión para la que queremos importar asignaciones.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Obligatorio cuando no se especifica el ID.	El nombre de la dimensión para importar asignaciones	De áreas
ID	Obligatorio cuando no se especifica el nombre.	El ID de la dimensión para importar asignaciones.	15
Contenido del elemento
Un elemento mappingCriteria

mappingCriteria Element
Nombre de etiqueta		mappingCriteria
Descripción Descripción		Contenedor para una lista de elementos <mappingCriterion>
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	No	Si se proporciona un ID, se actualizará un criterio de asignación existente con este ID. Si no se proporciona ningún ID, se añade un nuevo criterio de asignación a la dimensión.	12
Contenido del elemento
Elementos mappingCriterion para cada valor de dimensión de la dimensión derivada.

Elemento mappingCriterion
Nombre de etiqueta		mappingCriterion
Descripción Descripción		Describe las dimensiones individuales y los valores de dimensión que rigen si se asigna un valor de dimensión. Debe ir seguido de un grupo de etiquetas mapTo , dimension y dimensionValue .
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	No	Si se proporciona un ID, se actualizará un criterio de asignación existente con este ID. Si no se proporciona ningún ID, se añade un nuevo criterio de asignación a la dimensión.	12
eliminar	No	Introduzca "yes" para eliminar todas las condiciones de asignación en mappingCriterion. Un valor vacío o cualquier valor que no sea "sí" se ignora y las condiciones de asignación no se eliminan.	Sí
Contenido del elemento
Contiene un elemento mapTo y hasta seis elementos de dimensión.

mapTo Element
Nombre de etiqueta		mapTo
Descripción		Especifica el valor de dimensión que se deriva en función de los criterios de asignación.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
dimensionValue	Obligatorio cuando no se especifica dimensionValueId.	El nombre del valor de dimensión al que se asigna este criterio de asignación.	De áreas
dimensionValueId	Obligatorio cuando no se especifica dimensionValue.	El nombre del ID de valor de dimensión al que se asigna este criterio de asignación.	12
Contenido del elemento
(ninguno)

elemento de dimensión
Nombre de etiqueta		dimensión
Descripción		Describe una de las dimensiones que se utilizan para derivar el valor de dimensión mapTo . Como mínimo, es obligatorio un elemento de dimensión para la dimensión "Nivel", así como un elemento de dimensión para una dimensión personalizada.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Obligatorio cuando no se especifica el ID.	El nombre de la dimensión	Sector
ID	Obligatorio cuando no se especifica el nombre.	El ID de la dimensión
valor	No	El nombre del valor de dimensión. Obligatorio a menos que haya dimensionValue	Minorista
valueId	No	El ID del valor de dimensión. Este valor es obligatorio a menos que haya elementos dimensionValue.
Contenido del elemento
elementos dimensionValue

dimensionValue Element
Nombre de etiqueta		dimensionValue
Descripción		Si es necesario enumerar más de un valor de dimensión para una etiqueta de dimensión , se puede utilizar una serie de etiquetas dimensionValue en lugar del atributo de valor (opcional).
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre del valor de dimensión	Minorista
código En API v30+, utilice el código en lugar del nombre.	Obligatorio cuando no se especifica el ID.	El código del valor de dimensión	Minorista
ID	Obligatorio cuando no se especifica el código.	El ID del valor de dimensión	25
Contenido del elemento
(ninguno)

Ejemplos:


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <mapTo dimensionValue="East"/>   
            <dimension name="Level" value="HQ"/> 
            <dimension name="State" value="MA"/> 
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Criterio de asignación para asignar los valores de dimensión HQ en la dimensión de nivel y MA en la dimensión de estado al valor de dimensión Este en la dimensión Área. Las filas en las que ambos valores coincidan se aumentarán con Este. Dado que se especifica el atributo de ID, este criterio de asignación sustituirá a un criterio de asignación existente con este ID.


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion id="123">
            <mapTo dimensionValue="East"/>
            <dimension name="Level" value="HQ"/> 
            <dimension name="State" value="MA"/> 
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Criterio de asignación para asignar los valores de dimensión HQ en la dimensión de nivel y CA o CO en la dimensión de estado al valor de dimensión Este en la dimensión Área. Las filas en las que ambos valores coincidan se aumentarán con Este.


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <mapTo dimensionValue="East"/>   
            <dimension name="Level" value="HQ"/> 
            <dimension name="State">         
                <dimensionValue code="CA"/>  
                <dimensionValue code="CO"/>
            </dimension>
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Formato de respuesta

Respuesta de éxito


<?xml version="1.0" encoding="UTF-8"?>
<response success="true"/>

Respuesta de error


<?xml version="1.0" encoding="UTF-8"?>
<response success="false">
    <messages>
        <message>There are duplicate mapping conditions. Make all mappingCriterion conditions unique</message>
    </messages>
</response>

elemento de respuesta
Nombre de etiqueta		respuesta
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
éxito	Sí	Verdadero o falso, que indica si la llamada a la API se ha realizado correctamente o no. Incluso las llamadas correctas pueden contener mensajes de aviso en su respuesta.	verdadero
Contenido del elemento
Un único elemento de mensajes opcional y exactamente un elemento de resultado obligatorio.

Elemento de mensajes
Nombre de etiqueta	mensajes
Descripción	Contenedor para uno o varios elementos de mensaje.
Atributos del elemento
(ninguno)
Contenido del elemento
Uno o varios elementos de mensaje

elemento de mensaje
Nombre de etiqueta		mensaje
Descripción		Representa un mensaje que se envía desde el sistema a la persona que llama. Los mensajes se utilizan para los mensajes de error cuando las solicitudes no se realizan correctamente, para los mensajes de aviso cuando las solicitudes se realizan correctamente y para los mensajes de confirmación cuando se realizan correctamente.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
clave	No	Cuando se proporciona, una clave es una forma de identificar un mensaje o tipo de mensaje concreto, lo que resulta útil para el registro de errores automatizado y la recuperación en los programas cliente. Las claves no cambian en las distintas configuraciones regionales de las solicitudes, aunque cambie el idioma del mensaje. Tampoco es probable que las claves cambien en el futuro debido a ajustes de redacción o cambios de terminología.	ID de valor de atributo no válido
Contenido del elemento
El texto del mensaje. Este texto está en el idioma de la configuración regional especificada en la solicitud (suponiendo que la configuración regional sea compatible). El texto también puede contener información variable, como el número de filas que se han procesado o la columna o el valor concretos que han provocado el error.

exportVersions

importGroups

¿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