주 컨텐츠로 이동
문서
문서
Adaptive Planning
exportTime

exportTime

이 API는 사용자 개념: 액세스 규칙API v21 이상
카테고리
메타데이터 검색
설명
특정 버전에 대한 시간 메타데이터를 반환하거나, 아무것도 지정되지 않은 경우 모든 버전에 대해 시간 메타데이터를 반환합니다.
호출에 필요한 권한
없음(인스턴스에 대해 유효한 자격증명이어야 함)
요청 시 필수 매개변수
자격증명
이 메서드의 요청에는 호출 사용자를 식별하고 권한을 부여하는 자격증명 태그와 정보를 검색할 버전을 지정하는 버전 태그(옵션)가 포함되어 있습니다. 버전을 지정하지 않으면 모든 버전의 시작 및 종료 시간을 포함하는 시간 범위에 대한 시간 정보가 반환됩니다. 호출자가 확인되면 이 메서드는 중첩 트리 방식으로 버전의 전체 시간 정보 세트를 설명하는 XML 문서를 반환합니다.

요청 형식


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportTime" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" locale="fr_FR" instanceCode="INSTANCE1"/>
<options includeAllLocales="1" includeLegacyInformation="1" />
</call>
자격증명 요소
태그명
자격증명
설명
모든 API 호출에는 API를 호출하는 사용자를 식별하는 단일 자격증명 요소가 포함되어야 합니다. 그러면 이 사용자로 API 호출이 수행됩니다(시스템의 모든 감사 추적 또는 액션 이력에 이 사용자가 액션을 수행했음이 표시됨). 따라서 사용자에게 액션을 수행하는 데 필요한 권한이 있어야 API 호출이 성공
요소의 특성
특성명
필수
값
예:
로그인
예
API 메서드를 호출하는 사용자의 로그인명입니다. 이 사용자는 메서드를 호출하는 데 필요한 권한이 있어야 합니다.
sampleuser@company.com
비밀번호
예
API 메서드를 호출하는 사용자의 비밀번호입니다.
my_password
로케일
아니요
수신 숫자 및 날짜를 해석하고 보내는 숫자 및 날짜의 형식을 지정하는 데 사용할 로케일을 지정합니다(적절한 천 단위 구분 기호, 월명 및 날짜 서식 사용). 로케일은 응답의 시스템 메시지에 사용할 언어를 지정하는 데도 사용됩니다. 지정하지 않으면 en_US(미국식 영어)가 사용됩니다.
fr_FR
instanceCode
아니요
자격증명에 지정된 사용자가 의 두 개 이상의 인스턴스에 액세스할 수 있는지 여부
Adaptive Planning
인 경우 이 속성을 사용하여 사용자가 기본 인스턴스가 아닌 다른 인스턴스에 액세스하려고 함을 지정할 수 있습니다. 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다. 사용가능한 인스턴스 코드를 확인하려면 exportInstances API를 사용합니다.
MYINSTANCE1
요소의 콘텐츠
(없음)
옵션 요소
태그명
옵션
설명
시간을 내보낼 때 사용할 옵션을 지정합니다.
요소의 특성
특성명
필수
값
예:
includeAllLocales
아니요
필요에 따라 시간 내보내기에서 각 시간 단위/기간에 대한 모든 번역을 내보내도록 설정합니다. 지정하지 않으면 자격증명 블록에 지정된 로케일만 내보냅니다.
"1"
includeLegacyInformation
아니요
필요에 따라 내보내기 시간에서 레거시 시간 정보가 포함된 추가 속성을 내보내도록 합니다. isCustom = 1인 경우 이러한 추가 속성이 포함되지 않습니다.
"1"
leafStratumId
API v16 이상에서 지원
아니요
필요에 따라 leaf로 처리할 시간 단위의 ID를 제공합니다. 지정된 시간 단위보다 작은 시간 단위는 응답에 포함되지 않으며, 지정된 시간 단위보다 작은 시간 단위에 속하는 기간도 응답에 포함되지 않습니다.
"5"
calendarId
API v33 이상에서 지원
아니요
필요에 따라 검색할 캘린더/계층의 ID를 제공합니다. 지정하지 않으면 API가 기본 계층의 시간 값만 반환합니다.
"1"
요소의 콘텐츠
(없음)
버전 요소
태그명
버전
설명
요청된 데이터를 검색하는 데 사용해야 하는 버전을 나타냅니다. 사용자는 지정된 버전에 액세스할 수 있어야 하며 폴더일 수 없습니다. version 요소는 필수는 아니지만, 이 요소가 포함된 경우 지정된 버전이 유효해야 합니다.
요소의 특성
특성명
필수
값
예:
옵션
API v18에서 업데이트됨
아니요
내보낼 시간 범위를 설정합니다. '모두', '단일'로 설정하거나 생략할 수 있습니다. 기본값은 '단일'입니다. 미혼인 경우 사용자가 '이름' 또는 'ID'도 지정해야 합니다. 지정된 단일 버전의 시간 범위와 해당 버전의 초기 잔액을 반환합니다. name과 id가 모두 지정된 경우 동일한 버전을 참조해야 합니다. all인 경우, 최소-최대 시간 범위의 첫 번째 시간 단위에 대한 초기 산정기간을 포함하여 모든 버전의 최소 ~ 최대 시간 범위를 반환합니다. all인 경우 버전 'name' 또는 'id'를 지정하면 안 됩니다. 생략하면 정의된 모든 시간을 반환합니다.
단일 버전을 지정하면 사용자에게 버전에 대한 액세스 권한이 있는 경우에만 호출이 성공합니다.
단일
이름
아니요
데이터를 검색하는 데 사용할 버전의 이름입니다. 단일 API 호출 내에서는 하나의 버전에만 액세스할 수 있습니다. 이름이 제공되지 않은 경우 ID가 제공되어야 합니다. 둘 다 지정된 경우 동일한 버전에 해당해야 합니다.
2014년 예산
ID
아니요
데이터를 검색하는 데 사용할 버전의 ID입니다. 단일 API 호출 내에서는 하나의 버전에만 액세스할 수 있습니다. 옵션이 '단일'이고 ID가 제공되지 않은 경우 이름은 이어야 합니다. 둘 다 지정된 경우 동일한 버전에 해당해야 합니다.
3
요소의 콘텐츠
(없음)

