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>
호출 요소에는 자격증명 요소와 단일 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 호출에 대한 응답으로 반환되는 단일 모델링 시트를 나타냅니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
코드 | 예 | 시트의 이름입니다. 이는 importModeledSheet와 같은 다른 API 호출에서 시트를 식별하는 데 사용할 수 있습니다. | 오픈 포지션 |
설명 | 아니요 | 시트에 대한 설명입니다(있는 경우). | 충원할 오픈 포지션 |
요소의 콘텐츠
| |||
응답 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
, 이제 연결된 계정의 코드를 가리킵니다. 그 동안 코드 속성은 유지되지만 이제 지정된 열에 대해 편집가능한 고유 ID를 생성하는 데 사용할 수 있습니다.