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

시간

URL 엔드포인트

HTTPS://api.adaptiveinsights.com/api/rest/modeling/{version}/{tenant}/updateTime
버전: v1
카테고리
메타데이터 수정
설명
계획의 시간 구조 업데이트
호출에 필요한 권한
캘린더 구성
요청 시 필수 매개변수
해당 없음

지원되는 HTTP 동사

HTTP Verb
설명
POST
작업 매개변수에 따라 계획에서 시간 구조를 다시 로드/업데이트/추가합니다. 작업 매개변수를 지정하지 않으면 추가 작업이 기본값으로 설정됩니다.

POST

요청
/updateTime: 시간 구조를 업데이트합니다.
쿼리 매개변수로 지정된 작업(다시 로드/업데이트/추가)을 기준으로 계획의 시간 구조를 업데이트합니다(작업이 지정되지 않은 경우 기본적으로 추가).
  • 다시 로드: 전체 시간 구조를 다시 로드합니다. 기존 데이터가 모두 지워집니다. 다시 로드를 통해 기본 시간 단위를 설정할 수도 있습니다.
  • 업데이트: 기존 시간 구조를 업데이트합니다(예: 기존 시간 단위의 레이블 변경, 신규 시간 단위 추가 등). 업데이트를 통해 기본 시간 단위를 설정할 수도 있습니다.
  • 추가: 시간 구조에 새 기간을 추가합니다. 기간을 추가할 때 기간을 수정하거나 기간에 대한 새 레벨의 세분화를 추가하거나 기간을 삭제할 수 없습니다.
