exportDimensionMapping

Adaptive Planning

Documentación de Workday Adaptive Planning (Workday 2025R2)

Supported in API v19 +

Category	Metadata retrieval
Description	Exports the derived dimension mapping criteria for one or more dimensions in a given version.
Permissions Required To Invoke
Parameters Required On Request	Credentials

This API is used to retrieve a list of mapping criteria for one or more derived dimensions. For each dimension in the request it will retrieve the mapTo values and dimension value conditions.

Request Format


<?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>

credentials Element
Tag Name		credentials
Description		All API calls must contain a single credentials element to identify the user invoking the API. The API call is then performed as this user (any audit trail or history of actions in the system will show that this user performed the action), and therefore the user must have the required permissions to perform the action in order for the API call to succeed.
Attributes of the Element
Attribute Name	Required?	Value	Example
login	Y	The login name of the user invoking the API method. This user must have the required permissions to invoke the method.	sampleuser@company.com
password	Y	The password of the user invoking the API method.	my_password
locale	N	Specify the locale to be used to interpret incoming numbers and dates, and to format outgoing numbers and dates (using the proper thousands separator, time period names, and date formatting). The locale is also used to specify the language in which any system messages in the response should appear. If not specified, en_US (American English) is used.	fr_FR
instanceCode	N	If the user specified in the credentials has access to more than one instance of Adaptive Planning , this attribute can be used to specify that the user is intending to access an instance other than their default instance. If not specified, the user's default instance will be used. To determine the available instance codes, use the xref API method.	MYINSTANCE1
Contents of the Element
(none)

version Element
Tag Name		version
Description		Specifies which version to retrieve the modeled rows from.
Attributes of the Element
Attribute Name	Required?	Value	Example
Name	Y	The name of the version.	Budget 2017
Contents of the Element
(none)

dimensions element
Tag Name		dimensions
Description		Container for a list of <dimension> elements.
Attributes of the Element
Attribute Name	Required?	Value	Example
(none)
Contents of the Element
dimension elements

dimension Element
Tag Name		dimension
Description		Describes a dimension for which we want to import mappings.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	The name of the dimension for which to import mappings	Area
Contents of the Element
A mappingCriteria element.

filters Element
Tag Name		filters
Description		Holds the specification for the filters which determine which data from the requested version and dimension(s) is retrieved by the API. This element specifies the keyword, levels and dimension values which the corresponding mapping criterion entries contain will be retrieved.
Attributes of the Element
Attribute Name	Required?	Value	Example
(none)
Contents of the Element
A single optional keyword element, a single optional levels element, and an optional single dimensionValues element.

levels Element
Tag Name		levels
Description		Container for zero or one level elements.
Attributes of the Element
Attribute Name	Required?	Value	Example
(none)
Contents of the Element
Zero or one level element

level Element
Tag Name		level
Description		Specifies an organization level to have its data exported in this API call.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	The name of the level to be exported. This name is as specified in Organization Administration.	Development
code In API v30+ use code instead of name.	Required when id is not specified.	The code of the level to be exported. This code is as specified in Organization Administration.	Development
id	Required when code is not specified.	The internal system ID number of the level to be exported.	8
includeDescendants	Y	Indicates whether the export should include all descendants of the specified level or not. If set to true, all children of this level will also be exported, as will their children, etc. If set to false, this level will be exported alone.	True
Contents of Element
(none)

dimensionValues Element
Tag Name		dimensionValues
Description		Container for zero or more dimensionValue elements.
Attributes of the Element
Attribute Name	Required?	Value	Example
(none)
Contents of Element
Zero or more dimensionValue elements.

dimensionValue Element
Tag Name		dimensionValue
Description		Indicates that the exported data should contain only the mapping criterion entries which contain the matching specified dimensionValue. If more than one dimensionValue element is within the dimensionValues element, then the exported mapping criterion entries must contain all specified dimension/values. For example, if a request specifies dimension values of Region=East, and Product=Product_A, then mapping criterion must have Region contain East and Product contains Product_A in order to be exported. Also note that each dimensionValue within the dimensionValues element must belong to different dimension. For example, a request with dimension values of Region=East and Region=West won't be accepted. In the case when the input filtering dimensions do not belong to any of the requested dimensions, they will be ignored.
Attributes of the Element
Attribute Name	Required?	Value	Example
dimName	required when uncategorizedOfDimension is not specified	The name of the dimension to which the dimension value (see name attribute below) belongs.	Region
name	N	The name of the dimension value to be exported.	US West
code Only available in API v30+ for instances that enable display name.	Required when id is not specified	The code of the dimension value to be exported.	US West
uncategorized	N	If set to true, exported data will contain the mapping criterion with only the matching dimension value and not the values of any of its descendant values (if any). Has no effect on dimension values with no children. If not specified, defaults to false.	true
dimId	required when dimName is not specified.	The internal system ID number of the dimension to which the dimension value (see name attribute above) belongs.	15
uncategorizedOfDimension	N	Specify the uncategorizedOfDimension in place of the dimName/uncategorized attributes. If specified the value of the attribute should be an internal system ID number of a dimension (not a dimension value) and the filter is specifying that data must be completely uncategorized in this dimension in order to match the filter. The uncategorized attributes will be ignored and assumed to be true. Ignored if dimName is specified.	15
id	Required when code is not specified	Specify the id in place of the name attributes. The internal system ID number of the dimension value to be exported. Should be specified in place of the name attributes to specify the dimension value. To determine internal IDs, see the exportDimensions API. Ignored if name is specified.	14
Contents of Element
(none)

