주 컨텐츠로 이동
문서
문서
Adaptive Planning
최종 업데이트: 2024-09-20
모델링 시트 정의

모델링 시트 정의

URL 엔드포인트

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/sheet/modeled/definition
버전: v1
카테고리
데이터 제출
설명
메타데이터 수정
호출에 필요한 권한
모델 관리 액세스
모델에는 시트, 계정, 디멘션 및 수식이 포함됩니다.
요청 시 필수 매개변수
이름

지원되는 HTTP 동사

HTTP Verb
단일 리소스
수금 리소스
설명
PATCH
지원됨
미지원
모델링 시트 정의 삽입 또는 업데이트
DELETE
지원됨
미지원
모델링 시트 정의 삭제
POST
지원됨
미지원
모델링 시트 정의 upsert의 검증 모드입니다.
옵션
지원됨
미지원
이 컬렉션 리소스에 대해 지원되는 HTTP Verb 목록을 반환합니다.

PATCH

요청 URI
/sheet/modeled/definition
제공된 쿼리 매개변수와 일치하는 모델링 시트 정의를 업데이트합니다.
ID가 일치하는 시트가 없으면 지정된 속성을 사용하여 신규 모델링 시트가 생성됩니다.
이름별 샘플 요청
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/modeled/definition?name=Capital Model
샘플 요청 헤더
Accept-Language: ko
샘플 요청 본문
요청 본문 섹션을 참조하십시오.
쿼리 매개변수
이름
설명
필수
instanceCode
값을 검색할 instanceCode입니다. 예를 들어, GLOBO입니다. instanceCode를 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다.
아니요
이름
시트의 이름입니다.
아니요
proceedWithWarnings
upsert에서 경고 검증을 무시해야 하는지 여부로, 일반적으로 변경된 시트 속성으로 인해 시트에서 데이터가 삭제될 수 있는 경우에 반환됩니다.
아니요
reorderColumns
이 쿼리 매개변수를 true로 설정하면 API 요청 본문에 지정된 열의 순서를 반영하도록 열 목록의 순서가 변경됩니다. 기본적으로 false로 설정됩니다. 참조 Reference: Re-ordering Columns for Modeled and Cube Sheet Definition JSON APIs.
아니요
요청 본문
샘플 요청 본문
동일한 모델링 시트 정의 형식이 두 엔드포인트 모두에 대한 JSON 페이로드로 사용됩니다.
요청 형식
 
