주 컨텐츠로 이동
Adaptive Planning
최종 업데이트: 2023-06-23
버전

버전

URL 엔드포인트

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/versions
HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/cloneVersion
(POST만 해당)
버전: v1
카테고리
메타데이터 제출, 수정 및 검색
설명
메타데이터 수정
호출에 필요한 권한
모델 관리
모델
요청 시 필수 매개변수
엔드포인트에 따라 다름:
PATCH, POST, DELETE: 버전명입니다.
없음 - GET

지원되는 HTTP 동사

(참고: 버전 폴더는 아래 엔드포인트에 대해 지원되지 않습니다.)
HTTP Verb
단일 리소스
수금 리소스
설명
GET
미지원
지원됨
테넌트의 모든 버전을 검색합니다.
DELETE
지원됨
미지원
기존의 삭제 가능한 버전을 삭제합니다.
PATCH
지원됨
미지원
실제값 버전을 생성/업데이트하거나 계획 버전을 업데이트합니다.
POST
지원됨
미지원
신규 계획 버전을 생성합니다.

GET

요청 URI
/api/rest/modeling/v1/{tenant}/versions:
테넌트의 모든 버전을 검색합니다.
목록에 있는 테넌트의 모든 버전을 검색합니다.
특정 버전의 UI에 표시되지 않는 속성은 응답의 해당 버전 오브젝트에 포함되지 않습니다. 예를 들어, 하위 실제값 버전의 경우 startOfVersion입니다.
'limit' 및 'offset' 매개변수를 통해 페이지 번호 매기기를 사용할 수 있습니다.
다음 버전 속성은 현재 GET에서 지원되지/표시되지 않습니다.
기본 버전(가상 버전의 경우), 고정 환율 통화 리포트 활성화(가상 버전의 경우)
수식 값 계산, 관리자 액세스, 사용자 액세스, 편집가능한 시트 액세스, 권한 있는 실제값 액세스, 그룹, 그룹 액세스 레벨
샘플 요청 URI:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?limit=25&offset=1
샘플 요청 본문:
<비워두기>
쿼리 매개변수:
이름
설명
필수
limit
단일 응답의 최대 오브젝트 수입니다.
아니요
offest
응답 컬렉션에 있는 첫 번째 오브젝트의 인덱스(0부터 시작)입니다. 기본값은 0입니다.
오프셋을 한도 매개변수와 함께 사용하여 응답 컬렉션의 페이징을 제어합니다.
아니요
경로 매개변수:
이름
설명
필수
테넌트
작업할 테넌트입니다(예: GREENCO).
샘플 응답
200 OK
참고: 실제값 버전의 경우 버전 시작 및 계획 버전의 경우 왼쪽 스크롤 제한은 모두 startOfVersion 속성(포인터 A) 아래에 표시됩니다.
마찬가지로 실제값 버전의 경우 버전 종료 및 계획 버전의 경우 계획 종료가 모두 endOfVersion 속성(포인터 D) 아래에 표시됩니다.
실제값 버전의 경우 시작 스크롤 위치 및 계획 버전의 경우 계획 시작은 모두 BeginningScrollLocation 속성(포인터 C) 아래에 표시됩니다.
응답이 완료되었습니다.
샘플 응답
{ "data": [ { "name": "Test-Actuals-Version", "shortName": "Test-Actuals-Version-Shortname", "versionType": "ACTUALS", ... "lockLeadingCompletion": true }, { "name": "JE Sub under Actuals", "shortName": "JE01", "parent": "Actuals", ... "journalEntryVersion": true, "journalEntryVersionProperties": { "journalEntryNumbering": "N", "startingNumber": 0 }, ... }, ... ], "limit": 12, "offset": 4, "total": 12 }

DELETE

요청
/api/rest/modeling/v1/{tenant}/versions:
기존 버전을 삭제합니다.
지정된 버전명이 있는 버전을 삭제합니다.
root 실제값 버전과 기본 버전은 삭제할 수 없습니다.
샘플 요청 URI:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}
샘플 요청 본문:
<비워두기>
쿼리 매개변수
이름
설명
필수
versionName
삭제할 기존 버전의 이름입니다.
instanceCode
값을 검색할 instanceCode입니다. 예를 들어, GLOBO입니다. instanceCode를 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다.
아니요
경로 매개변수
이름
설명
필수
테넌트
작업할 테넌트입니다(예: GREENCO).
샘플 응답
204 NO_CONTENT
상태 코드 204를 사용하여 성공한 응답이 비어 있습니다.

