updateDimension
Not supported in API v20 +. Use updateDimensions.
Category | Metadata modification |
Description | Update a dimension. If successful, the API returns details for the dimension that has just been updated. |
Permissions Required To Invoke | Model |
Parameters Required On Request | Credentials |
This method's request contains a credentials tag to identify and authorize the calling user. User must have Model permission to create the dimension.
The following conditions apply to this API:
- This method returns an error if there are unpublished changes.
- You cannot turn off listDimension if you have dimension attributes defined or values aren't all available in all versions.
- You cannot turn off listDimension if you have hierarchical dimensionValues.
- You cannot enable both useOnLevels and listDimension. (It is possible to turn one off and the other on in the same command.)
Request Format
<?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>
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, month 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 exportInstances API. | MYINSTANCE1 |
Contents of the Element | |||
(none) | |||
dimension element | |||
Tag Name | dimension | ||
Description | Specifies a dimension to create. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
id | Y | The id of the dimension being updated. | 34 |
name | N | The name of the dimension. The name must be unique.
| NewDimensionName |
shortName | N | Displayable title of the column, as seen on the sheet.
| NewDimensionShortName |
listDimension | N | "1" means this is a list dimension, "0" (or not specified) means it isn't. | 0 |
useOnLevels | N | "1" means this dimension can be used on levels, "0" (or not specified) means it can't. | 0 |
autoCreate | N | "1" means values for this dimension can be created via the import, "0" (or not specified) means they can't. | 0 |
keepSorted | N | "1" means values for this dimension are always sorted alphabetically, "0" (or not specified) means they can be manually ordered. | 0 |
Contents of the Element | |||
(none) | |||
Response Format
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <dimensions displayNameEnabled="1"> <dimension id="41" name="New Dimension Name" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0"> </dimension> </dimensions> </output> </response>
dimensions element | |
Tag Name | dimensions |
Description | Container for one or more dimension elements. |
Attributes of the Element | |
(none) | |
Contents of the Element | |
One or more dimension elements. | |
dimension element | |||
Tag Name | dimension | ||
Description | Represents a single custom dimension being returned in the response to an exportDimensions API call. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
id | Y | The internal system ID number for the dimension. This can be used to identify dimensions in other API calls, such as exportDimensionFamilies. | 16 |
name | Y | The name of the dimension, as it appears on reports and sheets. | Customer |
shortName | N | The short name for the dimension, if any, as entered in Dimension Administration | cust. |
autoCreate | Y | 1 if the selected dimension has the "Data import automatically creates dimension values" field set; 0 otherwise. | 0 |
listDimension | Y | 1 if the selected dimension is list dimension; 0 otherwise. | 1 |
keepSorted | Y | 1 if the selected dimension is kept sorted, 0 otherwise. | 1 |
useOnLevels | Y | 1 if the selected dimension can be used on levels, 0 otherwise. | 1 |
Contents of the Element | |||
Zero or more dimensionValue elements. Each enclosed dimensionValue element represents a "root dimension value" in the dimension, a value which has no parent value. | |||
dimensionValue element | |||
Tag Name | dimensionValue | ||
Description | Represents a single member value of a custom dimension being returned in the response to an exportDimensions API call. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
id | Y | The internal system ID number for this member value of the dimension. | 34 |
name | Y | The label for the member value of the dimension, as displayed on reports and used in formulas. | A Corp |
shortName | N | The short name for the dimension value, if any, as entered in Dimension Administration | A |
description | N | The description of the dimension value, if any, as entered in Dimension Administration | A Corporation |
Contents of the Element | |||
Zero or more optional dimensionValue elements. Each enclosed dimensionValue element represents a "child dimension value" of this dimension value, whose members implicitly roll up to this value. | |||
attributes element | |||
Tag Name | attributes | ||
Description | Container for one or more dimension attribute elements. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
(none) | |||
Contents of the Element | |||
One or more attribute elements. | |||
attribute element | |||
Tag Name | attribute | ||
Description | Container for one dimension attribute element. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
attributeID | Y | The id of the dimension attribute generated by system. | 20 |
name | Y | The name of the dimension attribute | Education Type |
valueID | Y | The unique id of the dimension attribute value generated by system. | 170 |
value | Y | The value of the dimension attribute. | Tech1 |
Contents of the Element | |||
(none) | |||