exportDimensionMapping

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	Metadata retrieval
Descripción	Exporta los criterios de asignación de dimensiones derivadas para una o varias dimensiones de una versión determinada.
Permisos obligatorios para invocar
Parámetros obligatorios bajo petición	Credenciales

Esta API se utiliza para recuperar una lista de criterios de asignación para una o varias dimensiones derivadas. Para cada dimensión de la solicitud, recuperará los valores de mapTo y las condiciones de valor de dimensión.

Formato de solicitud


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensionMapping" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
  <dimensions>
    <dimension name="Area">                       
    </dimension>
  </dimensions>
  <version name = "Budget 2017"/>
  <filters>
    <keyword value="Alameda" />
    <levels>
      <level code="HQ" includeDescendants="true" />
    </levels>
    <dimensionValues>
      <dimensionValue dimName="Geography" code="California" />
      <dimensionValue dimId="34" uncategorized="true" />
      <dimensionValue dimName="Region" code="Bay Area" uncategorized="true" />
      <dimensionValue dimId="19" id="78" />
    </dimensionValues>
    <attributes>
      <attribute id="1" uncategorized="true"/>
      <attribute name="attributeName1" value="attributeValue1"/>
      <attribute id="3" valueId="31" uncategorized="true"/>
    </attributes>
  </filters>
</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 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 el método API de referencia externa.	MYINSTANCE1
Contenido del elemento
(ninguno)

Elemento de versión
Nombre de etiqueta		versión
Descripción		Especifica de qué versión se recuperan las filas modeladas.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
Nombre	Sí	El nombre de la versión.	Presupuesto 2017
Contenido del elemento
(ninguno)

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	Sí	El nombre de la dimensión para la que se van a importar las asignaciones	De áreas
Contenido del elemento
Un elemento mappingCriteria

Elemento de filtros
Nombre de etiqueta		filtros
Descripción		Contiene la especificación de los filtros que determinan qué datos de la versión y las dimensiones solicitadas recupera la API. Este elemento especifica la palabra clave, los niveles y los valores de dimensión que se recuperarán en las entradas de criterio de asignación correspondientes.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Un solo elemento de palabra clave opcional, un solo elemento de niveles opcionales y un solo elemento dimensionValues opcional.

Elemento de niveles
Nombre de etiqueta		niveles
Descripción		Contenedor para elementos de un nivel o cero.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido del elemento
Elemento de nivel cero o uno

Elemento de nivel
Nombre de etiqueta		nivel
Descripción		Especifica un nivel de organización para exportar sus datos en esta llamada a la API.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre del nivel que se va a exportar. Este nombre es el especificado en Administración de organización.	Desarrollo
código En API v30+, utilice el código en lugar del nombre.	Obligatorio cuando no se especifica el ID.	El código del nivel que se va a exportar. Este código es el especificado en Administración de organización.	Desarrollo
ID	Obligatorio cuando no se especifica el código.	El número de ID de sistema interno del nivel que se va a exportar.	8
includeDescendants	Sí	Indica si la exportación debe incluir o no a todos los descendientes del nivel especificado. Si se establece en verdadero, también se exportarán todos los elementos secundarios de este nivel, al igual que sus elementos secundarios, etc. Si se establece en falso, este nivel se exportará solo.	Verdadero
Contenido de elemento
(ninguno)

dimensionValues Element
Nombre de etiqueta		dimensionValues
Descripción		Contenedor para cero o más elementos dimensionValue .
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
(ninguno)
Contenido de elemento
Cero o más elementos dimensionValue .

