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

exportInstances

Category

Metadata retrieval

Description

Returns metadata for the complete list of all instances of Adaptive products to which this user has access.

Permissions Required To Invoke

None (must be valid credentials for the instance)

Parameters Required On Request

Credentials

 

This method's request contains a credentials tag to identify and authorize the calling user and an optional include tag to indicate which instances to include in the response. Once the user credentials are verified, the method returns an XML document describing the instance specified in the credentials, or the complete set of all instances of Adaptive products to which this user has access. If the Multiple Instance feature has not been purchased, this call always returns a single ele- ment for the instance to which the user belongs.

Request Format

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportInstances" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
 <include accessibleInstances="true"/>
</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)

 

include element

Tag Name

include

Description

Represents a set of flags indicating what aspects of the instances' information should be included or excluded from the response. This element is optional: if not present, the default value is false for accessibleInstances.

Attributes of the Element

Attribute Name

Required?

Value

Example

accessibleInstances

N

Either true or false. Whether the response should include other instances besides the single instance specified in the credentials

The default, if the element or its attribute is not present, is false. If included and is true, then the API should return the list of all instances to which the user has access. These instances are not returned in any nested or parent-indicating fashion; they merely are enumerated with the properties as shown in the API. The first instance returned is always the default instance for the user.

False

Contents of the Element

(none)

Response Format

<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
  <instances>
    <instance code="INSTANCE1" name="Globo Industries" sessionTimeout="60" calendarType="G" systemCurrency="USD" products="PLANNING,DISCOVERY" 
 options="TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,PLANNING_VISUALIZE_DATA" 
 datasources="GREAT PLAINS,INTACCT,SALESFORCE,NETSUITE"/>
  </instances>
</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

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.

 

instances element

Tag Name

instances

Description

Container for one or more instance elements.

Attributes of the Element

(none)

Contents of the Element

One or more instance elements.

 

instance element

Tag Name

instance

Description

Describes a single instance to which this user has access, including a number of attributes of that instance.

Attributes of the Element

Attribute Name

Required?

Value

Example

code

Y

The instance code of the instance. This can be used to specify an alternate instance for an API call within the credentials element.

INSTANCE1

name

Y

The name of the instance in Adaptive Planning. This is configured in the "General Setup" area of Administration for that instance.

Globo Industries

sessionTimeout

Y

Timeout in minutes of the user session.

60

systemCurrency

Y

The ISO code for the system currency.

USD

products

Y

Comma separated list of product names that are enabled for the instance.

PLANNING,CONSOLIDATION,DISCOVERY, INTEGRATION

options

Y

Comma separated list of various modules enabled for the instance.

TRANSACTIONS,MUL
TI_CURRENCY,DIS
CO_DISABLED,PLANN
ING_VISUALIZE_
DATA

datasources

Y

Comma separated list of data sources enabled for the instance.

NETSUITE, SALES
FORCE

Contents of the Element

(none)

  • Was this article helpful?