PATCH

요청:
/api/rest/modeling/v1/{tenant}/versions:
실제값 버전을 생성/업데이트하거나 계획 버전을 업데이트합니다.
지정된 버전 ID가 있는 경우 기존 실제값/계획 버전을 업데이트합니다. 그렇지 않은 경우 해당 ID를 사용하여 신규 실제값 버전을 생성합니다.
현재 쿼리 매개변수를 통해 지원되는 두 가지 버전 ID 세트가 있습니다.
- 버전명
각 호출의 URL에는 위의 쿼리 매개변수 중 하나만 지정해야 합니다.
샘플 요청 URI:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/versions?versionName={versionName}
요청 본문
- 기존 버전에 대해 업데이트하거나 생성할 신규 버전에 대해 지정할 버전 속성을 포함하는 JSON입니다.
업데이트:
- 업데이트의 경우 요청 본문에 특정 속성(versionType 제외)이 필요하지 않지만 요청 본문은 계속 필요합니다.
POST
의 요청 본문 섹션에는 다양한 유형의 계획 버전에 대한 속성 목록이 간략하게 나와 있습니다.
- 표시기 속성(예: JournalEntryVersion)은 업데이트할 수 없습니다. 그러나 변경되지 않은 올바른 값이 있으면 요청 본문에 계속 남아 있을 수 있습니다.
- 현재 상위 항목 업데이트는 지원되지 않습니다.
- leaf가 아닌 버전(하위 버전이 있는 버전)을 업데이트할 때 이러한 버전의 사용자 그룹은 'FULL_ACCESS' 또는 'HIDDEN' 액세스 유형만 가질 수 있습니다. 'FULL_ACCESS'는 UI에서 '가시가능'으로 표시되며 이에 해당합니다.
-그룹 액세스 세부내용(그룹 ID 및 그룹 액세스 레벨)은 업데이트 호출의 요청 본문에서 groupId=0을 지정하여 제거할 수 있습니다.
다음을 생성합니다.
- 생성의 경우 요청 본문의 사양에 다음 속성을 사용할 수 있습니다.
속성
설명
필수(실제값의 경우)
필수(분개용)
요청 본문의 속성명
값 유형
기본값
약식 이름
버전 약식 이름
아니요
아니요
shortName
String
빈 문자열
parent 항목
이 버전의 parent입니다.
아니요
아니요
parent
문자열(버전명)
root 실제값 버전
버전 유형
버전 유형(ACTUALS 또는 PLANNING)
Y, 실제값
Y, 실제값
versionType
String
설명
설명
아니요
아니요
설명
String
빈 문자열
관리자 액세스
관리자의 버전 액세스 레벨
아니요
아니요
AdministratorsAccess
VersionAccessControl
상위 항목에서 상속됨
사용자 액세스
사용자의 버전 액세스 레벨
아니요
아니요
userAccess
VersionAccessControl
상위 항목에서 상속됨
실제값 특수 액세스
실제값 특수 액세스 권한이 있는 모든 사용자의 버전 액세스 레벨
아니요
아니요
privilegedActualsAccess
VersionAccessControl
상위 항목에서 상속됨
그룹 ID
지정된 사용자 그룹 ID
아니요
아니요
groupId
정수
상위 항목에서 상속됨
그룹 액세스 레벨
지정된 사용자 그룹의 버전 액세스 레벨입니다.
그룹 ID가 지정된 경우 Y
그룹 ID가 지정된 경우 Y
groupAccessLevel
VersionAccessControl
상위 항목에서 상속됨
감사 추적
감사 추적 정보 유지/삭제
아니요
아니요
auditTrail
부울
false(분개 버전의 경우 parent 항목에서 상속됨)
분개 버전
생성할 버전이 분개인지 여부
아니요
Y, true
journalEntryVersion
부울
returnId
버전 ID가 true로 설정된 경우 버전 ID를 반환합니다. 신규 버전 ID(작업으로 인해 신규 버전이 생성된 경우) 그렇지 않으면 업데이트된 기존 버전의 ID를 반환합니다.
아니요
아니요
returnId
부울
false(false인 경우 204 No Content를 반환하고, true로 설정된 경우 응답에 version과 함께 200 OK를 반환함)
- VersionAccessControl 값 유형은 'HIDDEN', 'LOCKED', 'LOCKED_EXCEPT_NOTES', 'IMPORT_AND_NOTES', 'FULL_ACCESS' 문자열 값을 사용할 수 있습니다.
- 그룹 ID는 exportGroups 공용 API를 통해 얻을 수 있습니다.
- 연결회계가 비활성화된 회사에는 분개 버전이 지원되지 않습니다.
분개 버전 속성:
다음 속성은 JournalEntryVersionProperties 중첩 오브젝트 아래에 있으며(샘플 요청 본문 참조) JE 버전에만 사용됩니다.
속성
설명
필수(실제값)
필수(분개)
요청 본문의 속성명
값 유형
기본값
분개 번호 매기기
분개에 번호를 매기는 방법을 지정합니다. 자동(A), 수동(M) 또는 없음(N)일 수 있습니다.
미사용
아니요
journalEntryNumbering
String
없음(N)
접두어
JE 번호의 접두어
미사용
분개 번호 매기기가 자동(A) 또는 수동(M)인 경우 Y
접두어
String
시작 번호
JE 번호 매기기의 시작 번호
미사용
분개 번호 매기기(A)인 경우 Y
startNumber
정수
root 실제값별 속성:
다음 속성은 root 실제값을 업데이트할 때만 사용됩니다.
속성
설명
필수
요청 본문의 속성명
값 유형
버전 시작
버전 시작
아니요
startOfVersion
문자열(기간 코드)
버전 종료
버전 종료
아니요
endOfVersion
문자열(기간 코드)
스크롤 시작 위치
버전의 스크롤 시작 위치
아니요
startingScrollLocation
문자열(기간 코드)
실제값 표시 종료일
계획 버전의 실제값 오버레이가 중지되는 경우
아니요
completedValuesThrough
문자열(기간 코드)
워크플로 사용
이 옵션을 설정하면 워크플로에서 레벨별로 실제값을 제출할 수 있습니다.
아니요
endableWorkflow
부울
샘플 요청 본문:
요청 본문
{ "parent": "Parent Version", "versionType": "ACTUALS", ... "administratorsAccess": "FULL_ACCESS", "usersAccess": "IMPORT_AND_NOTES", ... ... "auditTrail": true }
중첩 속성이 있는 버전의 경우 샘플 요청 본문(분개 버전 및 가상 버전):
요청 본문
{ "parent": "Actuals", "versionType": "ACTUALS", "shortName": "test JE version", "journalEntryVersion": "true", "journalEntryVersionProperties": { "journalEntryNumbering": "A", "prefix": "JE-Prefix", "startingNumber": "25" }, ... "auditTrail": true }
쿼리 매개변수:
이름
설명
필수
versionName
생성할 신규 버전 또는 업데이트할 기존 버전의 이름입니다.
proceedWithWarnings
경고 메시지를 무시하는 데 사용되는 옵션 쿼리 매개변수입니다. true로 설정하지 않으면 호출이 실행되기 전에 잠재적인 경고가 반환됩니다. URL에서 이 매개변수를 true로 지정하여 무시합니다.
아니요
instanceCode
값을 검색할 instanceCode입니다. 예를 들어, GLOBO입니다. instanceCode를 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다.
아니요
경로 매개변수:
이름
설명
필수
테넌트
작업할 테넌트입니다(예: GREENCO).
게시 액세스 속성:
다음 요청 본문 속성은 WD가 활성화된 경우에만 사용됩니다.
샘플 응답
204 NO_CONTENT
상태 코드 204를 사용하여 성공한 응답이 비어 있습니다.

