exportSheets
Category | Metadata retrieval |
Description | Returns the complete list of all sheets defined for the given instance. This includes "incomplete" sheets as well as user-assigned sheets. |
Permissions Required To Invoke | IMP (import data) or MOD (create, edit, and delete sheets) |
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 sheets found in the user's instance.
Request Format
<?xml version='1.0' encoding='UTF-8'?> <call method="exportSheets" 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 history of actions in the system will show that this user performed the action), and therefore the user must have the required permissions to per- form 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 for- mat 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) | |||
Response Format
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <output> <sheets> <modeled-sheet id="1" name="Personnel" prefix="Personnel" description="Personnel Sheet" /> <modeled-sheet id="2" name="Crossover Personnel" prefix="Crossovers" description="Personnel Sheet" /> <modeled-sheet id="3" name="Sales" prefix="Sales" description="Sales Sheet" /> ... <standard-sheet id="6" name="Model Summary" prefix="" description="Configurable Model Summary Sheet" /> <standard-sheet id="8" name="Expenses" prefix="" description="" /> <standard-sheet id="9" name="Balance" prefix="" description="" /> <standard-sheet id="10" name="Assumptions" prefix="" description="" /> ... <cube-sheet id="17" name="Expense Cube" prefix="ExpenseCube" description="" /> <cube-sheet id="19" name="Sale Cube" prefix="SalesCube" description="" /> </sheets> </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 | |||
Attribute Name | Required? | Value | Example |
(none) | |||
Contents of the Element | |||
A single required cube-sheets element. This output wrapper is standard on all API responses and encloses the valid output of any successful API call. | |||
sheets element | |||
Tag Name | sheet | ||
Description | Container for one or more standard-sheet, modeled-sheet and cube-sheet elements. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
(none) | |||
Contents of the Element | |||
One or more standard-sheet, modeled-sheet and cube-sheet elements. | |||
standard-sheet element | |||
Tag Name | standard-sheet | ||
Description | Represents a single standard sheet being returned in the response to an exportSheets API call. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
id | Y | The internal system ID number for the sheet. This can be used to identify sheets in other API calls, such as exportSheetDefinition. | 123 |
prefix | Y | The prefix of the sheet. For standard sheets, this is always empty. Other sheet types have non-empty values for this attri- bute. | |
name | Y | The name of the sheet. | Rollup Modes |
description | N | The textual description of the sheet, if any. | These are the rollup modes... |
Contents of the Element | |||
(none) | |||
modeled-sheet element | |||
Tag Name | modeled-sheet | ||
Description | Represents a single modeled sheet being returned in the response to an exportSheets API call. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
id | Y | The internal system ID number for the sheet. This can be used to identify sheets in other API calls, such as exportSheetDef- inition. | 234 |
prefix (API v38 and below)
code (API v39+) | Y | API v38: The prefix of the sheet.
API v39: The code of the sheet. | Capital |
name | Y | The name of the sheet. | Capital Model |
description | N | The textual description of the sheet, if any. | This is the Capital Model... |
Contents of the Element | |||
(none) | |||
cube-sheet element | |||
Tag Name | cube-sheet | ||
Description | Represents a single cube sheet being returned in the response to an exportSheets API call. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
id | The internal system ID number for the sheet. This can be used to identify sheets in other API calls, such as exportSheetDefinition. | 34 | |
prefix | The prefix of the sheet. | ExpenseCube | |
name | The name of the sheet. | Expense Cube | |
description | The textual description of the sheet, if any. | ||
Contents of the Element |
(none) |