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

exportTime

 

Category

Metadata retrieval

Description

Returns time metadata either for a specific version, or for all versions if none is specified.

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 version tag to specify which version to retrieve information for. If no version is specified, the method returns time information for the time range encompassing all versions' start and end times. Once the caller is verified, the method returns an XML document describing the complete set of time information for the version in a nested tree fashion.

Request Format

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportTime" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" locale="fr_FR" instanceCode="INSTANCE1"/>
<options includeAllLocales="1" includeLegacyInformation="1" />
</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)

 

Options element

Tag Name

Options

Description

Specifies the options to be used when exporting time.

Attributes of the Element

Attribute Name

Required?

Value

Example

includeAllLocales

N

Optionally, make export time export all translations for each strata / time period. If not specified, only the locale specified in the credential block is exported.

"1"

includeLegacyInformation

N

Optionally, make export time export additional attributes containing legacy time information. These additional attributes will not be included if isCustom = 1

"1"

Contents of the Element

(none)

 

version element

Tag Name

version

Description

Indicates which version should be used to retrieve the requested data. The user must be able to access the version specified and it cannot be a folder. A version element is not required, but if one is included, the version specified must be valid.

Attributes of the Element

Attribute Name

Required?

Value

Example

option N

Sets the range of time to export. Can be set to "all", "single", or omitted. Defaults to "single". If single, user must also specify either "name" or "id". Returns the time range of the single version specified and initial balance for that version. If both name and id specified, then they must refer to the same version. If all, return the time range of min to max of all versions including the initial balance period for the first stratum in the min-max time range. If all, then must not specify version "name" or "id". If omitted, return all defined time.

single

name

N

The name of the version to be used to retrieve the data. Only one version can be accessed within a single API call. If a name is not pro- vided, then an id must be. If both are given, then they must correspond to the same version.

Budget 2014

id

N

The id of the version to be used to retrieve the data. Only one version can be accessed within a single API call. If option is "single" and an id is not provided, then a name must be. If both are given, then they must correspond to the same version.

3

Contents of the Element

(none)

Response Format (with includeAllLocales="0" or not specified)

