주 컨텐츠로 이동
문서
문서
Adaptive Planning
최종 업데이트: 2023-06-23
큐브 시트 정의

큐브 시트 정의

URL 엔드포인트

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

지원되는 HTTP 동사

HTTP Verb
단일 리소스
설명
PATCH
지원됨
큐브 시트 정의 삽입 또는 업데이트
DELETE
지원됨
큐브 시트 정의 삭제
옵션
지원됨
이 컬렉션 리소스에 대해 지원되는 HTTP Verb 목록을 반환합니다.

PATCH

요청 URI
/sheet/cube/definition
제공된 쿼리 매개변수와 일치하는 큐브 시트 정의를 업데이트하십시오.
이름이 일치하는 시트가 없으면 지정된 속성을 사용하여 새 큐브 시트가 생성됩니다.
이름별 샘플 요청
https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/cube/definition?name=Sales Cube
샘플 요청 헤더
Accept-Language: ko
샘플 요청 본문
요청 본문 섹션을 참조하십시오.
쿼리 매개변수
이름
설명
필수
instanceCode
값을 검색할 instanceCode입니다. 예를 들어, GLOBO입니다. instanceCode를 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다.
아니요
이름
시트의 이름입니다.
아니요
reorderColumns
이 쿼리 매개변수를 true로 설정하면 API 요청 본문에 지정된 열의 순서를 반영하도록 열 목록의 순서가 변경됩니다. 기본적으로 false로 설정됩니다. 참조 Reference: Re-ordering Columns for Modeled and Cube Sheet Definition JSON APIs.
아니요
요청 본문
샘플 요청 본문
동일한 큐브 시트 정의 형식이 두 엔드포인트 모두에 대한 JSON 페이로드로 사용됩니다.
요청 형식
 
{
   "properties": {
       "description": "Expense Cube",
       "prefix": "Expense",
       "horizontalAxis": {
           "type": "level"
       },
       "verticalAxis": [
           {
               "type": "account"
           },
           {
               "type": "dimension",
               "name": "ProductFurniture"
           }
       ]
   },
   "columns": [
       {
           "properties": {
               "name": "Base Pay",
               "type": "dimension"
           },
           "availability":List<SheetAvaliabilityDTO>,
           "defaultAvailability": false
       }
   ],
   "accounts": [
       {
           "name": "AccountName",
           "code": "AccountCode"
       }
   ],
   "accessibility": {
       "usernames": [ "test@greenco.com" ],
       "excludedFromWorkflow": true
   }
}
요청의 예:
시트 생성 요청의 예
 