응답 형식(includeAllLocales="0" 또는 지정되지 않음)


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
  <output>
    <time isCustom="1" seqNo="24">
      <stratum code="year" label="Year" shortName="Yr" id="3" inUse="1">
        <stratum code="qtr" label="Quarter" shortName="Qtr" id="2" inUse="1">
          <stratum code="month" label="Month" shortName="Mon" id="1" inUse="1" isDefault="1" />
        </stratum>
      </stratum>
      <period code="2015" label="FY2015" shortName="FY2015" stratumId="3" timeslot="15" encodedTimePeriod="3::15" id="15003" end="2016-01-01">
        <period code="Q1-2015" label="Q1-FY15" shortName="Q1-FY15" stratumId="2" timeslot="60" encodedTimePeriod="2::60" id="60002" end="2015-04-01">
          <period code="01/2015" label="Jan-2015" shortName="Jan-2015" stratumId="1"timeslot="180" encodedTimePeriod="1::180" id="180001" end="2015-02-01" />
          <period code="02/2015" label="Feb-2015" shortName="Feb-2015" stratumId="1" timeslot="181" encodedTimePeriod="1::181" id="181001" end="2015-03-01" />
          <period code="03/2015" label="Mar-2015" shortName="Mar-2015" stratumId="1" timeslot="182" encodedTimePeriod="1::182" id="182001" end="2015-04-01" />
        </period>
        <period code="Q2-2015" label="Q2-FY15" shortName="Q2-FY15" stratumId="2" timeslot="61" encodedTimePeriod="2::61" id="61002" end="2015-07-01">
          <period code="04/2015" label="Apr-2015" shortName="Apr-2015" stratumId="1" timeslot="183" encodedTimePeriod="1::183" id="183001" end="2015-05-01" />
          <period code="05/2015" label="May-2015" shortName="May-2015" stratumId="1" timeslot="184" encodedTimePeriod="1::184" id="184001" end="2015-06-01" />
          <period code="06/2015" label="Jun-2015" shortName="Jun-2015" stratumId="1" timeslot="185" encodedTimePeriod="1::185" id="185001" end="2015-07-01" />
        </period>
        <period code="Q3-2015" label="Q3-FY15" shortName="Q3-FY15" stratumId="2" timeslot="62" encodedTimePeriod="2::62" id="62002" end="2015-10-01">
          <period code="07/2015" label="Jul-2015" shortName="Jul-2015" stratumId="1" timeslot="186" encodedTimePeriod="1::186" id="186001" end="2015-08-01" />
          <period code="08/2015" label="Aug-2015" shortName="Aug-2015" stratumId="1" timeslot="187" encodedTimePeriod="1::187" id="187001" end="2015-09-01" />
          <period code="09/2015" label="Sep-2015" shortName="Sep-2015" stratumId="1" timeslot="188" encodedTimePeriod=""1::188" id="188001" end="2015-10-01" />
        </period>
        <period code="Q4-2015" label="Q4-FY15" shortName="Q4-FY15" stratumId="2" timeslot="63" encodedTimePeriod="2::63" id="63002" end="2016-01-01">
          <period code="10/2015" label="Oct-2015" shortName="Oct-2015" stratumId="1" timeslot="189" encodedTimePeriod="1::189" id="189001" end="2015-11-01" />
          <period code="11/2015" label="Nov-2015" shortName="Nov-2015" stratumId="1" timeslot="190" encodedTimePeriod="1::190" id="190001" end="2015-12-01" />
          <period code="12/2015" label="Dec-2015" shortName="Dec-2015" stratumId="1" timeslot="191" encodedTimePeriod="1::191" id="191001" end="2016-01-01" />
        </period>
      </period>
      <period code="2016" label="FY2016" shortName="FY2016" stratumId="3" timeslot="16" encodedTimePeriod="3::16" id="16003" end="2017-01-01">
        <period code="Q1-2016" label="Q1-FY16" shortName="Q1-FY16" stratumId="2" timeslot="64" encodedTimePeriod="2::64" id="64002" end="2016-04-01">
          <period code="01/2016" label="Jan-2016" shortName="Jan-2016" stratumId="1" timeslot="192" encodedTimePeriod="1::192" id="192001" end="2016-02-01" />
          <period code="02/2016" label="Feb-2016" shortName="Feb-2016" stratumId="1" timeslot="193" encodedTimePeriod="1::193" id="193001" end="2016-03-01" />
          <period code="03/2016" label="Mar-2016" shortName="Mar-2016" stratumId="1" timeslot="194" encodedTimePeriod="1::194" id="194001" end="2016-04-01" />
        </period>
        <period code="Q2-2016" label="Q2-FY16" shortName="Q2-FY16" stratumId="2" timeslot="65" encodedTimePeriod="2::65" id="65002" end="2016-07-01">
          <period code="04/2016" label="Apr-2016" shortName="Apr-2016" stratumId="1" timeslot="195" encodedTimePeriod="1::195" id="195001" end="2016-05-01" />
          <period code="05/2016" label="May-2016" shortName="May-2016" stratumId="1" timeslot="196" encodedTimePeriod="1::196" id="196001" end="2016-06-01" />
          <period code="06/2016" label="Jun-2016" shortName="Jun-2016" stratumId="1" timeslot="197" encodedTimePeriod="1::197" id="197001" end="2016-07-01" />
        </period>
        <period code="Q3-2016" label="Q3-FY16" shortName="Q3-FY16" stratumId="2" timeslot="66" encodedTimePeriod="2::66" id="66002" end="2016-10-01">
          <period code="07/2016" label="Jul-2016" shortName="Jul-2016" stratumId="1" timeslot="198" encodedTimePeriod="1::198" id="198001" end="2016-08-01" />
          <period code="08/2016" label="Aug-2016" shortName="Aug-2016" stratumId="1" timeslot="199" encodedTimePeriod="1::199" id="199001" end="2016-09-01" />
          <period code="09/2016" label="Sep-2016" shortName="Sep-2016" stratumId="1" timeslot="200" encodedTimePeriod="1::200" id="200001" end="2016-10-01" />
        </period>
        <period code="Q4-2016" label="Q4-FY16" shortName="Q4-FY16" stratumId="2" timeslot="67" encodedTimePeriod="2::67" id="67002" end="2017-01-01">
          <period code="10/2016" label="Oct-2016" shortName="Oct-2016" stratumId="1" timeslot="201" encodedTimePeriod="1::201" id="201001" end="2016-11-01" />
          <period code="11/2016" label="Nov-2016" shortName="Nov-2016" stratumId="1" timeslot="202" encodedTimePeriod="1::202" id="202001" end="2016-12-01" />
          <period code="12/2016" label="Dec-2016" shortName="Dec-2016" stratumId="1" timeslot="203" encodedTimePeriod="2::203" id="203001" end="2017-01-01" />
        </period>
      </period>
    </time>
  </output>