<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <output>
     <time isCustom="1">
       <stratum code="year" label="Year" shortName="Yr" id="3">
         <stratum code="qtr" label="Quarter" shortName="Qtr" id="2">
           <stratum code="month" label="Month" shortName="Mon" id="1" />
         </stratum>
       </stratum>
       <period code="2015" label="FY2015" shortName="FY2015" stratumId="3" timeslot="15" encodedTimePeriod="3::15" id="15003" start="2015-01-01" end="2016-01-01">
         <period code="Q1-2015" label="Q1-FY15" shortName="Q1-FY15" stratumId="2" timeslot="60" encodedTimePeriod="2::60" id="60002" start="2015-01-01" end="2015-04-01">
           <period code="01/2015" label="Jan-2015" shortName="Jan-2015" stratumId="1"timeslot="180" encodedTimePeriod="1::180" id="180001" start="2015-01-01" end="2015-02-01" />
           <period code="02/2015" label="Feb-2015" shortName="Feb-2015" stratumId="1" timeslot="181" encodedTimePeriod="1::181" id="181001" start="2015-02-01" end="2015-03-01" />
           <period code="03/2015" label="Mar-2015" shortName="Mar-2015" stratumId="1" timeslot="182" encodedTimePeriod="1::182" id="182001" start="2015-03-01" end="2015-04-01" />
         </period>
         <period code="Q2-2015" label="Q2-FY15" shortName="Q2-FY15" stratumId="2" timeslot="61" encodedTimePeriod="2::61" id="61002" start="2015-04-01" end="2015-07-01">
           <period code="04/2015" label="Apr-2015" shortName="Apr-2015" stratumId="1" timeslot="183" encodedTimePeriod="1::183" id="183001" start="2015-04-01" end="2015-05-01" />
           <period code="05/2015" label="May-2015" shortName="May-2015" stratumId="1" timeslot="184" encodedTimePeriod="1::184" id="184001" start="2015-05-01" end="2015-06-01" />
           <period code="06/2015" label="Jun-2015" shortName="Jun-2015" stratumId="1" timeslot="185" encodedTimePeriod="1::185" id="185001" start="2015-06-01" end="2015-07-01" />
         </period>
         <period code="Q3-2015" label="Q3-FY15" shortName="Q3-FY15" stratumId="2" timeslot="62" encodedTimePeriod="2::62" id="62002" start="2015-07-01" end="2015-10-01">
           <period code="07/2015" label="Jul-2015" shortName="Jul-2015" stratumId="1" timeslot="186" encodedTimePeriod="1::186" id="186001" start="2015-07-01" end="2015-08-01" />
           <period code="08/2015" label="Aug-2015" shortName="Aug-2015" stratumId="1" timeslot="187" encodedTimePeriod="1::187" id="187001" start="2015-08-01" end="2015-09-01" />
           <period code="09/2015" label="Sep-2015" shortName="Sep-2015" stratumId="1" timeslot="188" encodedTimePeriod=""1::188" id="188001" start="2015-09-01" end="2015-10-01" />
         </period>
         <period code="Q4-2015" label="Q4-FY15" shortName="Q4-FY15" stratumId="2" timeslot="63" encodedTimePeriod="2::63" id="63002" start="2015-10-01" end="2016-01-01">
           <period code="10/2015" label="Oct-2015" shortName="Oct-2015" stratumId="1" timeslot="189" encodedTimePeriod="1::189" id="189001" start="2015-10-01" end="2015-11-01" />
           <period code="11/2015" label="Nov-2015" shortName="Nov-2015" stratumId="1" timeslot="190" encodedTimePeriod="1::190" id="190001" start="2015-11-01" end="2015-12-01" />
           <period code="12/2015" label="Dec-2015" shortName="Dec-2015" stratumId="1" timeslot="191" encodedTimePeriod="1::191" id="191001" start="2015-12-01" end="2016-01-01" />
         </period>
       </period>
       <period code="2016" label="FY2016" shortName="FY2016" stratumId="3" timeslot="16" encodedTimePeriod="3::16" id="16003" start="2016-01-01" end="2017-01-01">
         <period code="Q1-2016" label="Q1-FY16" shortName="Q1-FY16" stratumId="2" timeslot="64" encodedTimePeriod="2::64" id="64002" start="2016-01-01" end="2016-04-01">
           <period code="01/2016" label="Jan-2016" shortName="Jan-2016" stratumId="1" timeslot="192" encodedTimePeriod="1::192" id="192001" start="2016-01-01" end="2016-02-01" />
           <period code="02/2016" label="Feb-2016" shortName="Feb-2016" stratumId="1" timeslot="193" encodedTimePeriod="1::193" id="193001" start="2016-02-01" end="2016-03-01" />
           <period code="03/2016" label="Mar-2016" shortName="Mar-2016" stratumId="1" timeslot="194" encodedTimePeriod="1::194" id="194001" start="2016-03-01" end="2016-04-01" />
         </period>
         <period code="Q2-2016" label="Q2-FY16" shortName="Q2-FY16" stratumId="2" timeslot="65" encodedTimePeriod="2::65" id="65002" start="2016-04-01" end="2016-07-01">
           <period code="04/2016" label="Apr-2016" shortName="Apr-2016" stratumId="1" timeslot="195" encodedTimePeriod="1::195" id="195001" start="2016-04-01" end="2016-05-01" />
           <period code="05/2016" label="May-2016" shortName="May-2016" stratumId="1" timeslot="196" encodedTimePeriod="1::196" id="196001" start="2016-05-01" end="2016-06-01" />
           <period code="06/2016" label="Jun-2016" shortName="Jun-2016" stratumId="1" timeslot="197" encodedTimePeriod="1::197" id="197001" start="2016-06-01" end="2016-07-01" />
         </period>
         <period code="Q3-2016" label="Q3-FY16" shortName="Q3-FY16" stratumId="2" timeslot="66" encodedTimePeriod="2::66" id="66002" start="2016-07-01" end="2016-10-01">
           <period code="07/2016" label="Jul-2016" shortName="Jul-2016" stratumId="1" timeslot="198" encodedTimePeriod="1::198" id="198001" start="2016-07-01" end="2016-08-01" />
           <period code="08/2016" label="Aug-2016" shortName="Aug-2016" stratumId="1" timeslot="199" encodedTimePeriod="1::199" id="199001" start="2016-08-01" end="2016-09-01" />
           <period code="09/2016" label="Sep-2016" shortName="Sep-2016" stratumId="1" timeslot="200" encodedTimePeriod="1::200" id="200001" start="2016-09-01" end="2016-10-01" />
         </period>
         <period code="Q4-2016" label="Q4-FY16" shortName="Q4-FY16" stratumId="2" timeslot="67" encodedTimePeriod="2::67" id="67002" start="2016-10-01" end="2017-01-01">
           <period code="10/2016" label="Oct-2016" shortName="Oct-2016" stratumId="1" timeslot="201" encodedTimePeriod="1::201" id="201001" start="2016-10-01" end="2016-11-01" />
           <period code="11/2016" label="Nov-2016" shortName="Nov-2016" stratumId="1" timeslot="202" encodedTimePeriod="1::202" id="202001" start="2016-11-01" end="2016-12-01" />
           <period code="12/2016" label="Dec-2016" shortName="Dec-2016" stratumId="1" timeslot="203" encodedTimePeriod="2::203" id="203001" start="2016-12-01" end="2017-01-01" />
         </period>
       </period>
     </time>
   </output>