Response Format


<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>

response Element
Tag Name		response
Attributes of the Element
Attribute Name	Required?	Value	Example
success	Y	Either true or false, indicating whether the API call was successful or not. Even successful calls may contain warning messages in their response.	true
Contents of the Element
A single optional messages element, and exactly one required output element.

dimensions Element
Tag Name		dimensions
Description		Container for a list of <dimension> elements.
Attributes of the Element
Attribute Name	Required?	Value	Example
(none)
Contents of the Element
dimension elements

dimension Element
Tag Name		dimension
Description		Describes a dimension for which we want to import mappings.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	The name of the dimension for which to import mappings	Area
Contents of the Element
A mappingCriteria element.

mappingCriteria Element
Tag Name		mappingCriteria
Description Description		Container for a list of <mappingCriterion> elements
Attributes of the Element
Attribute Name	Required?	Value	Example
id	N	If a id is provided, an existing mapping criterion with this id will be updated. If no id is provided, a new mapping criterion is added to the dimension.	12
Contents of the Element
mappingCriterion elements for each dimension value for the derived dimension.

mappingCriterion Element
Tag Name		mappingCriterion
Description Description		Describes the individual dimensions and dimension values that govern if a dimension value is being mapped to. Must be followed by a group of mapTo , dimension and dimensionValue tags.
Attributes of the Element
Attribute Name	Required?	Value	Example
id	N	If a id is provided, an existing mapping criterion with this id will be updated. If no id is provided, a new mapping criterion is added to the dimension.	12
Contents of the Element
Contains one mapTo element and up to six dimension elements.

mapTo Element
Tag Name		mapTo
Description		Specifies the dimension value that is derived based on the mapping criteria.
Attributes of the Element
Attribute Name	Required?	Value	Example
dimensionValueId	Y	The id of the dimension value to which this mapping criterion maps.	11
dimensionValue	Y	The name of the dimension value this mapping criterion maps to.	California
dimensionValueCode	Y	The code of the dimension value to which this mapping criterion maps.	CA
dimensionValueDisplayName	Y	The display name of the dimension value to which this mapping criterion maps.	California
Contents of the Element
(none)

dimension Element
Tag Name		dimension
Description		Describes one of the dimensions being used to derive the mapTo dimension value.
Attributes of the Element
Attribute Name	Required?	Value	Example
name	Y	The name of the dimension	Area
ValueId	N	The id of the dimension value. Required unless there are dimensionValue elements.	282
value	N	The name of the dimension value. Required unless there are dimensionValue elements	West
valueCode	N	The code of the dimension value. Required unless there are dimensionValue elements.	We
valueDisplayName	N	The display name of the dimension value. Required unless there are dimensionValue elements.	West
Contents of the Element
(none)

dimensionValue Element
Tag Name		dimensionValue
Description		(Optional) If more than one dimension value needs to be listed for a dimension tag, a series of dimensionValue tags can be used instead of the name attribute.
Attributes of the Element
Attribute Name	Required?	Value	Example
id	Y	The id of the dimension value	10
name	Y	The name of the dimension value	Colorado
code	Y	The code of the dimension value	CO
displayName	Y	The display name of the dimension value	Colorado
Contents of the Element
(none)

messages element
Tag Name	messages
Description	Container for one or more message elements.
Attributes of the Element
(none)
Contents of the Element
One or more message elements.

message element
Tag Name		message
Description		Represents a message being sent from the system back to the caller. Messages are used for error messages when requests do not succeed, for warning messages when requests do succeed, and for confirmation messages upon success.
Attributes of the Element
Attribute Name	Required?	Value	Example
key	N	When given, a key is a way to identify a particular message or type of message, useful for purposes of automated error logging and recovery in client programs. Keys do not change under different locales of requests, even when the language of the message changes. Keys also are unlikely to change in the future due to wording adjustments or terminology changes.	invalid-attributevalueid
Contents of the Element
The text of the message. This text is in the language of the locale specified on the request (assuming that locale is supported). The text may also contain variable information such as the number of rows which were processed, or the particular column or value which caused an error.

¿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