{
  "properties": {
      "description": "Capital Model",
      "prefix": "Capital"
  },
  "columns": [
      {
          "properties": {
              "code": "Base Pay",
              "name": "Base Pay",
              "type": "TEXT_SELECTOR",
              "values": ["value1", "value2"],
              "lookupTables": [
                  {
                      "name": "valueLookup1",
                      "type": "VALUE",
                      "decimalPrecision": 1,
                      "displayAs": "CURRENCY"
                  },
                  {
                      "name": "spreadLookup1",
                      "type": "SPREAD",
                      "decimalPrecision": 0,
                      "displayAs": "NUMBER"
                  }
              ]
          },
          "availability": [
              {
                  "name": "100k",
                  "code": "100k",
                  "available": true
              }
          ],
          "defaultAvailability": false,
          "defaultActionIfDataIsPresent": "delete"
      },
      {
          "properties": {
              "code": "Label",
              "name": "Label",
              "type": "TEXT"
          },
          "delete": true
      }
  ],
  "accounts": [
      {
          "name": "AccountName",
          "code": "AccountCode"
      }
  ],
  "accessibility": {
      "usernames": [ "test@greenco.com" ],
      "excludedFromWorkflow": true
  }
}
시트 정의 오브젝트
이름
설명
필수
속성
일반 시트 속성을 포함하는 오브젝트
아니요
열
모델링 시트 열 오브젝트의 목록입니다.
시트 정의 끝에 신규 열이 생성되고 신규 열의 상대적 순서가 적용됩니다.
기존 열은 현재 위치에서만 업데이트됩니다. 재정렬되지 않습니다.
아니요
계정
계정 오브젝트 목록
아니요
접근성
사용자 지정 시트 액세스 권한 설정을 포함하는 오브젝트
아니요
시트 속성 오브젝트
이름
설명
필수
유형
기본값
설명
시트 설명
아니요
문자열
빈 문자열
코드
계정 코드 접두어 및 보조 고유 ID에 사용되는 시트 코드 신규 시트를 생성하는 경우 필수입니다.
아니요
문자열
접두어
계정 코드에 사용되는 시트 접두어입니다. 신규 시트를 생성하는 경우 필수입니다. 폐지 예정 코드
아니요
문자열
userAssigned
시트가 사용자 지정 시트인지 또는 레벨 지정 시트(기본값)인지 여부
아니요
부울
false
salaryDetail
시트에 급여 세부내용이 포함되어 있는지 여부
아니요
부울
false
frozenColumnCount
아니요
정수
0
allowSplits
시트에서 행 분할을 허용하는지 여부
아니요
부울
false
allowRollupModelEdits
시트에서 롤업 레벨을 조회하는 동안 편집을 허용할지 여부
아니요
부울
false
allowActuals
시트를 실제값 버전에서 사용할 수 있는지 여부
아니요
부울
false
recalculateOnDemand
시트에 대해 요청시 재계산이 활성화되어 있는지 여부
아니요
부울
false
timeStratumCode
시트의 데이터와 연결된 시간 단위 코드입니다.
아니요
문자열
GL 시간 단위
시트 열 오브젝트
이름
설명
필수
유형
기본값
속성
시트 열 속성을 포함하는 오브젝트
예
오브젝트
가능일정
현재 열의 시트 사용가능 설정 오브젝트 목록입니다. 참조 Sheet Availability목록 형식에 대한 자세한 내용은 을 참조하십시오.
아니요
목록
defaultAvailability
사용가능 설정에서 달리 지정하지 않는 한, 모든 값에 적용할 기본 사용가능 설정입니다. 레벨 및 디멘션 열에 유효합니다.
디멘션 열의 경우 Availability 또는 defaultAvailability가 지정되지 않으면 새 열에 대해 defaultAvailability가 true로 설정됩니다.
기본적으로 이 값은 비어 있습니다. 즉, 가능일정을 통해 특별히 변경하지 않는 한 기존 가능일정이 유지됩니다.
아니요
부울
defaultActionIfDataIsPresent
사용가능 설정에서 달리 지정하지 않는 한, 값을 삭제할 때 데이터가 있는 경우의 기본 액션입니다. 디멘션 열에 유효합니다.
기존 열에 대한 기본 사용가능 설정이 false인 경우 필수입니다.
아니요
문자열
삭제
지정된 시트에서 열 삭제를 요청합니다. 삭제 플래그가 지정되지 않은 기존 열에 종속된 열(예: 디멘션 특성)에는 유효하지 않습니다.
아니요
부울
시트 열 속성 오브젝트
이름
설명
필수
유형
기본값
이름
열 이름
아니요
문자열
코드
열 코드 레벨 및 레벨 통화 열을 제외한 모든 열에 필수입니다.
예
문자열
type
열 유형입니다.
가능한 값: LEVEL, DIMENSION, LEVEL_ATTRIBUTE, DIMENSION_ATTRIBUTE, TIMESPAN, NUMBER, DATE, TEXT, TEXT_SELECTOR, LEVEL_CURRENCY, DISPLAY, INITIAL_BALANCE, CHECKBOX
예
문자열
readOnly
현재 열이 읽기 전용인지 여부입니다. 디멘션 특성 열의 경우 특성을 디멘션에 대한 필터로 사용하려면 읽기 전용을 false로 설정합니다.
레벨 특성 및 표시 열에 대해 true(기본값은 true)여야 합니다.
아니요
부울
false
allowSplits
현재 열이 분할가능한지 여부입니다. 일반 AllowSplits 속성이 true인 시트에 대해서만 유효합니다.
아니요
부울
false
showTotalsAtBottom
이 열의 시트 맨 아래에 합계를 표시할지 여부입니다.
아니요
부울
false
AllowHidden
표시 옵션의 시트 뷰어에서 이 열을 숨길 수 있는지 여부입니다. 텍스트 선택기 및 시간 프레임 열을 제외한 모든 열에 유효합니다.
아니요
부울
true
EditableOnSheet
시트에서 디멘션 열에 새 값을 추가할 수 있는지 여부입니다. 디멘션 및 텍스트 선택기 열에만 유효합니다.
아니요
부울
false
필수
각 행의 값이 이 열에 있어야 하는지 여부입니다. AllowHidden이 false인 디멘션 열에만 유효합니다.
아니요
부울
false
recalculateOnMatch
매칭 시 값을 재계산할지 여부입니다. recalculateOnDemand가 true인 시트에 대해서만 유효한 디멘션 및 텍스트 선택기 열입니다.
아니요
부울
false
lookupTables
스프레드 및 값 룩업을 정의하는 LookupTable 오브젝트의 목록입니다. 디멘션 및 텍스트 선택기 열에만 유효합니다.
아니요
LookupTable
null
값
텍스트 선택기 값으로 추가할 문자열 목록입니다. 텍스트 선택기 열에만 유효합니다.
아니요
string형 배열
null
rowKey
이 열을 행 키로 사용할 수 있는지 여부입니다. 텍스트 드라이버 열에만 유효합니다.
아니요
부울
false
displayAs
열의 표시 형식 형식입니다. 숫자 드라이버 열에만 유효합니다.
가능한 값: NUMBER, PERCENT, CURRENCY
아니요
DisplayAs
false
decimalPrecision
표시할 소수 자릿수입니다. 숫자 드라이버 열에만 유효합니다.
가능한 값: 0 ~ 9 또는 -1(CURRENCY로 표시되는 경우 통화 소수 자릿수를 사용하는 경우)
아니요
정수
0
showToggle
확인란 열을 전환으로 표시할지 여부입니다. 확인란 열에만 유효합니다.
아니요
부울
false
showInEditMode
모델링 시트의 편집가능한 행에 열을 표시할지 여부입니다. 레벨 통화 열에만 유효합니다.
아니요
부울
false
referenceTimePeriod
표시 열의 참조 기간을 나타냅니다. 계정 표시 열에만 유효합니다.
가능한 값: FIRST_NON_ACTUALS_PERIOD, START_OF_PLAN
아니요
문자열
FIRST_NON_ACTUALS_PERIOD
startOfRollupRange
표시 열의 기간 롤업 범위를 시작할 위치를 나타냅니다. 계정 표시 열에만 유효합니다.
가능한 값: CONTAINING_REFERENCE_PERIOD, BEFORE_REFERENCE_PERIOD, AFTER_REFERENCE_PERIOD
아니요
문자열
CONTAINING_REFERENCE_PERIOD
timePeriodsInRollupRange
표시 열의 롤업 범위에 포함할 기간 수입니다. 계정 표시 열에만 유효합니다.
아니요
정수
1
startOfRollupRangeTimeStratumCode
표시 열에 대한 롤업 범위의 시작을 결정할 기간 코드입니다. 계정 표시 열에만 유효합니다. 가능한 값에는 시트 시간 단위보다 크거나 같은 시간 단위가 포함됩니다.
아니요
문자열
시트 시간 단위
accountCode
표시 열의 모델링 계정을 결정하는 계정의 코드입니다. 표시 열에만 유효합니다. 유효한 값만 지정된 모델링 시트의 계정입니다.
아니요
문자열
시트 열 룩업 테이블 오브젝트
이름
설명
필수
유형
기본값
이름
룩업 테이블명
예
문자열
displayAs
이 룩업 테이블의 표시 형식 형식입니다. 가능한 값은 NUMBER 및 PERCENT입니다. 값 룩업 테이블에만 유효합니다.
아니요
문자열
NUMBER
decimalPrecision
이 룩업 테이블에 있는 값의 소수 자릿수입니다. 가능한 값은 0~9입니다.
아니요
정수
0
type
룩업 테이블의 유형입니다. 가능한 값은 VALUE, SPREAD입니다.
예
문자열
시트 계정 오브젝트
자세한 내용은 다음을 참조하십시오. Reference: Properties in Account JSON Import Payload
이름
설명
필수
이름
계정명
예
코드
계정 코드
예
parent
parent 계정
아니요
설명
계정 설명
아니요
isCumulative
계정이 누적 계정인지 여부를 반환합니다.
아니요
isActualsByDelta
델타 기준 계정이 실제값인지 여부를 반환합니다.
아니요
isLink
계정이 링크 계정인지 여부를 반환합니다.
아니요
timeRollupType
시간 롤업에 대해 수행할 롤업 유형입니다.
아니요
timeWeightAccount
시간 롤업에 사용되는 가중치 계정입니다.
아니요
levelDimRollupType
레벨/커스텀 디멘션 롤업에 대해 수행할 롤업 유형입니다.
아니요
levelDimWeightAccount
레벨/커스텀 디멘션 롤업에 사용되는 가중치 계정입니다.
아니요
levelDimRollupText
레벨/커스텀 디멘션 롤업에 사용되는 롤업 텍스트 값입니다.
아니요
actualsOverlay
계정에 대한 실제값 오버레이 설정
아니요
attributeValues
이 계정의 계정 특성 값 오브젝트 목록입니다.
아니요
displayAs
계정에 대한 표시 형식 설정입니다.
아니요
수식
계정 수식
아니요
weightedAverageTranslationsEnabled
계정에 가중 평균 환산이 활성화되어 있는지 여부를 반환합니다.
아니요
weightedAverageTranslationResetStratum
이 계정의 WAT Rest 시간 단위입니다.
아니요
weightedAverageTranslationTransferAccount
이 계정의 WAT 이전 계정입니다.
아니요
decimalPrecision
계정의 기본 소수 자릿수입니다.
아니요
exchangeRateType
이 계정의 환율 유형입니다.
아니요
값이 0인 항목 표시 안함
시트의 계정에 대해 값이 0인 행을 표시하지 않아야 하는지 여부를 반환합니다.
아니요
startExpanded
계정이 시트에서 확장된 상태로 시작되는지 여부를 반환합니다.
아니요
dataEntryType
이 계정의 데이터 입력 유형 설정입니다.
아니요
dataPrivacy
이 계정의 데이터 보호 설정입니다.
아니요
hasSalaryDetail
계정에 급여 세부내용이 있는지 여부를 반환합니다.
아니요
isBreakbackEligible
이 계정에 분산이 적합한지 여부를 반환합니다.
아니요
isSystemAccount
이 계정이 시스템 계정인지 여부를 반환합니다.
아니요
isIntercompany
이 계정이 관계회사 계정인지 여부를 반환합니다.
아니요
is가정
계정이 가정인지 여부를 반환합니다.
아니요
isMetric
계정이 메트릭 계정인지 여부를 반환합니다.
아니요
modeledSheetSpreadCode
연결된 모델 스프레드의 모델링 시트 스프레드 코드입니다.
아니요
spreadTargetAccount
스프레드 계정의 대상 계정 오브젝트입니다.
아니요
시트 액세스 권한 설정 오브젝트
이름
설명
필수
유형
기본값
사용자명
시트에 추가할 사용자명 목록입니다.
유효한 이메일 주소 형식이어야 합니다.
아니요
string형 배열
excludedFromWorkflow
시트 접근성 설정의
워크플로에서 제외
확인란 업데이트
아니요
부울
false
샘플 응답
204
상태 코드 204와 함께 성공한 응답이 비어 있습니다.