</response>

Partial Response Format (with includeAllLocales="1")

Normally there is a locales block for every time period and stratum. Below, only the stratum section is shown. The locales/locale block for the time periods are identical in format.

           <stratum code="year" label="Year" shortName="Year" id="3">
             <locales>
                 <locale locale="en" label="Year" shortName="Year" />
                 <locale locale="de" label="Jahr" shortName="Jahr" />
                 <locale locale="fr" label="Année" shortName="Année" />
                 <locale locale="es" label="Año" shortName="Año" />
                 <locale locale="pt" label="Ano" shortName="Ano" />
                 <locale locale="nl" label="Jaar" shortName="Jaar" />
                 <locale locale="ja" label="年" shortName="年" />
             </locales>
             <stratum code="qtr" label="Quarter" shortName="Quarter" id="2">
                 <locales>
                     <locale locale="en" label="Quarter" shortName="Quarter" />
                     <locale locale="de" label="Quartal" shortName="Quartal" />
                     <locale locale="fr" label="Trimestre" shortName="Trimestre" />
                     <locale locale="es" label="Trimestre" shortName="Trimestre" />
                     <locale locale="pt" label="Trimestre" shortName="Trimestre" />
                     <locale locale="nl" label="Kwartaal" shortName="Kwartaal" />
                     <locale locale="ja" label="四半期" shortName="四半期" />
                 </locales>
                 <stratum code="month" label="Month" shortName="Month" id="1">
                     <locales>
                         <locale locale="en" label="Month" shortName="Month" />
                         <locale locale="de" label="Monat" shortName="Monat" />
                         <locale locale="fr" label="Mois" shortName="Mois" />
                         <locale locale="es" label="Mes" shortName="Mes" />
                         <locale locale="pt" label="Mês" shortName="Mês" />
                         <locale locale="nl" label="Maand" shortName="Maand" />
                         <locale locale="ja" label="月" shortName="月" />
                     </locales>
                 </stratum>
             </stratum>
         </stratum>

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 mes- sages 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.

 

messages element

Tag Name

messages

Description

Container for one or more message elements.

Attributes of the Element

Attribute Name

Required?

Value

Example

(none)

Contents of the Element

One or more message elements.

 

message element

Tag Name

message

Description

Represents a message being sent from the system back to the caller. Messages are used for error messages when requests do not succeed, for warning messages when requests do succeed, and for confirmation messages upon success.

Attributes of the Element

Attribute Name

Required?

Value

Example

key

N

When given, a key is a way to identify a particular message or type of message, useful for purposes of automated error logging and recovery in client programs. Keys do not change under different locales of requests, even when the language of the message changes. Keys also are unlikely to change in the future due to wording adjustments or terminology changes.

invalid-attributevalueid

Contents of the Element

The text of the message. This text is in the language of the locale specified on the request (assuming that locale is supported). The text may also contain variable information such as the number of rows which were processed, or the particular column or value which caused an error.

 

output element

Tag Name

output

Attributes of the Element

(none)

Contents of the Element

A single required time element. This output wrapper is standard on all API responses and encloses the valid output of any successful API call.

 

time element

Tag Name

time

Description

Container for one root stratum element, zero or one initial-balance elements and one or more root stratum period elements.

Attributes of the Element

Attribute Name

Required?

Value

Example