샘플 요청 URI:
HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/TIMEREALM/updateTime?operation
샘플 요청 헤더
권한 부여: 기본 또는 토큰 기반
Content-Type: application/json
요청 본문
샘플 요청 본문 
{
   "calendars": [
       {
           "name": "DefaultHierarchy",
           "strata": [
               {
                   "code": "month",
                   "label": "Month",
                   "shortName": "Mon"
               },
               {
                   "code": "qtr",
                   "label": "Quarter",
                   "shortName": "Qtr"
               },
               {
                   "code": "year",
                   "label": "Year",
                   "shortName": "Yr"
               }
           ]
       },
       {
           "name": "AltHierarchy",
           "strata": [
               {
                   "code": "month"
               },
               {
                   "code": "altQtr",
                   "label": "AltQuarter",
                   "shortName": "AltQtr"
               },
               {
                   "code": "altYear",
                   "label": "AltYear",
                   "shortName": "AltYr"
               }
           ]
       }
   ],
   "periods": [
       {
           "startDate": "2022-01-01",
           "endDate": "2023-01-01",
           "code": "2022",
           "label": "FY2022",
           "shortName": "2022",
           "stratum": "year"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-04-01",
           "code": "Q1-2022",
           "label": "Q1-FY2022",
           "shortName": "Q1",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-02-01",
           "code": "01/2022",
           "label": "Jan-2022",
           "shortName": "Jan",
           "stratum": "month"
       },
       {
           "startDate": "2022-02-01",
           "endDate": "2022-03-01",
           "code": "02/2022",
           "label": "Feb-2022",
           "shortName": "Feb",
           "stratum": "month"
       },
       {
           "startDate": "2022-03-01",
           "endDate": "2022-04-01",
           "code": "03/2022",
           "label": "Mar-2022",
           "shortName": "Mar",
           "stratum": "month"
       },
       {
           "startDate": "2022-04-01",
           "endDate": "2022-07-01",
           "code": "Q2-2022",
           "label": "Q2-FY2022",
           "shortName": "Q2",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-04-01",
           "endDate": "2022-05-01",
           "code": "04/2022",
           "label": "April-2022",
           "shortName": "April",
           "stratum": "month"
       },
       {
           "startDate": "2022-05-01",
           "endDate": "2022-06-01",
           "code": "05/2022",
           "label": "May-2022",
           "shortName": "May",
           "stratum": "month"
       },
       {
           "startDate": "2022-06-01",
           "endDate": "2022-07-01",
           "code": "06/2022",
           "label": "June-2022",
           "shortName": "June",
           "stratum": "month"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-10-01",
           "code": "Q3-2022",
           "label": "Q3-FY2022",
           "shortName": "Q3",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-08-01",
           "code": "07/2022",
           "label": "July-2022",
           "shortName": "July",
           "stratum": "month"
       },
       {
           "startDate": "2022-08-01",
           "endDate": "2022-09-01",
           "code": "08/2022",
           "label": "Aug-2022",
           "shortName": "Aug",
           "stratum": "month"
       },
       {
           "startDate": "2022-09-01",
           "endDate": "2022-10-01",
           "code": "09/2022",
           "label": "Sept-2022",
           "shortName": "Sept",
           "stratum": "month"
       },
       {
           "startDate": "2022-10-01",
           "endDate": "2023-01-01",
           "code": "Q4-2022",
           "label": "Q4-FY2022",
           "shortName": "Q4",
           "stratum": "qtr"
       },
       {
           "startDate": "2022-10-01",
           "endDate": "2022-11-01",
           "code": "10/2022",
           "label": "Oct-2022",
           "shortName": "Oct",
           "stratum": "month"
       },
       {
           "startDate": "2022-11-01",
           "endDate": "2022-12-01",
           "code": "11/2022",
           "label": "Nov-2022",
           "shortName": "Nov",
           "stratum": "month"
       },
       {
           "startDate": "2022-12-01",
           "endDate": "2023-01-01",
           "code": "12/2022",
           "label": "Dec-2022",
           "shortName": "Dec",
           "stratum": "month"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2024-01-01",
           "code": "2023",
           "label": "FY2023",
           "shortName": "2023",
           "stratum": "year"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-04-01",
           "code": "Q1-2023",
           "label": "Q1-FY2023",
           "shortName": "Q1",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-02-01",
           "code": "01/2023",
           "label": "Jan-2023",
           "shortName": "Jan",
           "stratum": "month"
       },
       {
           "startDate": "2023-02-01",
           "endDate": "2023-03-01",
           "code": "02/2023",
           "label": "Feb-2023",
           "shortName": "Feb",
           "stratum": "month"
       },
       {
           "startDate": "2023-03-01",
           "endDate": "2023-04-01",
           "code": "03/2023",
           "label": "Mar-2023",
           "shortName": "Mar",
           "stratum": "month"
       },
       {
           "startDate": "2023-04-01",
           "endDate": "2023-07-01",
           "code": "Q2-2023",
           "label": "Q2-FY2023",
           "shortName": "Q2",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-04-01",
           "endDate": "2023-05-01",
           "code": "04/2023",
           "label": "April-2023",
           "shortName": "April",
           "stratum": "month"
       },
       {
           "startDate": "2023-05-01",
           "endDate": "2023-06-01",
           "code": "05/2023",
           "label": "May-2023",
           "shortName": "May",
           "stratum": "month"
       },
       {
           "startDate": "2023-06-01",
           "endDate": "2023-07-01",
           "code": "06/2023",
           "label": "June-2023",
           "shortName": "June",
           "stratum": "month"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-10-01",
           "code": "Q3-2023",
           "label": "Q3-FY2023",
           "shortName": "Q3",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-08-01",
           "code": "07/2023",
           "label": "July-2023",
           "shortName": "July",
           "stratum": "month"
       },
       {
           "startDate": "2023-08-01",
           "endDate": "2023-09-01",
           "code": "08/2023",
           "label": "Aug-2023",
           "shortName": "Aug",
           "stratum": "month"
       },
       {
           "startDate": "2023-09-01",
           "endDate": "2023-10-01",
           "code": "09/2023",
           "label": "Sept-2023",
           "shortName": "Sept",
           "stratum": "month"
       },
       {
           "startDate": "2023-10-01",
           "endDate": "2024-01-01",
           "code": "Q4-2023",
           "label": "Q4-FY2023",
           "shortName": "Q4",
           "stratum": "qtr"
       },
       {
           "startDate": "2023-10-01",
           "endDate": "2023-11-01",
           "code": "10/2023",
           "label": "Oct-2023",
           "shortName": "Oct",
           "stratum": "month"
       },
       {
           "startDate": "2023-11-01",
           "endDate": "2023-12-01",
           "code": "11/2023",
           "label": "Nov-2023",
           "shortName": "Nov",
           "stratum": "month"
       },
       {
           "startDate": "2023-12-01",
           "endDate": "2024-01-01",
           "code": "12/2023",
           "label": "Dec-2023",
           "shortName": "Dec",
           "stratum": "month"
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2023-01-01",
           "code": "alt2022",
           "label": "Alt FY2022",
           "shortName": "Alt2022",
           "stratum": "altYear"    
       },
       {
           "startDate": "2022-01-01",
           "endDate": "2022-05-01",
           "code": "altQ1-2022",
           "label": "Alt Q1-FY2022",
           "shortName": "AltQ1",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-05-01",
           "endDate": "2022-07-01",
           "code": "altQ2-2022",
           "label": "Alt Q2-FY2022",
           "shortName": "AltQ2",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-07-01",
           "endDate": "2022-09-01",
           "code": "altQ3-2022",
           "label": "Alt Q3-FY2022",
           "shortName": "AltQ3",
           "stratum": "altQtr"
       },
       {
           "startDate": "2022-09-01",
           "endDate": "2023-01-01",
           "code": "altQ4-2022",
           "label": "Alt Q4-FY2022",
           "shortName": "AltQ4",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2024-01-01",
           "code": "alt2023",
           "label": "Alt FY2023",
           "shortName": "Alt2023",
           "stratum": "altYear"    
       },
       {
           "startDate": "2023-01-01",
           "endDate": "2023-05-01",
           "code": "altQ1-2023",
           "label": "Alt Q1-FY2023",
           "shortName": "AltQ1",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-05-01",
           "endDate": "2023-07-01",
           "code": "altQ2-2023",
           "label": "Alt Q2-FY2023",
           "shortName": "AltQ2",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-07-01",
           "endDate": "2023-09-01",
           "code": "altQ3-2023",
           "label": "Alt Q3-FY2023",
           "shortName": "AltQ3",
           "stratum": "altQtr"
       },
       {
           "startDate": "2023-09-01",
           "endDate": "2024-01-01",
           "code": "altQ4-2023",
           "label": "Alt Q4-FY2023",
           "shortName": "AltQ4",
           "stratum": "altQtr"
       }
   ]
}
쿼리 매개변수
이름
설명
필수
작업
수행하려는 시간 구조 가져오기 작업 다시 로드, 업데이트 또는 추가해야 합니다. 작업을 지정하지 않으면 기본적으로 추가가 수행됩니다.
아니요
proceedWithWarnings
경고 메시지를 무시하는 데 사용되는 옵션 쿼리 매개변수입니다. true로 설정하지 않으면 호출이 실행되기 전에 잠재적인 경고가 반환됩니다. URL에서 이 매개변수를 true로 지정하여 무시합니다.
아니요
skipAwaitCacheRefresh
옵션 쿼리 매개변수입니다. true로 설정하면 캐시가 새로 고쳐질 때까지 기다리지 않고 준비되는 즉시 응답이 반환됩니다.
아니요
페이로드 매개변수
시간 구조 오브젝트
이름
설명
필수
캘린더
가져올 모든 캘린더 오브젝트의 목록입니다. 기본 캘린더가 맨 앞에 와야 합니다. 업데이트 및 추가의 경우 사용자가 기존 캘린더를 모두 포함해야 합니다.
아니요
기간
캘린더에 있는 모든 기간 오브젝트의 목록입니다. 기간은 각 캘린더에 대해 깊이 우선 검색 순서로 나열되어야 합니다. 기본 캘린더의 기간이 맨 앞에 와야 합니다. 대체 캘린더의 경우 fork 시간 단위 이하에서 기간을 다시 나열하는 것은 옵션입니다.
아니요
캘린더 오브젝트
이름
설명
필수
이름
캘린더의 이름입니다.
예
시간 단위
캘린더의 시간 단위 오브젝트 목록은 레벨 오름차순이어야 합니다. 가장 낮은 레벨은 가장 세분화된 시간 단위입니다. 대체 캘린더의 경우 fork 시간 단위 아래에 시간 단위를 다시 나열하는 것은 옵션입니다.
예
코드
캘린더의 코드입니다. 캘린더 코드가 있는 경우 지원됩니다.
아니요
시간 단위 오브젝트
이름
설명
필수
코드
시간 단위의 코드는 고유해야 합니다.
예
레이블
시간 단위의 레이블로, 고유해야 합니다. 대체 캘린더에 다시 나열되는 공유 시간 단위에는 필요하지 않습니다.
예
shortName
시간 단위의 약식 이름으로, 고유해야 합니다. 대체 캘린더에 다시 나열되는 공유 시간 단위에는 필요하지 않습니다.
아니요
isDefaultStratum
시간 단위가 기본 시간 단위인지 여부 다시 로드 또는 업데이트 작업에서만 기본 시간 단위를 설정할 수 있습니다. 시간 단위에 대해 isDefaultStratum이 지정되지 않은 경우, leaf 시간 단위가 다시 로드 작업의 기본 시간 단위라고 가정하고, 기존 기본 시간 단위는 업데이트된 작업에서 변경되지 않은 상태로 유지됩니다.
아니요
기간 오브젝트
이름
설명
필수
startDate
기간의 시작일은 yyyy-MM-dd 형식이어야 합니다.
예
endDate
기간의 종료일은 yyyy-MM-dd 형식이어야 합니다.
예
코드
기간의 코드로, 고유해야 합니다.
예
레이블
기간의 레이블입니다.
예
shortName
기간의 약식 이름입니다.
아니요
시간 단위
이 기간이 속한 시간 단위의 코드입니다.
예
instanceCode
값을 검색할 instanceCode입니다. 예를 들어, GLOBO입니다. instanceCode를 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다.
아니요

