Skip to main content
Adaptive Insights
Knowledge and Support - Adaptive Insights

createDimensionValue

Category Metadata modification
Description Create a dimension value. If successful, the API returns details for the dimension and all dimension values including the one that has just been created.
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. This method returns an error if there are unpublished changes.

Request Format

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

 

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 a role containing the permissions required for the method being invoked. 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)

 

dimensionValue element
Tag Name dimensionValue
Description Specifies a dimension value to create.
Attributes of the Element
Attribute Name Required? Value Example
dimensionId Y The id of the dimension.Either dimensionId or parentId must be specified 34
parentId N The id of the parent dimension value. Either dimensionId or parentId must be specified. 220
name Y The name of the dimension value. NewDimensionValue
shortName N The description of the dimension value. NewDimensionValue- ShortName
description N The description of the dimension value. This is a NewDimensionValue
Contents of the Element
(none)

 

attributes element
Tag Name attributes
Description Container for one or more dimension attribute elements
Attributes of the Element
Attribute Name Required? Value Example
Contents of the Element
One or more attribute elements.

 

attributes element
Tag Name attribute
Description Container for one or more dimension attribute elements
Attributes of the Element
Attribute Name Required? Value Example
attributeID Y The id of the dimension attribute generated by system. 20
valueID Y The unique id of the dimension attribute value generated by system. If this value is 0 then this attribute is removed from the account. 170
Contents of the Element
(none)

Response Format

These are examples of responses for successful and unsuccessful creating of a dimension value.

Success Example

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

 Error Example

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

Dimensions are ordered by name. 

 

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
obsolete N If present on the response tag and set to true, this attribute indicates that the version of the method or API which is being invoked has become obsolete and is officially deprecated by Adaptive Planning. While it continues to function at this time, it may cease functioning in a short while. Typically, this attribute is not present. false
Contents of the Element
A single optional messages element, and exactly one required output element.

 

output element
Tag Name output
Attributes of the Element
(none)
Contents of the Element
A single accounts element. This output wrapper is standard on all API responses and encloses the valid output of any successful API call.

 

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 description
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 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. Techl
Contents of the Element
(none)
  • Was this article helpful?