isCustom Y Either 1 or 0, indicating whether the calendar for this instance has been customized or not. 1
q1FirstMonth N The month that the fiscal year starts in (starting from 0). This attribute only appears if includeLegacyInformation was 1 in the request and if isCustom is 0. 8
lastMonthIsFY N Indicates whether the fiscal year is equivalent to the calendar year that the fiscal year ends in. This attribute only appears includeLegacyInformation was 1 in the request and if isCustom is 0. 0

Contents of the Element

Exactly one stratum element, zero or one initial-balance elements and one or more root stratum period elements.

 

stratum element

Tag Name

stratum

Description

Represents a stratum of the calendar being returned from the exportTime API call.

Attributes of the Element

Attribute Name

Required?

Value

Example

code

Y

A unique, user-defined identifier for the time stratum.

Yr

label

Y

A non-unique, user-defined text identifier for the time stratum.

Fiscal Year

shortName

Y

A non-unique, user-defined text identifier used when a shorter name is desired. If a short name is not defined, the label will be displayed here.

Year

id

Y

The unique, system-generated integer identifier for the time stratum.

7

Contents of the Element

Zero or one locales element. This is only included if includeAllLocales is set. 

Zero or one stratum element. Every stratum apart from the leaf has exactly one stratum element. The leaf stratum element has zero contained stratum elements.

 

initial-balance element

Tag Name

initial-balance

Description

Represents the last leaf time period before the start of the version being returned in the response to an exportTime API call. This is only included if one and only one version is requested.

Attributes of the Element

Attribute Name

Required?

Value

Example

code

Y

The unique, user-defined identifier for the initial balance time period.

12/2003

label

Y

The non-unique, user-defined text identifier for the initial balance time period.

Dec-2003

shortname

Y

The non-unique, user-defined, short text identifier for the initial balance time period. If no short name was defined, then the label is displayed.

Dec

stratumId

Y

The id of the stratum the initial balance belongs to.

1

timeslot

Y

The timeslot of the time period the initial balance belongs to..

47

encodedTimePeriod Y The encoded data for time period, in the format of strutumId::timeslot. 1::47
id Y The unique, system-generated integer identifier for the initial balance time period. 47001
start Y The starting date (inclusive) of the initial balance, in the form YYYY-MM-DD. 2003-12-01
end Y The ending date (exclusive) of the initial balance, in the form YYYY-MM-DD. 2004-01-01
legacyReportTimeId N The report id that would have been displayed for this time period in older versions of this API. This attribute only appears includeLegacyInformation was 1 in the request and if isCustom is 0. 200312

legacySheetTimeId

N

The sheet time id that would have been used for this time period in older versions of this API. This attribute only appears includeLegacyInformation was 1 in the request and if isCustom is 0.

48, Q63 or Y72

Contents of the Element

Zero or one locales element.

 

Period element

Tag Name

period

Description

Represents a single calendar time period being returned from the exportTime API call.

Attributes of the Element

Attribute Name

Required?

Value

Example

code

Y

A unique, user-defined identifier for the time period.

Q1-2004

label

Y

A non-unique, user-defined text identifier for the time period.

Q1-FY04

shortName

Y

A non-unique, user-defined text identifier used when a shorter name is desired. If a short name is not defined, the label will be displayed here.

Q1

stratumId

Y

The id of the stratum the time period belongs to .

2

id

Y

The unique, system-generated integer identifier for the time period .

16002

start Y The starting date (inclusive) of the time period, in the form YYYY-MM-DD. 2004-01-01
end Y The ending date (exclusive) of the time period, in the form YYYY-MM-DD. 2004-04-01
legacyReportTimeId N The report id that would have been displayed for this time period in older versions of this API. This attribute only appears includeLegacyInformation was 1 in the request and if isCustom is 0. 200491
legacySheetTimeId N The sheet time id that would have been used for this time period in older versions of this API. This attribute only appears includeLegacyInformation was 1 in the request and if isCustom is 0. 48, Q63 or Y72

Contents of the Element

Zero or one locales elements.

 

Locales element

Tag Name

locales

Description

Container for one or more locale elements.

Attributes of the Element

Attribute Name

Required?

Value

Example

(none)

Contents of the Element

One or more locale elements.

 

locale element

Tag Name

locale

Description

Description of locale. Note that the text will follow the locale fallback rules.

Attributes of the Element

Attribute Name

Required?

Value

Example

locale

Y

The code for the locale.

en

label

Y

The localized label for the time period/strata..

FY2016

shortName

Y

The localized short name for the time period/strata..

2016

Contents of the Element

(none)

 

  • Was this article helpful?