DELETE

요청 URI
/sheet/modeled/definition
지정된 쿼리 매개변수와 일치하는 모델링 시트 정의를 삭제합니다. ID가 일치하는 시트가 없으면 찾을 수 없음 오류가 발생합니다.
이름별 샘플 요청
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/modeled/definition?name=Capital Model
샘플 요청 헤더
Accept-Language: ko
샘플 요청 본문
<없음>
쿼리 매개변수
이름
설명
필수
이름
모델링 시트의 이름입니다.
아니요
instanceCode
값을 검색할 instanceCode입니다. 예를 들어, GLOBO입니다. instanceCode를 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다.
아니요
샘플 응답
204
상태 코드 204를 사용하여 성공한 응답이 비어 있습니다.

POST

요청 URI
/sheet/modeled/definition/validate
모델링 시트 정의 요청을 검증합니다.
이름별 샘플 요청
https://api.adaptiveplanning.com/api/rest/modeling/v1/default/sheet/modeled/definition/validate?name=My Sheet
샘플 요청 헤더
Accept-Language: ko
샘플 요청 본문
<아래 문서>
쿼리 매개변수
검증 중인 상대 엔드포인트를 확인합니다(예: PATCH).
요청 본문
샘플 요청 본문
동일한 모델링 시트 정의 형식이 검증 중인 엔드포인트의 JSON 페이로드로 사용됩니다. 그러나 오브젝트
validationOptions
검증 요청을 전송할 때 페이로드에 필수입니다.
요청 형식
 