응답

204 내용 없음
상태 코드 204를 사용하여 성공한 응답이 비어 있습니다.
400 잘못된 요청
서버에서 요청을 이해할 수 없습니다.
예를 들어 다음과 같습니다. 
{
   "message": "Include only one of these valid operation parameters in the request: reload, update, or append.",
   "status": 400
}
{
   "error": "Errors occurred while processing the request.",
   "errors": [
       {
           "error": "Stratum code is required. Specify a code.",
           "field": "calendars[0].strata[2].code",
           "code": "PLN310002"
       }
   ]
}
{
   "error": "Errors occurred while processing the request",
   "errors": [
       {
           "error": "Last descendant period (12/2022) end date (2023-01-02) doesn't match the ancestor period (Q4-2022) end date (2023-01-01).",
           "field": "periods[16]",
           "code": "PLN310002"
       },
       {
           "error": "Last descendant period (12/2022) end date (2023-01-02) doesn't match the ancestor period (2022) end date (2023-01-01).",
           "field": "periods[16]",
           "code": "PLN310002"
       }
   ]
}
401 권한 없음
사용자에게 권한이 없습니다.
예를 들어 다음과 같습니다. 
{
   "message": "Invalid credential",
   "status": 401
}
401 금지
사용자에게 권한이 충분하지 않습니다.
예를 들어 다음과 같습니다. 
{
   "message": "This resource is only available when the JSON based time API feature and the alternate time roll-up feature are enabled.",
   "status": 403
}
500 내부 서버 오류
내부 서버 오류입니다.