</response>

부분 응답 형식(includeAllLocales="1" 사용)

일반적으로 모든 기간 및 시간 단위에 대한 로케일 블록이 있습니다. 아래에는 시간 단위 섹션만 표시됩니다. 기간에 대한 로케일/로케일 블록의 형식은 동일합니다.

          <stratum code="year" label="Year" shortName="Year" id="3">
            <locales>
                <locale locale="en" label="Year" shortName="Year" />
                <locale locale="de" label="Jahr" shortName="Jahr" />
                <locale locale="fr" label="Anne" shortName="Anne" />
                <locale locale="es" label="Ao" shortName="Ao" />
                <locale locale="pt" label="Ano" shortName="Ano" />
                <locale locale="nl" label="Jaar" shortName="Jaar" />
                <locale locale="ja" label="年" shortName="年" />
            </locales>
            <stratum code="qtr" label="Quarter" shortName="Quarter" id="2">
                <locales>
                    <locale locale="en" label="Quarter" shortName="Quarter" />
                    <locale locale="de" label="Quartal" shortName="Quartal" />
                    <locale locale="fr" label="Trimestre" shortName="Trimestre" />
                    <locale locale="es" label="Trimestre" shortName="Trimestre" />
                    <locale locale="pt" label="Trimestre" shortName="Trimestre" />
                    <locale locale="nl" label="Kwartaal" shortName="Kwartaal" />
                    <locale locale="ja" label="四半期" shortName="四半期" />
                </locales>
                <stratum code="month" label="Month" shortName="Month" id="1" isDefault="1">
                    <locales>
                        <locale locale="en" label="Month" shortName="Month" />
                        <locale locale="de" label="Monat" shortName="Monat" />
                        <locale locale="fr" label="Mois" shortName="Mois" />
                        <locale locale="es" label="Mes" shortName="Mes" />
                        <locale locale="pt" label="Ms" shortName="Ms" />
                        <locale locale="nl" label="Maand" shortName="Maand" />
                        <locale locale="ja" label="月" shortName="月" />
                    </locales>
                </stratum>
            </stratum>
        </stratum>
