exportModeledSheet
Updated in v40 (September 21, 2024)
Category | Metadata retrieval |
Description | Returns the definition of the given modeled sheet. |
Permissions Required To Invoke | MOD (create, edit, and delete sheets) |
Parameters Required On Request | Credentials, and a specification of which sheet is being requested. |
Retrieve the definition of a modeled sheet.
Request Format
<?xml version='1.0' encoding='UTF-8'?> <call method="exportModeledSheet" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> <exportModel sheetToExport="Name of Modeled Sheet" /> </call>
The call element contains a credentials element, as well a single exportModel element.
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 the required permissions to invoke the method. | |
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) | |||
exportModel Element | |||
Tag Name | exportModel | ||
Description | Fields relevant to the model sheet export. | ||
Attributes of the element | |||
Attribute name | Required? | Value | Example |
sheetToExport | Y | The name of the modeled sheet. | Capital Model |
displayNameEnabled | N | displayNameEnabled=true indicates exportModeledSheet should respect display name properties when Enable Display Name is ON for the instance.
displayNameEnabled=false indicates the exportModeledSheet API should continue following the pre-v30 API contract even when Enable Display Name is ON for the instance. The exportModeledSheet API ignores the display name properties. | true |
Response Format
<response success="true"> <output> <ConfigurableModel allow-actuals="false" allow-allocation="true" allow-edits-in-rollup-mode="false" breakback-pattern="0" code="Open Positions" description="Open positions to be filled" frozen-column-count="0" has-salary-detail="true" id="15" isglobal="1" prefix="Openings" revision="0" selected-plan-ids= "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18" state="A" strata-code="month" strata-id="3"> <Columns> <AssignablePlan abbr="" code="Plan" id="0" is-splitable="false" name="Plan" read-only="false" show-total-at-bottom="false" tool-tip="" /> <Driver abbr="" code="PositionCode" decimal-precision="0" driver-type="0" id="22" is-split-key="false" is-splitable="false" name="Position Code" read-only="false" show-total-at-bottom="false" tool-tip="" /> <Dimension abbr="" code="Department" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="6" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false" isTextSelector="false" name="Department" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip="" requiredColumn="true"> <DimensionValue abbr="" id="7" in-use="0" name="Engr" sort-order="0" /> <DimensionValue abbr="" id="40" in-use="0" name="QA" sort-order="1" /> <DimensionValue abbr="" id="8" in-use="0" name="PS" sort-order="3" /> <DimensionValue abbr="" id="41" in-use="0" name="Dev" sort-order="2" /> <DimensionValue abbr="" id="9" in-use="0" name="G & A" sort-order="4" /> <DimensionValue abbr="" id="10" in-use="0" name="Sales" sort-order="5" /> <LookupTables /> </Dimension> <Dimension abbr="" code="Title" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="16" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false" isTextSelector="false" name="Title" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip=""> <DimensionValue abbr="" id="64" in-use="0" name="Sales Rep" sort-order="8" /> <DimensionValue abbr="" id="65" in-use="0" name="Engr Mgr" sort-order="10" /> <DimensionValue abbr="" id="66" in-use="0" name="Sr Engr" sort-order="11" /> <DimensionValue abbr="" id="67" in-use="0" name="Engr" sort-order="12" /> <DimensionValue abbr="" id="68" in-use="0" name="GUI Engr" sort-order="13" /> <DimensionValue abbr="" id="47" in-use="0" name="CFO" sort-order="1" /> <DimensionValue abbr="" id="48" in-use="0" name="VP Mkt" sort-order="3" /> <DimensionValue abbr="" id="49" in-use="0" name="Doc Mgr" sort-order="5" /> <DimensionValue abbr="" id="18" in-use="0" name="CEO" sort-order="0" /> <DimensionValue abbr="" id="50" in-use="0" name="VP Sales" sort-order="7" /> <DimensionValue abbr="" id="51" in-use="0" name="VP Engr" sort-order="9" /> <DimensionValue abbr="" id="61" in-use="0" name="Controller" sort-order="2" /> <DimensionValue abbr="" id="62" in-use="0" name="Mkt Assoc" sort-order="4" /> <DimensionValue abbr="" id="63" in-use="0" name="Doc Writer" sort-order="6" /> <LookupTables /> </Dimension> <Dimension abbr="" code="Base Pay" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="1" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false" isTextSelector="false" name="Base Pay" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip=""> <DimensionValue abbr="" id="22" in-use="0" name="60-80K" sort-order="3" /> <DimensionValue abbr="" id="23" in-use="0" name="80-100K" sort-order="4" /> <DimensionValue abbr="" id="24" in-use="0" name="100-120K" sort-order="0" /> <DimensionValue abbr="" id="25" in-use="0" name="120-150K" sort-order="1" /> <DimensionValue abbr="" id="26" in-use="0" name="150-200K" sort-order="2" /> <DimensionValue abbr="" id="27" in-use="0" name=">200K" sort-order="5" /> <LookupTables /> </Dimension> <Dimension abbr="" code="Position Type" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="10" is-splitable="true" isEditDimension="false" isHiddenOnSheet= "false" isTextSelector="false" name="Position Type" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip=""> <DimensionValue abbr="" id="28" in-use="0" name="Full Time" sort-order="1" /> <DimensionValue abbr="" id="29" in-use="0" name="Part Time" sort-order="2" /> <DimensionValue abbr="" id="30" in-use="0" name="Contract" sort-order="0" /> <LookupTables /> </Dimension> <Dimension abbr="" code="Education" codeHasBeenUpdated="false" hasOverriddenTitle="false" id="7" is-splitable="true" isEditDimension="false" isHiddenOnSheet="false" isTextSelector="false" name="Education" read-only="false" show-total-at-bottom="false" tagType="0" tool-tip=""> <DimensionValue abbr="" id="32" in-use="0" name="Masters" sort-order="1" /> <DimensionValue abbr="" id="33" in-use="0" name="Phd" sort-order="2" /> <DimensionValue abbr="" id="31" in-use="0" name="Graduate" sort-order="0" /> <LookupTables /> </Dimension> <Driver abbr="" code="Rate" decimal-precision="0" display-as="1" driver-type="1" id="23" is-split-key="false" is-splitable="false" name="Rate" read-only="false" show-total-at-bottom="false" tool-tip="" /> <Driver abbr="" code="YearsOfExperience" decimal-precision="0" display-as="1" driver-type="1" id="24" is-split-key="false" is-splitable="false" name="Years Of Experience" read-only="false" show-total-at-bottom="false" tool-tip="" /> <Driver abbr="" code="FillBy" decimal-precision="0" driver-type="2" id="25" is-split-key="false" is-splitable="false" name="Fill By" read-only="false" show-total-at-bottom="false" tool-tip="" /> </Columns> <CalculatedAccounts /> <Assumptions /> </ConfigurableModel> </output> </response>
The response will contain the sheet definition in a ConfigurableModel element.
ConfigurableModel element | |||
Tag Name | ConfigurableModel | ||
Description | Represents a single modeled sheet being returned in the response to an export- ModeledSheet API call. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
code | Y | The name of the sheet. This can be used to identify sheets in other API calls, such as importModeledSheet. | Open Positions |
description | N | The description of the sheet, if any. | Open positions to be filled |
Contents of the Element | |||
See the Response XML | |||
Modeled Sheet Display Column Codes for API v40+
exportModeledSheet
supports unique codes for display columns. If a modeled sheet has a display column, theexportModeledSheet
api response will include a new property forDisplayColumn
:
Note the new property,<DisplayColumn abbr="" account-code="PayRate" account-id="370" code="PayRateDisplay" hiddenColumn="true" id="7" is-splitable="false" months="6" name="Pay Rate Display Column" read-only="true" show-total-at-bottom="true" start-time-adjust="1" start-time-index="2" start-time-relative-to="C" strata-code="qtr" tool-tip="Display Column" />
account-code
, which now points to the code for the associated account. Meanwhile the code property remains but can now be used to create an editable, unique identifier for the given column.