{

  "validationOptions": {
      "httpMethod": "Patch",
      "dependentDimensions": [
          "MyTestDim1", "MyTestDim2"
      ],
      "dependentAttributes": [
          {
              "attributeName": "MyTestAttr1",
              "attributeType": "DIMENSION_ATTRIBUTE",
              "dimensionName": "MyTestDim2"
          },
          {
              "attributeName": "MyTestAttr2",
              "attributeType": "LEVEL_ATTRIBUTE"
          }
      ]
  },

  "properties": {
      "description": "Capital Model",
      "prefix": "Capital"
  },
  "columns": [
      {
          "properties": {
              "code": "Base Pay",
              "name": "Base Pay",
              "type": "TEXT_SELECTOR",

...
검증 옵션 오브젝트
이름
설명
필수
httpMethod
검증 중인 모델링 시트 API 엔드포인트를 지정합니다. 현재 다음 엔드포인트를 지원합니다.
  • PATCH
예
dependentDimensions
검증을 위해 존재하는 것으로 가정할 디멘션명의 목록입니다. 검증 요청의 결과로 디멘션이 저장되지 않습니다. 모든 종속 커스텀 디멘션이 비계층인 것으로 가정합니다.
아니요
dependentAttributes
종속 특성 오브젝트 목록 특성은 검증 요청의 결과로 유지되지 않습니다.
아니요
종속 특성 오브젝트
이름
설명
필수
attributeName
종속 특성의 이름입니다.
예
attributeType
종속 특성의 유형입니다. 지원되는 유형은 다음과 같습니다.
  • LEVEL_ATTRIBUTE
  • DIMENSION_ATTRIBUTE
예
dimensionName
종속 특성에 대한 디멘션의 이름입니다. 디멘션 특성에만 적용되며 필수입니다. 레벨 특성에는 허용되지 않습니다.
아니요