exportCalendar
This API is supported in API v33+.
Updated in API v40 (September 21, 2024).
Category
| Metadata retrieval |
Description
| Returns calendar metadata. |
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. Once the caller is verified, the method returns an XML document describing the complete list of calendar information.
Request Format
<?xml version='1.0' encoding='UTF-8'?> <call method="exportCalendar" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/> </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 |
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> <calendars> <calendar id="1" isDefault="true" name="DefaultTimeHierarchy" /> </calendars> </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 |
Contents of the Element
| |||
Exactly one required output element. | |||
output element
| |
Tag Name
| output |
Attributes of the Element
| |
(none) | |
Contents of the Element
| |
A single required calendars element. This output wrapper is standard on all API responses and encloses the valid output of any successful API call. | |
calendars element
| |||
Tag Name
| calendars | ||
Description
| Container for one or more calendars elements. | ||
Attributes of the Element
| |||
Attribute Name
| Required?
| Value
| Example
|
(none) | |||
Contents of the Element
| |||
One or more calendar elements. | |||
calendar element
| |||
Tag Name
| calendar | ||
Description
| Represents a calendar. | ||
Attributes of the Element
| |||
Attribute Name
| Required?
| Value
| Example
|
id | Y | Holds the specific integer identifier of the specific calendar. | 1 |
isDefault | Y | Either "true" or "false", indicating whether that specific calendar is the default calendar. | true |
name | Y | Contains the calendar name. | DefaultTimeHierarchy |
code Available in API v40+ | N | Contains the calendar code when calendar codes are present. | DefaultTimeHierarchy |
Contents of the Element
| |||
(none) | |||