POST

요청:
/api/rest/modeling/v1/{tenant}/cloneVersion:
새 계획 버전을 생성합니다.
소스/기본 버전을 복제하여 신규 계획 또는 예측 버전을 생성하거나 가상 버전을 생성합니다.
현재 쿼리 매개변수를 통해 지원되는 두 가지 버전 ID 세트가 있습니다.
-신규 버전명
각 호출의 URL에 위의 항목 중 하나만 지정해야 합니다.
샘플 요청 URI:
HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/DACCO/cloneVersion?newVersionName=Budget 2012& sourceVersionName=Budget 2011& copyAllData=true& copySharedFormulasAndRules=true& copyAllOverrideFormulas=false
요청 본문:
생성할 신규 버전에 대해 지정할 버전 속성이 포함된 JSON입니다.
이름
설명
필수(계획용)
필수(예측용)
필수(가상)
요청 본문의 속성명
값 유형
기본값
약식 이름
버전 약식 이름
아니요
아니요
아니요
shortName
String
빈 문자열
parent 항목
이 버전의 parent 폴더입니다.
아니요
아니요
아니요
parent
문자열( 폴더명)
버전 유형
버전 유형(ACTUALS 또는 PLANNING)
Y, 계획
Y, 계획
Y, 계획
versionType
String
설명
설명
아니요
아니요
아니요
설명
String
빈 문자열
잠긴 버전
마스터 수식 및 기타 계정 수식을 포함하여 모든 사용자에 대해 전체 버전을 잠급니다.
아니요
미사용
미사용
lockedVersion
부울
소스 버전에서 상속됨
수식 값 계산
잠긴 버전이 선택된 계획 버전에 사용할 수 있습니다. 대부분의 계정에서 수식 및 참조의 계산 결과를 유지하고 잠긴 버전의 성능을 높이는 데 사용됩니다.
아니요
미사용
미사용
calculateFormulaValues
부울
false
관리자 액세스
관리자의 버전 액세스 레벨
아니요
아니요
아니요
AdministratorsAccess
VersionAccessControl
소스 버전에서 상속됨(계획) IMPORT_AND_NOTES(예측); 잠김(가상)
사용자 액세스
사용자의 버전 액세스 레벨
아니요
아니요
아니요
usersAccess
VersionAccessControl
소스 버전에서 상속됨(계획) IMPORT_AND_NOTES(예측); 잠김(가상)
편집가능한 시트 액세스
편집가능한 시트 액세스 권한이 있는 모든 사용자의 버전 액세스 레벨
아니요
아니요
아니요
EditableSheetAccess
VersionAccessControl
소스 버전에서 계승됨(계획, 예측)
그룹 ID
지정된 사용자 그룹의 ID
아니요
아니요
아니요
groupId
정수
소스 버전에서 계승됨(계획, 예측)
액세스 레벨
지정된 사용자 그룹의 버전 액세스 레벨입니다.
아니요
아니요
아니요
groupAccessLevel
VersionAccessControl
소스 버전에서 계승됨(계획, 예측)
왼쪽 스크롤 제한
버전의 왼쪽 스크롤 제한입니다.
아니요
아니요
미사용
startOfVersion
문자열(기간 코드)
소스 버전에서 상속됨
계획 종료
계획 종료
아니요
아니요
미사용
endOfPlan
문자열(기간 코드)
소스 버전에서 상속됨
계획 시작
계획 시작
아니요
아니요
미사용
startOfPlan
문자열(기간 코드)
소스 버전에서 상속됨
선행 기간 잠금
지정된 데이터 기간을 버전에서 편집불가능하게 설정합니다. UI에 '선행 {leaf 시간 단위} 잠금'으로 표시됩니다.
아니요
미사용
미사용
lockLeadingTimePeriod
문자열(기간 코드)
소스 버전에서 상속됨
선행 완료 잠금
위 속성에 대한 '{leaf 시간 단위} 완료' 옵션 요청 본문에서 이 속성과 '선행 기간 잠금'을 모두 지정할 수 없습니다.
아니요
미사용
미사용
lockLeadingCompletion
부울
소스 버전에서 상속됨
기본값
버전을 모든 사용자에 대한 기본 버전으로 설정합니다.
아니요
미사용
미사용
기본값
부울
false
감사 추적
감사 추적 정보 유지/삭제
아니요
아니요
미사용
auditTrail
부울
소스 버전에서 상속됨
실제값 오버레이에 사용불가 레벨 포함
더 이상 사용되지 않는 레벨을 포함하여 모든 레벨을 실제값 오버레이에 표시합니다.
아니요
아니요
미사용
actualsOverlayIncludesUnavailableLevels
부울
false
오버레이용 실제값 버전
계획 데이터를 지정된 실제값 버전의 데이터로 오버레이합니다.
아니요
아니요
미사용
actualsVersionOverlay
문자열(버전명)
root 실제값 버전
트랜잭션 ID로 드릴
버전의 트랜잭션으로 드릴할 수 있습니다.
아니요
아니요
미사용
drillIntoTransactionId
정수
기본 리포트
예측 버전
생성할 버전이 예측 버전인지 여부
미사용
Y, true
미사용
predictiveVersion
부울
가상 버전
생성할 버전이 가상 버전인지 여부
미사용
미사용
Y, true
virtualVersion
부울
returnId
true로 설정된 경우 버전 ID를 반환합니다. 신규 버전 ID(작업으로 인해 신규 버전이 생성된 경우) 그렇지 않으면 업데이트된 기존 버전의 ID를 반환합니다.
아니요
아니요
아니요
returnId
부울
false(false로 204 No Content를 반환하고, true로 설정된 경우 응답에 버전이 포함된 200 OK를 반환함)
- VersionAccessControl 값 유형은 'HIDDEN', 'LOCKED', 'LOCKED_EXCEPT_NOTES', 'IMPORT_AND_NOTES', 'FULL_ACCESS' 문자열 값을 사용할 수 있습니다.
- 잠긴 계획 버전에서는 사용자 그룹에 대해 'IMPORT_AND_NOTES' 또는 'FULL_ACCESS'를 설정할 수 없습니다.
- 예측 버전에서는 사용자 그룹에 대해 'FULL_ACCESS'를 설정할 수 없습니다.
- 가상 버전에서는 사용자 그룹에 대해 'HIDDEN' 또는 'LOCKED'만 설정할 수 있습니다.
- 계획 없이 연결회계가 활성화된 회사에 대해서는 계획 및 예측 버전을 생성할 수 없습니다.
버전 가상 속성
다음 속성은 가상 버전 속성 중첩 오브젝트 아래에 있으며 가상 버전에만 사용됩니다.
이름
설명
필수(계획용)
필수(예측용)
필수(가상)
요청 본문의 속성명
값 유형
기본값
기본 버전
가상 버전의 기본 데이터를 제공할 버전입니다. 가상 버전 또는 하위 실제값 버전일 수 없습니다.
미사용
미사용
아니요
baseVersion
문자열(버전명)
기본 버전
환율 버전
고정 환율 통화 리포트에 사용되는 가상 버전의 환율을 제공하는 버전입니다. 가상 버전 또는 하위 실제값 버전일 수 없습니다.
미사용
미사용
아니요
exchangeRateVersion
문자열(버전명)
root 실제값 버전
고정 환율 통화 리포트 사용
고정 환율 통화 리포트를 활성화/비활성화합니다.
미사용
미사용
아니요
enableConstantCurrencyReporting
부울
false
오프셋
뒤로(양의 정수) 또는 앞으로(음의 정수) 오프셋 금액입니다.
미사용
미사용
아니요
offset
정수
0
게시 액세스 속성
다음 요청 본문 속성은 WD가 활성화된 경우에만 사용됩니다.
이름
설명
필수(계획용)
필수(예측용)
필수(가상)
요청 본문의 속성명
값 유형
기본값
재무 계획
이 버전에 대한 재무 계획을 활성화/비활성화합니다.
Adaptive Planning for Financial Plans가 활성화된 경우에만 사용됩니다.
아니요
미사용
미사용
financialPlans
부울
false
헤드카운트 계획
이 버전에 대한 인력 계획을 활성화/비활성화합니다.
Adaptive Planning for Financial Plans 또는 Adaptive Planning for the Workforce가 활성화된 경우에만 사용됩니다.
아니요
미사용
미사용
headcountPlans
부울
false
인력 액션 계획
이 버전에 대해 인력 액션 계획을 활성화/비활성화합니다.
Adaptive Planning for the Workforce가 활성화된 경우에만 사용됩니다.
아니요
미사용
미사용
workforceActionPlans
부울
false
샘플 요청 본문
요청 본문
{ "parent": "Parent Folder", "versionType": "PLANNING", "description": "Test Plan Version", ... ... "usersAccess": "LOCKED_EXCEPT_NOTES", "editableSheetAccess": "LOCKED", ... "startOfVersion": "2012", "endOfVersion": "2013", "startingScrollLocation": "01/2012", "lockLeadingTimePeriod": "02/2012", "actualsOverlayIncludesUnavailableLevels": true }
쿼리 매개변수
이름
설명
필수(계획용)
필수(예측용)
필수(가상)
URL의 매개변수명
기본값
소스 버전명
복제할 소스 버전의 이름입니다. 지정하지 않으면 기본 버전에서 복제합니다.
아니요
아니요
미사용
sourceVersionName
신규 버전명
생성할 신규 버전의 이름입니다.
newVersionName
모든 데이터 복사
true인 경우 모든 데이터를 복사합니다.
아니요
미사용
미사용
copyAllData
false
공유 수식 및 규칙 복사
true인 경우 공유 수식 및 규칙을 복사합니다.
아니요
미사용
미사용
copySharedFormulasAndRules
false
모든 재정의 수식 복사
true인 경우 모든 재정의 수식을 복사합니다.
아니요
아니요
미사용
copyAllOverrideFormulas
false
GL 및 커스텀 계정의 분할 복사
true인 경우 GL 및 커스텀 계정에서 분할을 복사합니다.
아니요
미사용
미사용
copySplitsInGLAndCustomAccounts
false
모델링된 행 복사
true인 경우 모델링된 행을 복사합니다.
아니요
미사용
미사용
copyModeledRows
false
셀, 시트 및 워크플로 메모 복사
true인 경우 셀, 시트 및 워크플로 메모를 복사합니다(해당하는 경우).
아니요
미사용
미사용
copyAllNotes
false
워크플로 상태를 진행 중으로 재설정
true인 경우 워크플로 상태를 진행중으로 재설정합니다.
아니요
미사용
미사용
resetWorkflowStatusToInProgress
false
감사 추적 이력 복사
true인 경우 모든 리포트에 리포트 매개변수 선택항목으로 추가됩니다.
미사용
미사용
copyAuditTrailHistory
false
모든 리포트에 리포트 매개변수 선택으로 추가
true인 경우 모든 리포트에 리포트 매개변수 선택항목으로 추가됩니다.
아니요
미사용
미사용
addAsReportParameterChoiceToAllReports
false
재계산된 시트 값 복사
true인 경우 시트의 재계산된 값을 복사합니다.
아니요
미사용
미사용
copyRecalculatedValuesOfSheets
false
경고가 발생해도 계속 진행
경고 메시지를 무시하는 데 사용되는 옵션 쿼리 매개변수입니다. true로 설정하지 않으면 호출이 실행되기 전에 잠재적인 경고가 반환됩니다. URL에서 이 매개변수를 true로 지정하여 무시합니다.
아니요
아니요
아니요
proceedWithWarnings
false
인스턴스 코드
값을 검색할 instanceCode입니다. 예를 들어, GLOBO입니다. instanceCode를 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다.
아니요
아니요
아니요
instanceCode
사용자의 기본 인스턴스입니다.
- 워크플로가 비활성화된 회사의 경우 '워크플로 상태를 진행중으로 재설정'이 지원되지 않습니다.
-모델 ISOLATION 기능 플래그가 해제된 경우 '시트의 재계산 값 복사'가 지원되지 않습니다.
경로 매개변수:
이름
설명
필수
테넌트
작업할 테넌트입니다(예: GREENCO).
샘플 응답:
204 NO_CONTENT
상태 코드 204를 사용하여 성공한 응답이 비어 있습니다.