{
   "properties": {
       "description": "Test description",
       "prefix": "TestPrefix",
       "horizontalAxis": {
           "type": "level"
       },
       "verticalAxis": [
           {
               "type": "account"
           },
           {
               "type": "dimension",
               "name": "Base Pay"
           }
       ]
   },
   "columns": [
       {
           "properties": {
               "type": "Account"
           },
           "defaultAvailability": true
       },
       {
           "properties": {
               "type": "Level"
           },
           "defaultAvailability": true
       },
       {
           "properties": {
               "type": "Time"
           }
       },
       {
           "properties": {
               "name": "Base Pay",
               "type": "dimension"
           },
           "defaultAvailability": true
       }
   ],
   "accounts": [
       {
           "name": "AccountName",
           "code": "AccountCode",
           "type": "Standard"
       }
   ]
}
시트 정의 오브젝트
이름
설명
필수
속성
일반 시트 속성을 포함하는 오브젝트
아니요
열
큐브 시트 열 오브젝트의 목록입니다.
아니요
계정
계정 오브젝트 목록
아니요
접근성
사용자 지정 시트 액세스 권한 설정을 포함하는 오브젝트
아니요
시트 속성 오브젝트
이름
설명
필수
유형
기본값
설명
시트 설명
아니요
문자열
빈 문자열
접두어
계정 코드에 사용되는 시트 접두어입니다.
아니요
문자열
userAssigned
시트가 사용자 지정 시트인지 또는 레벨 지정 시트(기본값)인지 여부
아니요
부울
false
timeStratumCode
시트의 데이터와 연결된 시간 단위 코드입니다.
아니요
문자열
GL 시간 단위
recalculateOnDemand
시트에 대해 요청시 재계산이 활성화되어 있는지 여부
아니요
부울
false
rearrangeGLAndCustomAccounts
사용자가 큐브 입력 계정을 다른 큐브 계정으로 다시 정렬할 수 있는지 여부 큐브 표준 계정이 있거나 요청에 생성 중인 경우에만 활성화할 수 있습니다.
아니요
부울
false
hideRollupTotals
시트 성능을 개선하기 위해 롤업 합계를 숨길지 여부
아니요
부울
false
horizontalAxis
가로 축의 열을 식별하는 열 참조 오브젝트입니다.
아니요
열 오브젝트
시간
verticalAxis
세로 축의 열을 식별하는 열 참조 오브젝트 목록입니다. 세로 축을 지정하면 이전 선택항목을 모두 덮어씁니다.
아니요
열 오브젝트 배열
계정
maxColumnWidth
각 열의 최대 너비(픽셀)입니다. 10에서 1000 사이여야 하며 너비가 지정되지 않은 경우 0입니다.
아니요
정수
0
SuppressZeroRows
행이 0개인 행을 표시하지 않을지 여부
아니요
부울
false
시트 열 참조 오브젝트
이름
설명
필수
이름
열 이름 커스텀 디멘션 및 특성에 필수입니다.
예
type
열 유형
예
시트 열 오브젝트
이름
설명
필수
속성
시트 열 속성을 포함하는 오브젝트
예
가능일정
현재 열의 시트 사용가능 설정 오브젝트 목록입니다. 참조 Sheet Availability목록 형식에 대한 자세한 내용은 을 참조하십시오.
아니요
defaultAvailability
사용가능 설정에서 달리 지정하지 않는 한, 모든 값에 적용할 기본 사용가능 설정입니다. 레벨 및 디멘션 열에 유효합니다.
아니요
삭제
지정된 시트에서 열 삭제를 요청합니다. 삭제 플래그가 지정되지 않은 기존 열에 종속된 열(예: 디멘션 특성)에는 유효하지 않습니다.
아니요
시트 열 속성 오브젝트
이름
설명
필수
유형
기본값
이름
열 이름 커스텀 디멘션 및 특성 열의 경우, 이름이 각 커스텀 디멘션 또는 특성의 이름과 일치합니다.
예
문자열
type
열 유형입니다.
가능한 값: LEVEL, ACCOUNT, TIME, DIMENSION, LEVEL_ATTRIBUTE, ACCOUNT_ATTRIBUTE, DIMENSION_ATTRIBUTE
예
문자열
initialBalance
초기 잔액을 시트에 표시할지 여부입니다. 시간 열에만 유효합니다.
아니요
부울
true
visibleTimeStratumCodes
시트에 표시되는 시간 단위 목록을 정의합니다. 시간 열에만 유효합니다.
아니요
string형 배열
모든 시간 단위
EditableOnSheet
시트에서 디멘션 열에 새 값을 추가할 수 있는지 여부입니다. 디멘션 및 텍스트 선택기 열에만 유효합니다.
아니요
부울
false
newValueBehavior
새 값이 기본 디멘션에 추가될 때 새 값을 사용할지 여부를 정의합니다. 디멘션 열에만 유효합니다. 지원되는 값: AVAILable, UNAVAILable 또는 PARENT
아니요
문자열
사용가능
시트 열 룩업 테이블 오브젝트
이름
설명
필수
유형
기본값
이름
룩업 테이블명
예
문자열
displayAs
이 룩업 테이블의 표시 형식 형식입니다. 가능한 값은 NUMBER 및 PERCENT입니다. 값 룩업 테이블에만 유효합니다.
아니요
문자열
NUMBER
decimalPrecision
이 룩업 테이블에 있는 값의 소수 자릿수입니다. 가능한 값은 0~9입니다.
아니요
정수
0
type
룩업 테이블의 유형입니다. 가능한 값은 VALUE, SPREAD입니다.
예
문자열
시트 계정 오브젝트
자세한 내용은 다음을 참조하십시오. Reference: Properties in Account JSON Import Payload
이름
설명
필수
이름
계정명
예
코드
계정 코드
예
parent
parent 계정
아니요
유형
계정 유형
예
설명
계정 설명
아니요
shortName
계정 약식 이름
아니요
isCumulative
계정이 누적 계정인지 여부를 반환합니다.
아니요
isPlanByDelta
계정이 델타 기준 계획인지 여부를 반환합니다.
아니요
isActualsByDelta
델타 기준 계정이 실제값인지 여부를 반환합니다.
아니요
isLink
계정이 링크 계정인지 여부를 반환합니다.
아니요
timeRollupType
시간 롤업에 대해 수행할 롤업 유형입니다.
아니요
timeWeightAccount
시간 롤업에 사용되는 가중치 계정입니다.
아니요
levelDimRollupType
레벨/커스텀 디멘션 롤업에 대해 수행할 롤업 유형입니다.
아니요
levelDimWeightAccount
레벨/커스텀 디멘션 롤업에 사용되는 가중치 계정입니다.
아니요
levelDimRollupText
레벨/커스텀 디멘션 롤업에 사용되는 롤업 텍스트 값입니다.
아니요
actualsOverlay
계정에 대한 실제값 오버레이 설정
아니요
attributeValues
이 계정의 계정 특성 값 오브젝트 목록입니다.
아니요
displayAs
계정에 대한 표시 형식 설정입니다.
아니요
수식
계정 수식
아니요
decimalPrecision
계정의 기본 소수 자릿수입니다.
아니요
exchangeRateType
이 계정의 환율 유형입니다.
아니요
값이 0인 항목 표시 안함
시트의 계정에 대해 값이 0인 행을 표시하지 않아야 하는지 여부를 반환합니다.
아니요
startExpanded
계정이 시트에서 확장된 상태로 시작되는지 여부를 반환합니다.
아니요
dataEntryType
이 계정의 데이터 입력 유형 설정입니다.
아니요
dataPrivacy
이 계정의 데이터 보호 설정입니다.
아니요
linkedAccountMappings
LinkedAccountMapping의 목록입니다.
아니요
시트 액세스 권한 설정 오브젝트
이름
설명
필수
유형
기본값
사용자명
시트에 추가할 사용자명 목록입니다.
유효한 이메일 주소 형식이어야 합니다.
아니요
string형 배열
excludedFromWorkflow
시트 접근성 설정의 '워크플로에서 제외' 확인란을 업데이트합니다.
아니요
부울
false
샘플 응답
204
상태 코드 204와 함께 성공한 응답이 비어 있습니다.

DELETE

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