exportModeledSheet
在 v40 中更新（2024 年 9 月 21 日）
种类
| 元数据检索 |
描述
| 返回给定模型化工作表的定义。 |
调用所需的权限
| MOD（创建、编辑和删除工作表） |
请求时需要的参数
| 凭据，以及所申请工作表的说明。 |
检索模型化工作表的定义。
申请格式
<?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>
该call 元素包含一个credentials 元素和一个exportModel 元素。
凭据元素
| |||
标记名称
| 凭据 | ||
描述
| 所有 API 调用都必须包含一个凭据元素，以识别调用 API 的用户。然后，系统会以此用户身份执行 API 调用（系统中的任何审核线索或操作历史记录都将显示此用户执行了该操作），因此，该用户必须具有执行该操作所需的权限，API 才能执行该操作。调用以成功。 | ||
元素的属性
| |||
属性名称
| 必填 ？ | 值
| 示例
|
密码 | 是 | 调用 API 方法的用户的密码。 | my_password |
区域设置 | 否 | 指定用于解释传入数字和日期的区域设置，以及用于设置传出数字和日期格式的区域设置（使用正确的千位分隔符、月份名称和日期格式）。区域设置还用于指定回复中的任何系统消息应使用的语言。如果未指定，则使用 en_US（美式英语）。 | fr_FR |
instanceCode | 否 | 如果凭据中指定的用户有权访问多个实例， Adaptive Planning ，此属性可用于指定用户打算访问默认实例以外的实例。如果未指定，则将使用用户的默认实例。要确定可用的实例代码，请使用 exportInstances API。 | MYINSTANCE1 |
元素的内容
| |||
（无） | |||
exportModel 元素
| |||
标记名称
| exportModel | ||
描述
| 与模型工作表导出相关的字段。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
sheetToExport | 是 | 模型化工作表的名称。 | 资本模型 |
displayNameEnabled | 否 | displayNameEnabled=true 表示当实例的“启用显示名称”为“开启”时，exportModeledSheet 应遵循显示名称属性。
displayNameEnabled=false 表示 exportModeledSheet API 应继续遵循 v30 之前的 API 合同，即使实例的“启用显示名称”为“开启”也是如此。exportModeledSheet API 会忽略显示名称属性。 | True |
回复格式
<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>
响应将在 ConfigurableModel 元素中包含工作表定义。
ConfigurableModel 元素
| |||
标记名称
| ConfigurableModel | ||
描述
| 表示在对 export-ModeledSheet API 调用的响应中返回的单个模型化工作表。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
代码 | 是 | 工作表的名称。这可用于识别其他 API 调用（例如 importModeledSheet）中的工作表。 | 开放职位 |
描述 | 否 | 工作表的描述（如有）。 | 待招聘的开放职位 |
元素的内容
| |||
查看回复 XML | |||
API v40+ 的模型化工作表显示列代码
exportModeledSheet
支持显示列的唯一代码。如果模型化工作表具有显示列，则exportModeledSheet
API 响应将包括以下项的新属性：DisplayColumn
：
请注意新属性：<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
，现在指向关联账户的代码。同时，代码属性仍然存在，但现在可用于为给定列创建可编辑的唯一编号。