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

exportAttributes

Category

Metadata retrieval

Description

Returns metadata for the complete list of all attributes in the system.

Permissions Required To Invoke

None (must be valid credentials for the instance)

Parameters Required On Request

Credentials

This method's request contains only a credentials tag to identify and authorize the calling user. Once verified, the method returns an XML document describing the complete set of all custom attributes (excluding the trading partner sys- tem attribute for consolidation instances), including all of their member values. Member values within an attribute are returned in tree form, with parent members containing their children.

Request Format

 

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportAttributes" callerName="a string that identifies your client application"> 
<credentials login="sampleuser@company.com" password="my_pwd"/>
</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 his- tory 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 speci- fied, the user's default instance will be used. To determine the available instance codes, use the exportInstances API.

MYINSTANCE1

Contents of the Element

(none)

 Response Format

 <?xml version='1.0' encoding='UTF-8'?>
   <response success="true">
    <output>
      <attributes>
        <attribute id="13" name="AP Eligible" type="account">
          <attributeValue id="118" name="No" />
          <attributeValue id="117" name="Yes">
            <attributeValue id="136" name="Full" />
            <attributeValue id="135" name="Partial" />
          </attributeValue>
        </attribute>
        <attribute id="11" name="Product Line" type="account">
          <attributeValue id="34" name="A" />
          <attributeValue id="35" name="B" />
        </attribute>
        <attribute id="9" name="Corporate Discount" type="level">
          <attributeValue id="56" name="Available" />
          <attributeValue id="54" name="Not Applicable" />
          <attributeValue id="57" name="Not Available" />
          <attributeValue id="55" name="TBD" />
        </attribute>
        <attribute id="10" name="Tax Code" type="level">
          <attributeValue id="146" name="TT-PYT" />
          <attributeValue id="145" name="TT-TRE" />
        </attribute>
        <attribute id="16" name="Industry" type="dimension" dimension-id="15">
          <attributeValue id="335" name="Apparel">
             <attributeValue id="354" name="Mens Apparel" />
             <attributeValue id="355" name="Shoes" />
             <attributeValue id="356" name="Womens Apparel" />
          </attributeValue>
        </attribute>
      </attributes>
    </output>
</response> 

attributes element

Tag Name

attributes

Description

Container for zero or more attribute elements. Attributes will be ordered so that attributes will be in the following order according to type: 'account', 'level', and 'dimension'. Attributes with the same type will be ordered by name.

Attributes of the Element

Attribute Name

Required?

Value

Example

(none)

Contents of the Element

Zero or more attribute elements.

 

attribute element

Tag Name

attribute

Description

Represents a single attribute being returned in the response to an exportAttributes API call.

Attributes of the Element

Attribute Name

Required?

Value

Example

id

Y

The internal system ID number for the attribute.

16

name

Y

The name of the attribute as it appears on the attribute administration page.

Industry

type

Y

The type of the attribute. This will be 'account' if the attribute is for an account, 'level' if the attri- bute is for a level, or 'dimension' if the attribute is for a dimension.

dimension

dimension-id

N

The id of the dimension if the attribute is of type 'dimension'.

15

Contents of the Element

Zero or more optional attributeValue elements. Each enclosed attributeValue element represents a "root attribute value" in the attribute, a value which has no parent value.

 

attributeValue element

Tag Name

attributeValue

Description

Represents a single member value of an attribute being returned in the response to an exportAttributes API call.

Attributes of the Element

Attribute Name

Required?

Value

Example

id

Y

The internal system ID number for this member value of the attribute.

34

name

Y

The label for the member value of the attribute as displayed on the attribute administration page.

Available

Contents of the Element

Zero or more optional attributeValue elements. Each enclosed attributeValue element represents a "child attribute value" of this attribute value, whose members implicitly roll up to this value.

 

  • Was this article helpful?