dimensionValue Element
Nombre de etiqueta		dimensionValue
Descripción		Indica que los datos exportados solo deben contener las entradas de criterios de asignación que contengan el valor de dimensiónValue especificado coincidente. Si hay más de un elemento dimensionValue en el elemento dimensionValues, las entradas de criterios de asignación exportadas deben contener todas las dimensiones o valores especificados. Por ejemplo, si una solicitud especifica los valores de dimensión Region=East y Product=Product_A, el criterio de asignación debe tener Región que contenga Este y Producto que contenga Producto_A para poder exportarse. Tenga en cuenta también que cada dimensionValue del elemento dimensionValues debe pertenecer a una dimensión diferente. Por ejemplo, no se aceptará una solicitud con valores de dimensión Region=East y Region=West. En el caso de que las dimensiones de filtrado de entrada no pertenezcan a ninguna de las dimensiones solicitadas, se ignorarán.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
dimName	obligatorio cuando no se especifica uncategorizedOfDimension	El nombre de la dimensión a la que pertenece el valor de dimensión (consulte el atributo de nombre a continuación).	Región
nombre	No	El nombre del valor de dimensión que se va a exportar.	Oeste de EE. UU.
código Solo está disponible en API v30+ para instancias que activan el nombre de visualización.	Obligatorio cuando no se especifica el ID	El código del valor de dimensión que se va a exportar.	Oeste de EE. UU.
sin categorizar	No	Si se establece en verdadero, los datos exportados contendrán el criterio de asignación solo con el valor de dimensión coincidente y no con los valores de ninguno de sus valores descendientes (si los hay). No afecta a los valores de dimensión sin elementos secundarios. Si no se especifica, el valor por defecto es falso.	verdadero
dimId	obligatorio cuando no se especifica dimName.	El número de ID de sistema interno de la dimensión a la que pertenece el valor de dimensión (consulte el atributo de nombre anterior).	15
uncategorizedOfDimension	No	Especifique uncategorizedOfDimension en lugar de los atributos dimName/uncategorized . Si se especifica, el valor del atributo debe ser un número de ID de sistema interno de una dimensión (no un valor de dimensión) y el filtro especifica que los datos deben estar completamente sin categorizar en esta dimensión para que coincidan con el filtro. Los atributos sin categorizar se ignorarán y se asumirá que son verdaderos. Se ignora si se especifica dimName.	15
ID	Obligatorio cuando no se especifica el código	Especifique el ID en lugar de los atributos de nombre . El número de ID de sistema interno del valor de dimensión que se va a exportar. Debe especificarse en lugar de los atributos de nombre para especificar el valor de dimensión. Para determinar los ID internos, consulte la API exportDimensions . Se ignora si se especifica el nombre.	14
Contenido de elemento
(ninguno)

Formato de respuesta


<response success="true">
 <output>
        <mappings>
            <version name="Budget 2017"/>
            <dimensions>
                <dimension name="Area">
                    <mappingCriteria>
                        <mappingCriterion id="121">
                            <mapTo dimensionValue="East"/>
                            <dimension name="Level" value="HQ"/>
                            <dimension name="State" value="MA"/>
                        </mappingCriterion>
                        <mappingCriterion id="122">
                            <mapTo dimensionValue="West"/>
                            <dimension name="Level" value="HQ"/>
                            <dimension name="State">
                                <dimensionValue name="CO"/>
                                <dimensionValue name="CA"/>
                            </dimension>
                        </mappingCriterion>
                    </mappingCriteria>
                </dimension>
            <dimensions/>
        </mappings>
    </output>
</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 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	Sí	El nombre de la dimensión para la que se van a importar las asignaciones	De áreas
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
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
dimensionValueId	Sí	El ID del valor de dimensión al que se asigna este criterio de asignación.	11
dimensionValue	Sí	El nombre del valor de dimensión al que se asigna este criterio de asignación.	California
dimensionValueCode	Sí	El código del valor de dimensión al que se asigna este criterio de asignación.	CA
dimensionValueDisplayName	Sí	El nombre de visualización del valor de dimensión al que se asigna este criterio de asignación.	California
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.
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
nombre	Sí	El nombre de la dimensión	De áreas
ValueId	No	El ID del valor de dimensión. Obligatorio a menos que haya elementos dimensionValue.	282
valor	No	El nombre del valor de dimensión. Obligatorio a menos que haya elementos dimensionValue	West
valueCode	No	El código del valor de dimensión. Obligatorio a menos que haya elementos dimensionValue.	Nosotros
valueDisplayName	No	El nombre de visualización del valor de dimensión. Obligatorio a menos que haya elementos dimensionValue.	West
Contenido del elemento
(ninguno)

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 nombre (opcional).
Atributos del elemento
Nombre de atributo	¿Obligatorio?	Valor	Ejemplo
ID	Sí	El ID del valor de dimensión	10
nombre	Sí	El nombre del valor de dimensión	Colorado
código	Sí	El código del valor de dimensión	CO
displayName	Sí	El nombre de visualización del valor de dimensión	Colorado
Contenido del elemento
(ninguno)

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.

exportLocales

exportModeledSheet

¿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