응답 요소
태그명
응답
요소의 특성
특성명
필수
값
예:
성공
예
API 호출의 성공 여부를 나타내는 true 또는 false입니다. 성공한 호출의 경우에도 응답에 경고 메시지가 포함될 수 있습니다.
true
폐지
아니요
이 특성이 응답 태그에 있고 true로 설정된 경우, 이 특성은 호출 중인 메서드 또는 API의 버전이 폐기되어 공식적으로 폐기됨을 나타냅니다. 현재로서는 계속 작동하지만 잠시 후 작동이 중지될 수 있습니다. 일반적으로 이 특성은 없습니다.
false
요소의 콘텐츠
단일 옵션 메시지 요소와 정확히 하나의 필수 출력 요소
메시지 요소
태그명
메시지
설명
하나 이상의 메시지 요소에 대한 컨테이너입니다.
요소의 특성
특성명
필수
값
예:
(없음)
요소의 콘텐츠
하나 이상의 메시지 요소
메시지 요소
태그명
메시지
설명
시스템에서 호출자에게 다시 전송되는 메시지를 나타냅니다. 메시지는 요청이 성공하지 못한 경우의 오류 메시지, 요청이 성공한 경우의 경고 메시지, 성공의 경우 확인 메시지에 사용됩니다.
요소의 특성
특성명
필수
값
예:
키
아니요
지정된 경우 키는 특정 메시지 또는 메시지 유형을 식별하는 방법이며, 클라이언트 프로그램에서 자동화된 오류 기록 및 복구를 위해 유용합니다. 메시지의 언어가 변경되더라도 다른 요청 로케일에서는 키는 변경되지 않습니다. 또한 향후에는 문구 조정 또는 용어 변경으로 인해 키가 변경되지 않을 것입니다.
invalid-attributevalueid
요소의 콘텐츠
메시지 텍스트입니다. 이 텍스트는 요청에 지정된 로케일의 언어로 표시됩니다(로케일이 지원된다고 가정). 텍스트에는 처리된 행 수, 오류를 일으킨 특정 열 또는 값과 같은 가변 정보가 포함될 수도 있습니다.
출력 요소
태그명
출력
요소의 특성
(없음)
요소의 콘텐츠
단일 필수 시간 요소 이 출력 랩퍼는 모든 API 응답에서 표준이며, 성공한 API 호출의 유효한 출력을 포함합니다.
시간 요소
태그명
time
설명
root 시간 단위 요소 1개, 0개 또는 1개의 초기 잔액 요소, 1개 이상의 root 시간 단위 기간 요소를 위한 컨테이너
요소의 특성
특성명
필수
값
예:
isCustom
예
이 인스턴스의 캘린더가 맞춤 설정되었는지 여부를 나타내는 1 또는 0입니다.
1
q1FirstMonth
아니요
회계연도가 시작되는 월입니다(0부터 시작). 이 속성은 요청에서 includeLegacyInformation이 1이고 isCustom이 0인 경우에만 나타납니다.
8
lastMonthIsFY
아니요
회계연도가 회계연도가 종료되는 캘린더 연도와 동일한지 여부를 나타냅니다. 이 특성은 요청에서 includeLegacyInformation이 1이고 isCustom이 0인 경우에만 나타납니다.
0
seqNo
API v17에 추가되었지만 향후 사용을 위해 예약되어 있습니다.
요소의 콘텐츠
정확히 1개의 시간 단위 요소, 0개 또는 1개의 초기 잔액 요소, 1개 이상의 root 시간 단위 기간 요소
시간 단위 요소
태그명
시간 단위
설명
exportTime API 호출에서 반환되는 캘린더 시간 단위를 나타냅니다.
요소의 특성
특성명
필수
값
예:
코드
예
시간 단위의 고유한 사용자 정의 ID입니다.
연도
레이블
예
시간 단위에 대한 고유하지 않은 사용자 정의 텍스트 ID입니다.
회계연도
shortName
예
더 짧은 이름이 필요한 경우에 사용되는 고유하지 않은 사용자 정의 텍스트 ID입니다. 약식 이름이 정의되어 있지 않으면 여기에 레이블이 표시됩니다.
연도
ID
예
시간 단위에 대해 시스템에서 생성된 고유한 정수 ID입니다.
7
inUse
API v16 이상에서 지원
아니요
큐브 시트 또는 모델링 시트가 시간 단위와 연결되어 있는지 또는 기본 시간 단위인지 여부를 나타내는 플래그입니다.
1
isDefault
API v16 이상에서 지원
아니요
시간 단위가 기본 시간 단위인지 여부를 나타내는 플래그입니다.
1
요소의 콘텐츠
0개 또는 1개의 로케일 요소 이는 includeAllLocales가 설정된 경우에만 포함됩니다.
0개 또는 1개의 시간 단위 요소 leaf를 제외한 모든 시간 단위에는 정확히 하나의 시간 단위 요소가 있습니다. leaf 시간 단위 요소에 포함된 시간 단위 요소가 없습니다.
초기 잔액 요소
태그명
initial-balance
설명
exportTime API 호출에 대한 응답으로 반환되는 버전의 시작 전 마지막 leaf 기간을 나타냅니다. 이는 하나의 버전만 요청하는 경우에만 포함됩니다.
요소의 특성
특성명
필수
값
예:
코드
예
초기 산정기간에 대한 고유한 사용자 정의 ID입니다.
12/2003
레이블
예
초기 산정기간에 대한 고유하지 않은 사용자 정의 텍스트 ID입니다.
2003년 12월
약식 이름
예
초기 산정기간에 대한 고유하지 않은 사용자 정의 짧은 텍스트 ID입니다. 약식 이름이 정의되지 않은 경우 레이블이 표시됩니다.
12월
stratumId
예
초기 잔액이 속한 시간 단위의 ID입니다.
1
타임슬롯
예
초기 잔액이 속한 기간의 타임슬롯입니다.
47
encodedTimePeriod
예
기간에 대한 인코딩된 데이터(strulumId::timeslot 형식)입니다.
1::47
ID
예
초기 산정기간에 대해 시스템에서 생성된 고유한 정수 ID입니다.
47001
시작
예
YYYY-MM-DD 형식의 초기 잔액 시작일(포함)입니다.
2003-12-01
종료
예
초기 잔액의 종료일(제외)입니다(YYYY-MM-DD 형식).
2004-01-01
legacyReportTimeId
아니요
이 API의 이전 버전에서 이 기간 동안 표시되었을 리포트 ID입니다. 이 특성은 요청에서 includeLegacyInformation이 1이고 isCustom이 0인 경우에만 나타납니다.
200312
legacySheetTimeId
아니요
이 API의 이전 버전에서 이 기간에 사용되었을 시트 시간 ID입니다. 이 특성은 요청에서 includeLegacyInformation이 1이고 isCustom이 0인 경우에만 나타납니다.
48, Q63 또는 Y72
요소의 콘텐츠
0개 또는 1개의
로케일
요소
기간 요소
태그명
기간
설명
exportTime API 호출에서 반환되는 단일 캘린더 기간을 나타냅니다.
요소의 특성
특성명
필수
값
예:
코드
예
기간에 대한 고유한 사용자 정의 ID입니다.
Q1-2004
레이블
예
기간에 대한 고유하지 않은 사용자 정의 텍스트 ID입니다.
Q1-FY04
shortName
예
더 짧은 이름이 필요한 경우에 사용되는 고유하지 않은 사용자 정의 텍스트 ID입니다. 약식 이름이 정의되어 있지 않으면 여기에 레이블이 표시됩니다.
Q1
stratumId
예
기간이 속한 시간 단위의 ID입니다.
2
ID
예
기간에 대해 시스템에서 생성된 고유한 정수 ID입니다.
16002
시작
예
기간의 시작일(포함)이며, YYYY-MM-DD 형식입니다.
2004-01-01
종료
예
기간의 종료일(제외)이며, YYYY-MM-DD 형식입니다.
2004-04-01
legacyReportTimeId
아니요
이 API의 이전 버전에서 이 기간 동안 표시되었을 리포트 ID입니다. 이 특성은 요청에서 includeLegacyInformation이 1이고 isCustom이 0인 경우에만 나타납니다.
200491
legacySheetTimeId
아니요
이 API의 이전 버전에서 이 기간에 사용되었을 시트 시간 ID입니다. 이 특성은 요청에서 includeLegacyInformation이 1이고 isCustom이 0인 경우에만 나타납니다.
48, Q63 또는 Y72
요소의 콘텐츠
0개 또는 1개의 로케일 요소
로케일 요소
태그명
로케일
설명
하나 이상의
로케일
요소에 대한 컨테이너입니다.
요소의 특성
특성명
필수
값
예:
(없음)
요소의 콘텐츠
하나 이상의 로케일 요소
로케일 요소
태그명
로케일
설명
로케일에 대한 설명입니다. 텍스트는 로케일 대체 규칙을 따릅니다.
요소의 특성
특성명
필수
값
예:
로케일
예
로케일의 코드입니다.
ko
레이블
예
기간/시간 단위의 현지화 레이블입니다.
FY2016
shortName
예
기간/시간 단위의 현지화 약식 이름입니다.
2016
요소의 콘텐츠
(없음)