주 컨텐츠로 이동
Adaptive Planning
exportData

exportData

카테고리
데이터 검색
설명
요청 인스턴스의 요청된 버전에서 데이터 세트를 반환합니다.
호출에 필요한 권한
없음(인스턴스에 대해 유효한 자격증명이어야 함)
요청 시 필수 매개변수
자격증명, 버전, 형식, 필터
이 메서드의 요청에는 지정된 버전의 데이터를 검색하고 요청된 필터 및 형식과 일치하는 값을 반환하는 데 사용할 매개변수가 포함되어 있습니다. 이는 Adaptive Planning에서 데이터를 검색하는 데 사용되는 기본 방법이며, 표준 계정, GL 계정, 모델링 계정, 큐브 계정, 커스텀 계정, 메트릭 계정, 가정 및 환율을 포함한 모든 계정에서 값을 검색하는 데 사용할 수 있습니다.
계획 버전을 내보내는 경우 모든 실제값 오버레이 기간에 대한 실제값 데이터가 내보내기에 포함됩니다. 시트 UI에서처럼 실제값 또는 계획 데이터가 표시됩니다.
개별 분할의 값은 에서 내보낼 때 집계됩니다.
exportData.
API v16 이상의 경우,
exportData
가상 버전에 대한 데이터도 내보냅니다.
참조 customReportValues데이터 검색에 대한 보다 구체적인 접근 방식을 제공합니다.
참조 참조: exportData 성능2024R1에서 API v39용으로 릴리스된 향상된 성능 및 확장성을 요청에 활용하는 방법을 확인하십시오.

요청 형식

<?xml version='1.0' encoding='UTF-8'?> <call method="exportData" callerName="a string that identifies your client application" stream="true"> <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/> <version name="Budget 2014" isDefault="false"/> <format useInternalCodes="true" includeUnmappedItems="false" /> <filters> <accounts> <account code="A100" isAssumption="true" includeDescendants="false"/> <account code="L100" isAssumption="false" includeDescendants="true"/> </accounts> <levels> <level name="Development" isRollup="true" includeDescendants="true"/> <level name="QA" isRollup="false" includeDescendants="false"/> </levels> <dimensionValues> <dimensionValue dimName="Customer" name="A Corp" directChildren="true"/> <dimensionValue dimName="Region" name="" uncategorized="true" directChildren="false"/> </dimensionValues> <timeSpan start="11/2013" end="12/2014"/> </filters> <dimensions> <dimension name="Product"/> <dimension name="CountryRegion"/> </dimensions> <rules includeZeroRows="false" includeRollups="false" markInvalidValues="false" markBlanks="false" timeRollups="single"> <currency useCorporate="false" useLocal="false" override="AUD"/> </rules> </call>
이 API 호출을 호출할 때마다 나열된 각 유형의 요소가 정확히 하나만 포함되어야 합니다.
  • 통화
  • 자격증명
  • 버전
  • 형식
요청에는 다음 요소 중 하나가 포함될 수도 있습니다.
  • 필터
    • 계정 > 계정
    • 레벨 > 레벨
    • dimensionValues > dimensionValue
    • timeSpan
  • 디멘션 > 디멘션
  • 규칙 > 통화
호출 요소
태그명
통화
설명
해당 메서드 특성을 사용하여 호출되는 API 메서드를 나타냅니다.
요소의 특성
특성명
필수
예:
방법
호출되는 메서드입니다.
exportData
callerName
클라이언트 어플리케이션을 식별하는 문자열입니다.
" Adaptive Planning 클라이언트 어플리케이션의 예"
stream
API v39 이상에서 사용가능
아니요
exportData가 처리되는 즉시 데이터를 클라이언트로 다시 스트리밍할 수 있도록 허용합니다. 기본적으로 false로 설정됩니다. exportData에서 스트리밍을 활성화하려면 응답 형식을 변경해야 합니다.
true
요소의 콘텐츠
다음 각 유형의 정확히 하나의 요소:
  • 자격증명
  • 버전
  • 형식
자격증명 요소
태그명
자격증명
설명
모든 API 호출에는 API를 호출하는 사용자를 식별하는 단일 자격증명 요소가 포함되어야 합니다. 그런 다음 이 사용자로 API 호출이 수행됩니다(시스템의 모든 감사 추적 또는 액션 이력에 이 사용자가 액션을 수행했음이 표시됨). 따라서 사용자에게 액션을 수행하는 데 필요한 권한이 있어야 API 호출이 성공할 수 있습니다. ..
계획 UI의 내보내기 기능 권한은 exportData에 영향을 주지 않습니다.
요소의 특성
특성명
필수
예:
로그인
API 메서드를 호출하는 사용자의 로그인명입니다. 이 사용자는 메서드를 호출하는 데 필요한 권한이 있어야 합니다.
sampleuser@company.com
비밀번호
API 메서드를 호출하는 사용자의 비밀번호입니다.
my_password
로케일
아니요
수신 숫자 및 날짜를 해석하고 보내는 숫자 및 날짜의 형식을 지정하는 데 사용할 로케일을 지정합니다(적절한 천 단위 구분 기호, 월명 및 날짜 서식 사용). 로케일은 응답의 시스템 메시지에 사용할 언어를 지정하는 데도 사용됩니다. 지정하지 않으면 en_US(미국식 영어)가 사용됩니다.
fr_FR
instanceCode
아니요
자격증명에 지정된 사용자가 둘 이상의 Adaptive Planning 인스턴스에 액세스할 수 있는 경우 이 속성을 사용하여 사용자가 기본 인스턴스가 아닌 다른 인스턴스에 액세스하려고 함을 지정할 수 있습니다. 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다. 사용가능한 인스턴스 코드를 확인하려면 exportInstances API를 사용합니다.
MYINSTANCE1
요소의 콘텐츠
(없음)
버전 요소
태그명
버전
설명
요청된 데이터를 검색하는 데 사용해야 하는 버전을 나타냅니다. 각 호출에 대해 버전을 제공해야 합니다.
요소의 특성
특성명
필수
예:
이름
아니요
데이터를 수신하는 데 사용할 버전의 이름입니다. 단일 API 호출 내에서는 하나의 버전에만 액세스할 수 있습니다. 이름을 제공하지 않으면 이 요소에서 isDefault 플래그를 true로 설정해야 합니다.
Budget 2014
isDefault
아니요
호출자가 인스턴스의 이름과 관계없이 인스턴스의 현재 기본 버전에 액세스하려는 경우 이 특성을 true로 설정할 수 있으며, 이 경우 태그의 name 특성(있는 경우)이 무시됩니다. 그렇지 않고, 이 값이 false이거나 이 특성이 없는 경우, 이 호출이 성공하려면 제공된 이름을 사용하는 버전이 존재하고 사용자가 액세스할 수 있어야 합니다.
false
요소의 콘텐츠
(없음)
형식 요소
태그명
형식
설명
반환할 데이터의 개별 필드에 사용해야 하는 서식 유형을 나타냅니다.
요소의 특성
특성명
필수
예:
useInternalCodes
계정 및 레벨 관리자에 입력된 각각의 코드를 사용하여 계정 코드 및 레벨 코드를 내보내려면 'true'로 설정합니다. 내보내기 탭에 있는 계정 매핑 내보내기 또는 레벨 매핑 내보내기를 사용하여 출력 데이터에 코드가 매핑되도록 하려면 'false'로 설정합니다.
true
useIds
아니요
응답의 계정, 레벨 및 디멘션이 코드 대신 ID로 표시되도록 하려면 'true'로 설정합니다. 또한 '' 섹션의 계정, 레벨 및 디멘션이 해당 ID로 표시되어야 합니다.
요청에 없는 경우 'false'로 기본 설정됩니다.
true
includeUnmappedItems
아니요
이 특성은 useInternalCodes가 false이고 내보내기 매핑이 사용되는 경우에만 적용됩니다. 달리 지정하지 않으면 내보내기 탭에 내보내기 매핑이 없는 항목은 출력으로 내보내지지 않습니다. includeUnmappedItems가 'true'로 설정된 경우 내보내기 매핑이 없는 계정 또는 레벨은 내부 코드(계정 또는 레벨 관리에서 설정된 코드)를 코드로 사용하여 내보내집니다. 데이터가 아닌 완전한 데이터 세트입니다. 이 플래그가 'false'로 설정되어 있으면 요청된 일부 항목에 내보내기 매핑이 없는 경우 해당 항목을 내보내지 못할 수 있습니다.
false
includeCodes
아니요
이 옵션은 유효 표시명 활성화 설정이 ON인 경우에만 의미가 있습니다.
API 응답에 레벨에 대한 코드 열을 포함하려면 'true'로 설정합니다.
API 응답에서 레벨에 대한 코드 열을 제외하려면 'false'로 설정합니다.
기본값은 false입니다.
false
includeNames
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다.
아니요
이 옵션은 유효 표시명 활성화 설정이 ON인 경우에만 의미가 있습니다.
API 응답에 레벨의 이름 열을 포함하려면 'true'로 설정합니다.
API 응답에서 레벨의 이름 열을 제외하려면 'false'로 설정합니다.
기본값은 false입니다.
false
includeDisplayNames
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다.
아니요
이 옵션은 유효 표시명 활성화 설정이 ON인 경우에만 의미가 있습니다.
API 응답에 레벨에 대한 표시명 열을 포함하려면 'true'로 설정합니다.
API 응답에서 레벨에 대한 표시명 열을 제외하려면 'false'로 설정합니다.
기본값은 false입니다.
false
displayNameEnabled
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다.
아니요
displayNameEnabled=true는 인스턴스에 대해 표시명 사용이 설정되어 있을 때 레벨 및 디멘션 엔티티를 지정하기 위해 exportData API에서 요청의 code 특성이 필요함을 나타냅니다.
displayNameEnabled=false는 인스턴스에 대해 '표시명 사용' 설정이 ON인 경우에도 exportData API가 v30 이전 API 계약을 계속 수행함을 나타냅니다. code 특성 대신 name 특성이 사용됩니다.
각 레벨 및 디멘션에 대해 이름 및 코드 특성 값이 일치해야 합니다.
displayNameEnabled의 기본값은 'false'입니다.
false
요소의 콘텐츠
(없음)
필터 요소
태그명
필터
설명
API에서 검색할 요청 버전의 데이터를 결정하는 필터의 사양을 보관합니다. 이 요소는 검색할 계정, 레벨, 월 및 디멘션 값을 지정합니다.
요소의 특성
(없음)
요소의 콘텐츠
단일 필수 계정 요소, 단일 옵션 레벨 요소, 단일 필수 timeSpan 요소 및 단일 dimensionValues 요소(옵션)
계정 요소
태그명
계정
설명
하나 이상의 계정 요소에 대한 컨테이너입니다.
요소의 특성
(없음)
요소의 콘텐츠
하나 이상의 계정 요소
계정 요소
태그명
account
설명
exportData API 호출에서 데이터를 내보낼 계정을 지정합니다. 둘 이상의 계정 요소가 계정 요소 내에 있는 경우 계정 요소와 일치하는 모든 계정이 내보내집니다. 지정된 계정 요소에 일치하는 계정이 없으면 해당 요소는 무시되고 다른 요소는 계속 적용됩니다.
요소의 특성
특성명
필수
예:
코드
내보낼 계정의 코드입니다. 이 코드는 계정 관리에 지정된 대로입니다.
Current_Assets
isAssumption
코드가 가정 계정을 지정하는지 아니면 가정이 아닌 계정을 지정하는지를 나타냅니다. 가정과 계정 모두에 대해 단일 코드를 사용할 수 있습니다. 이 플래그를 사용하여 계정 유형을 나타냅니다.
false
includeDescendants
내보내기에 지정된 계정의 descendant 계정을 모두 포함할지 여부를 나타냅니다. true로 설정하면 이 계정의 모든 child 계정 및 child 계정 등도 내보내집니다. false로 설정하면 이 계정이 단일 롤업 계정 값으로 내보내집니다.
true
요소의 콘텐츠
(없음)
레벨 요소
태그명
개 레벨
설명
하나 이상의 레벨 요소에 대한 컨테이너입니다.
요소의 특성
(없음)
요소의 콘텐츠
하나 이상의 레벨 요소 요청에 액세스할 수 없는 레벨이 포함된 경우, 조직의 최상위 레벨을 나타내는 레벨 요소가 하나만 있게 됩니다.
레벨 요소
태그명
level
설명
exportData API 호출에서 데이터를 내보낼 조직 레벨을 지정합니다. 둘 이상의 레벨 요소가 레벨 요소 내에 있는 경우 지정된 모든 레벨을 내보냅니다. 지정된 레벨 요소가 인스턴스에 일치하는 레벨이 없는 경우, 해당 요소는 무시되지만 다른 요소는 계속 적용됩니다.
다음 조건을 모두 충족하는 경우 이름 대신 코드로 필터링해야 합니다.
  • 인스턴스에서 표시명을 설정하여 중복 메타데이터를 활성화합니다.
  • API v30 이상 호출
  • format 요소가 true인 displayNameEnabled 속성입니다.
요소의 특성
특성명
필수
예:
코드
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다.
코드는 항상 이름과 함께 사용할 수 없습니다. 이 두 조건이 모두 적용되는 경우 다음 코드만 사용해야 합니다.
  • '표시명 사용' 설정이 '켜짐'입니다.
  • format 요소의 displayNameEnabled="true"
그렇지 않으면 코드를 포함하지 않습니다.
내보낼 레벨의 코드입니다. 이 코드는 조직 관리에 지정되어 있습니다.
코드는 유효 표시명 활성화 설정이 ON인 경우에만 지원됩니다.
Development
이름
이름은 항상 코드와 함께 사용할 수 없습니다. format 요소에 displayNameEnabled="false"가 있으면 이름만 사용해야 합니다. 지정하지 않은 경우 기본값입니다.
내보낼 레벨의 이름입니다. 이 이름은 조직 관리에 지정된 대로입니다.
이름은 유효 표시명 활성화 설정이 '해제'인 v30 이전 API 요청에 대해서만 지원됩니다.
API가 요청에 포함된 이름 문자열에 해당 code 특성을 매칭하여 레벨을 검색하므로 name 특성은 기능적으로 code 특성으로 처리됩니다. 이름으로 레벨을 검색하려면 이름과 코드 특성이 일치해야 합니다.
Development
isRollup
이 레벨에 child 항목이 있는 경우 isRollup="true"는 레벨에 대한 롤업 값(모든 child 값 포함)을 출력하고 isRollup="false"는 레벨에 대한 카테고리 미지정 값(편집에 입력된 값)만 출력합니다. 해당 레벨에 대한 데이터) 이 레벨에 child 레벨이 없으면 isRollup을 false로 설정해야 합니다(또는 태그에서 완전히 생략해야 함).
false
includeDescendants
내보내기에 지정된 레벨의 descendant 레벨을 모두 포함할지 여부를 나타냅니다. true로 설정하면 이 레벨의 모든 child 레벨과 해당 child 레벨 등도 내보내집니다. false로 설정하면 이 레벨만 내보내집니다. isRollup은 이 레벨에 대해 출력할 값에 영향을 미치는 반면, include Descendants는 descendant 항목도 내보내기에 포함할지 여부를 나타냅니다. isRollup 및 includeDescendants가 모두 true로 설정되고 레벨이 parent 레벨인 경우 출력에 이 레벨과 각 descendant 레벨에 대한 롤업 및 롤업이 아닌(카테고리 미지정) 레벨의 값이 모두 포함됩니다.
true
요소의 콘텐츠
(없음)
timeSpan element
태그명
timeSpan
설명
응답에 반환되어야 하는 기간을 나타냅니다. 지정된 범위(포함) 사이의 기간은 별도의 데이터 열로 출력에 포함됩니다. 집계되거나 롤업되지 않습니다.
요소의 특성
특성명
필수
예:
시작
기간 범위에서 데이터를 내보낼 첫 번째 기간의 코드입니다. 시작 기간은 leaf 기간이어야 합니다.
01/2015
종료
기간 범위에서 데이터를 내보낼 마지막 기간의 코드입니다. 종료 기간은 leaf 기간이어야 합니다.
03/2015
stratum
아니요
내보낸 데이터의 시간 단위 코드입니다. 지정된 경우 시작 및 종료 기간은 시간 단위에 속해야 합니다. 시간 단위는 요청에서 시간 단위가 가장 높은 계정보다 크거나 같아야 합니다. 다음을 참조하십시오.
예를 들어, 분기 단위를 나타내려면 모든 계정의 시간 단위가 분기, 연도 또는 그 이상이어야 합니다.
month
요소의 콘텐츠
(없음)
dimensionValues 요소
태그명
dimensionValues
설명
하나 이상의 dimensionValue 요소에 대한 컨테이너입니다. 이 요소는 옵션이며 디멘션 값 필터링이 필요하지 않은 경우에는 표시되지 않습니다.
요소의 특성
(없음)
요소의 콘텐츠
하나 이상의 dimensionValue 요소
dimensionValue 요소
태그명
dimensionValue
설명
내보낸 데이터에 지정된 dimensionValue와 일치하는 값만 포함되어야 함을 나타냅니다. dimensionValues 요소에 있는 서로 다른 디멘션의 여러 값은 해당 디멘션별로 그룹화된 것처럼 작동합니다. 디멘션 값 중 하나 이상이 각 디멘션에서 일치하면 데이터가 반환됩니다. 동일한 디멘션 내에 있는 dimensionValues의 경우, 데이터가 모든 디멘션 값과 매칭될 수 있습니다. 예를 들어, 요청에서 디멘션 값을 Region=East, Region=West, Product=Product_A로 지정하는 경우 데이터가 East 또는 West Region과 일치해야 하지만 Product_A Product와도 일치해야 내보낼 수 있습니다.
다음 조건을 모두 충족하는 경우 이름 대신 코드로 필터링해야 합니다.
  • 인스턴스에서 표시명을 설정하여 중복 메타데이터를 활성화합니다.
  • API v30 이상 호출
  • format 요소의 displayNameEnabled 속성이 true입니다.
요소의 특성
특성명
필수
예:
dimName
아니요
디멘션 값(아래의 name 특성 참조)이 속한 디멘션의 이름입니다.
지역
코드
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다.
아니요
내보낼 디멘션 값의 코드입니다. code 특성은 인스턴스에 대해 유효 표시명 활성화 설정이 ON인 경우에만 의미가 있습니다.
이름
아니요
내보낼 디멘션 값의 이름입니다.
이름은 유효 표시명 활성화 설정이 '해제'인 v30 이전 API 요청에 대해서만 지원됩니다.
미국 서부
directChildren
아니요
true로 설정하면 API가 이 디멘션 값의 직계 child 각각에 대한 롤업 데이터를 내보내지만 값 자체에 대한 롤업 데이터를 내보내지 않습니다. 즉, 이 경우 exportData가 디멘션 트리의 지정된 값에서 '한 레벨 아래로' 값을 내보냅니다. 지정하지 않으면 false로 기본 설정됩니다.
false
카테고리 미지정
아니요
true로 설정하면 디멘션 값의 '카테고리 미지정' 값과 매칭되며 descendant 값(있는 경우)의 값은 매칭되지 않습니다. child 항목이 없는 디멘션 값에는 영향을 주지 않습니다. 지정하지 않으면 false로 기본 설정됩니다.
true
uncategorizedOfDimension
아니요
dimName/name 특성 대신 uncategorizedOfDimension을 지정합니다.
  • 지정된 경우 특성의 값은 디멘션의 내부 시스템 ID 번호여야 하며(디멘션 값이 아님), 필터와 일치하려면 이 디멘션에서 데이터가 완전히 카테고리 미지정 상태여야 한다고 필터가 지정합니다.
  • directChildren 및 uncategorized 특성은 무시되며 각각 false 및 true로 간주됩니다.
  • dimName이 지정된 경우 무시됩니다.
15
directChildrenOfDimension
아니요
dimName/name 특성 대신 directChildrenOfDimension을 지정합니다.
  • 지정된 경우 특성 값은 디멘션의 내부 시스템 ID 번호여야 하며(디멘션 값 아님) 필터는 디멘션의 첫 번째 레벨 디멘션 값을 모두 지정합니다.
  • directChildren 및 uncategorized 특성은 무시되며 각각 true 및 false로 간주됩니다.
  • dimName 또는 uncategorizedOfDimension이 지정된 경우에는 무시됩니다.
12
ID
아니요
dimName/name 특성 대신 ID를 지정합니다.
  • 내보낼 디멘션 값의 내부 시스템 ID 번호입니다. 디멘션 값을 지정하려면 dimName/ name 특성 대신 지정해야 합니다. 내부 ID를 확인하려면 exportDimensions API를 참조하십시오.
  • dimName, uncategorizedOfDimension 또는 directChildrenOfDimension이 지정된 경우에는 무시됩니다.
14
요소의 콘텐츠
(없음)
디멘션 요소
태그명
디멘션
설명
하나 이상의 디멘션 요소에 대한 컨테이너입니다.
요소의 특성
(없음)
요소의 콘텐츠
하나 이상의 디멘션 요소
디멘션 요소
태그명
디멘션
설명
내보낸 데이터가 지정된 디멘션을 기준으로 분류되거나 분할되어야 함을 나타냅니다. 이 태그는 필터 태그의 일부가 아니며 필터링을 제어하지 않습니다. 대신 각 계정/레벨 조합에 대해 내보낼 행 수를 제어합니다. 디멘션 태그에 지정된 각 디멘션에 대해 기존의 각 값 조합을 별도의 데이터 행으로 내보냅니다. 또한 디멘션 요소에 있는 각 디멘션에 따라 해당 디멘션명으로 레이블이 지정된 추가 열이 출력에 표시됩니다.
요소의 특성
특성명
필수
예:
이름
내보내기를 분석하는 데 기준이 되는 디멘션의 이름입니다. 내보내기에서 디멘션으로 분할할 수 없는 데이터 행은 한 번만 표시되며, 이 디멘션에 대한 디멘션 값 이름이 표시되는 열에 디멘션명 자체를 표시합니다.
고객
요소의 콘텐츠
(없음)
규칙 요소
태그명
규칙
설명
내보낼 행 유형과 일부 필드 값이 렌더링되는 방식을 제어하는 몇 가지 추가 출력 규칙을 지정합니다.
요소의 특성
특성명
필수
예:
includeZeroRows
아니요
행에 값이 0이거나 비어 있는 행만 포함된 경우에도 행을 내보내려면 'true'로 설정합니다. 출력에서 데이터가 없는 행을 생략하려면 'false'로 설정합니다. 기본값은 false입니다.
디멘션이 포함된 내보내기의 경우 어플리케이션 사용자 인터페이스에서는 이 옵션을 사용할 수 없습니다.
API 호출의 경우, 디멘션별로 데이터를 내보낼 때 True가 무시됩니다. 데이터가 있는 디멘션 값에 대한 데이터만 내보냅니다.
true
includeRollups
API v24 이하에서 사용할 수 있습니다.
API v25 이상에서는 사용할 수 없습니다.
아니요
true로 설정하면 필터 태그의 모든 계정 및 레벨에 대한 롤업 값이 해당 descendant에 대한 값과 함께 포함됩니다. 이 특성은 dimensionValue 필터 또는 디멘션 태그에 지정된 커스텀 디멘션이 작동하는 방식에 영향을 주지 않습니다. 기본값은 false입니다. includeRollups 플래그는 계정 또는 레벨에 적용되는 명시적 필터링이 없는 경우에만 적용됩니다. 개별 계정이 필터에 포함된 경우 포함하려는 경우 개별 롤업 계정을 지정해야 합니다.
false
includeRollupAccounts
API v25+에서 사용할 수 있습니다.
아니요
true로 설정하면 descendant 계정의 값과 함께 필터 태그의 모든 계정에 대한 롤업 값이 포함됩니다. 이 특성은 dimensionValue 필터 또는 디멘션 태그에 지정된 커스텀 디멘션이 작동하는 방식에 영향을 주지 않습니다. 기본값은 false입니다.
false
includeRollupLevels
API v25+에서 사용할 수 있습니다.
아니요
true로 설정하면 필터 태그의 모든 레벨에 대한 롤업 값이 해당 descendant에 대한 값과 함께 포함됩니다. 이 특성은 dimensionValue 필터 또는 디멘션 태그에 지정된 커스텀 디멘션이 작동하는 방식에 영향을 주지 않습니다. 기본값은 false입니다.
false
markInvalidValues
아니요
true로 설정하면 내보내기 시 유효하지 않은 값에 문자 'I'가 추가됩니다. 그렇지 않으면 Excel과 호환되도록 잘못된 값에 '=NA()'를 추가합니다. 기본값은 false입니다.
false
markBlanks
API v24에서 업데이트되었습니다.
아니요
true로 설정하면 공백 값이 'B'로 출력됩니다. 그렇지 않으면 비어 있는 값이 0으로 출력됩니다. 기본값은 false입니다.
includeZeroRows=false이면 markBlanks=true인 경우에도 공백과 0의 조합만 있는 행은 응답으로 출력되지 않습니다.
false
timeRollups
아니요
true, false 및 단일의 세 가지 값이 가능합니다. True로 설정하면 분기 및 연도 롤업이 내보낸 개월 범위 내에서 적절한 위치에 나타납니다. 분기 롤업은 분기의 마지막 월 바로 다음에 표시되고, 연도 롤업은 마지막 분기의 분기 롤업 직후에 표시됩니다. 단일로 설정하면 개별 월, 분기 또는 연도가 반환되지 않으며, 시간 프레임 요소에 포함된 모든 월의 단일 시간 롤업만 반환됩니다. false로 설정하면 시간 롤업 열 없이 개별 월만 반환됩니다. 기본값은 false입니다.
false
요소의 콘텐츠
내보내기에 사용할 통화를 지정하는 옵션 통화 요소입니다.
통화 요소
태그명
통화
설명
통화 계정의 값을 내보낼 때 출력에 사용해야 하는 통화를 나타냅니다.
요소의 특성
특성명
필수
예:
useCorporate
아니요
통화 요소에는 세 가지 특성 중 하나만 설정할 수 있습니다. useCorporate가 true로 설정된 경우, '회사 통화'(조직 트리 맨 위에 표시되는 통화)를 사용해야 함을 나타냅니다. 기본값은 false입니다.
false
useLocal
아니요
통화 요소에는 세 가지 특성 중 하나만 설정할 수 있습니다. useLocal이 true로 설정된 경우, 통화 값이 해당 값이 있는 조직 레벨의 통화로 내보내져야 함을 나타냅니다. 출력의 각 행은 조직 레벨을 나타내며, 해당 행의 통화 값은 해당 레벨의 통화로 표시됩니다. 기본값은 false입니다.
false
재정의
아니요
통화 요소에는 세 가지 특성 중 하나만 설정할 수 있습니다. 재정의가 있는 경우 인스턴스에 대해 구성된 통화 중 하나의 3자리 통화 코드를 지정해야 합니다. 이 옵션을 지정하면 내보내기의 모든 통화 금액이 해당 통화로 변환됩니다.
AUD
요소의 콘텐츠
(없음)
아래 요소를 사용하면 사용자(적절한 권한이 있음)가 임의 시간 롤업에 대한 내보내기를 요청할 수 있습니다. 이러한 요소를 사용하려면 api v40 이상을 사용하는 요청이 필요합니다.
시간요소
태그명
time
설명
데이터를 내보낼 때 기간을 매핑하는 데 사용해야 하는 캘린더 XML을 포함합니다. 에서 생성된 시간 XML의 스트립다운 형식이어야 합니다. exportTimeAPI 이 섹션에 포함된 기간은 필터의 시간 프레임 요소와 일치해야 합니다. 이 요소는 임의의 롤업 캘린더를 사용하는 경우에만 필수입니다.
API v40 이상에서만 사용가능
요소의 특성
특성명
필수
예:
요소의 콘텐츠
(없음)
시간 단위요소
태그명
stratum
설명
캘린더의 시간 단위를 나타냅니다.
API v40 이상에서만 사용가능
요소의 특성
특성명
필수
예:
코드
시간 단위에 대한 고유한 사용자 정의 ID입니다.
연도
ID
시간 단위에 대해 시스템에서 생성된 고유한 정수 ID입니다.
7
요소의 콘텐츠
(없음)
기간요소
태그명
기간
설명
단일 캘린더 기간을 나타냅니다.
API v40 이상에서만 사용가능
요소의 특성
특성명
필수
예:
코드
기간에 대한 고유한 사용자 정의 ID입니다.
Q1-2004
stratumId
기간이 속한 시간 단위의 ID입니다.
2
타임슬롯
기간의 타임슬롯입니다.
16
ID
기간에 대해 시스템에서 생성된 고유한 정수 ID입니다.
16002
시작
기간의 시작일(포함)이며, YYYY-MM-DD 형식입니다.
2004-01-01
종료
기간의 종료일(제외)이며, YYYY-MM-DD 형식입니다.
2004-01-01
요소의 콘텐츠
(없음)
임의 시간 롤업 요청의 예
:
<call method="exportData" callerName="test caller api name"> <credentials login="admin@example.com" password="password" locale="en_US" instanceCode="EXAMPLEINST" /> <version name="Budget 2004" isDefault="true" /> <format useInternalCodes="true" includeUnmappedItems="false" useIds="false" /> <rules includeZeroRows="false" includeRollupAccounts="true" includeRollupLevels="false" markInvalidValues="false" markBlanks="false" timeRollups="false"> <currency useCorporate="false" useLocal="true" /> </rules> <filters> <accounts> <account code="70310" isAssumption="false" includeDescendants="true" /> </accounts> <timeSpan start="01/1999" end="06/1999" /> </filters> <time isCustom="1"> <stratum code="month" label="Month" shortName="Month" id="1" /> <period code="01/1999" label="Jan-1999" shortName="Jan" stratumId="1" id="-12001" start="1999-01-01" end="1999-02-01" /> <period code="02/1999" label="Feb-1999" shortName="Feb" stratumId="1" id="-11001" start="1999-02-01" end="1999-03-01" /> <period code="03/1999" label="Mar-1999" shortName="Mar" stratumId="1" id="-10001" start="1999-03-01" end="1999-04-01" /> <period code="04/1999" label="Apr-1999" shortName="Apr" stratumId="1" id="-9001" start="1999-04-01" end="1999-05-01" /> <period code="05/1999" label="May-1999" shortName="May" stratumId="1" id="-8001" start="1999-05-01" end="1999-06-02" /> <period code="06/1999" label="Jun-1999" shortName="Jun" stratumId="1" id="-7001" start="1999-06-01" end="1999-07-01" /> </time> </call>

응답 형식

비스트리밍 응답 형식
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <messages> <message key="warning-invalid-timespan-start">Ignoring start of timespan, which precedes start of version; timsepan start: Nov-2009, version start date: Jan-2014</message> </messages> <output><![CDATA[ Account Name,Account Code,Level Name,[01/2014,02/2014,03/2014,04/2014,05/2014,06/2014,07/2014,08/2014,09/2014,10/2014,11/2014,12/2014] "Benefits",30120,"Engineering (Rollup)",10653.75,10653.75,10653.75,11506.05,11506.05,11506.05,11506.05,11506.05,11506.05,10462.05,10426.05,10426.05 "Furniture",70310,"Engineering (Rollup)",1740.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0 ... ]]> </output> </response>
스트리밍 응답 형식
<?xml version="1.0" encoding="UTF-8"?> <response> <output> <![CDATA[Account Name,Account Code,Level Name,Q1-2004,Q2-2004,Q3-2004,Q4-2004,Q1-2005,Q2-2005 "Current Assets","Current_Assets","Engineering",33.0,33.0,33.0,33.0,33.0,33.0 "Other Assets","Other_Assets","Engineering",41.0,41.0,41.0,41.0,41.0,41.0]]> </output> <messages> <message>Exporting data failed. Retry the export. Contact Support if the export continues to fail. </message> </messages> <status success="false" rowCountSent="2"/> </response>
스트리밍 및 비스트리밍 요청에 대한 응답 구조가 변경된 것을 확인할 수 있습니다. 예를 들어, 메시지 요소 및 상태는 출력 후에 발생합니다.
응답 요소
태그명
응답
요소의 특성
특성명
필수
예:
성공
API 호출의 성공 여부를 나타내는 true 또는 false입니다. 성공한 호출의 경우에도 응답에 경고 메시지가 포함될 수 있습니다.
true
폐지
아니요
응답 태그에 있고 true로 설정된 경우, 이 특성은 호출 중인 메서드 또는 API의 버전이 폐기되어 공식적으로 폐기되었음을 나타냅니다. 현재로서는 계속 작동하지만 잠시 후 작동이 중지될 수 있습니다. 일반적으로 이 특성은 없습니다.
false
요소의 콘텐츠
단일 옵션 메시지 요소와 정확히 하나의 필수 출력 요소
메시지 요소
태그명
메시지
설명
하나 이상의 메시지 요소에 대한 컨테이너입니다.
요소의 특성
(없음)
요소의 콘텐츠
하나 이상의 메시지 요소
메시지 요소
태그명
메시지
설명
시스템에서 호출자에게 다시 전송되는 메시지를 나타냅니다. 이 메시지는 요청이 성공하지 못한 경우의 오류 메시지, 요청이 성공한 경우의 경고 메시지, 성공한 경우의 확인 메시지에 사용됩니다.
요소의 특성
특성명
필수
예:
아니요
지정된 경우 키는 특정 메시지 또는 메시지 유형을 식별하는 방법이며, 클라이언트 프로그램에서 자동화된 오류 기록 및 복구를 위해 유용합니다. 메시지의 언어가 변경되더라도 다른 요청 로케일에서는 키는 변경되지 않습니다. 또한 향후에는 문구 조정 또는 용어 변경으로 인해 키가 변경되지 않을 것입니다.
invalid-attributevalueid
요소의 콘텐츠
메시지 텍스트입니다. 이 텍스트는 요청에 지정된 로케일의 언어로 표시됩니다(로케일이 지원된다고 가정). 이 텍스트에는 처리된 행 수, 오류가 발생한 특정 열 또는 값과 같은 가변 정보가 포함될 수도 있습니다.
출력 요소
태그명
출력
설명
묶인 CDATA 블록에 내보내기의 결과 데이터를 포함합니다.
요소의 특성
(없음)
요소의 콘텐츠
내보내기의 CSV 형식 데이터를 포함하는 CDATA 블록 행은 개행 문자로 구분됩니다. 반환된 데이터의 첫 번째 행은 다음 각 행의 형식을 설명하는 '열 헤더' 세트입니다. 디멘션 및 필터링 요소가 먼저 나열되고 그 다음에 일련의 요청된 기간 값이 나열됩니다. 기간 코드 및 시스템에서 생성된 레이블(예: 롤업 레벨의 '(롤업)')은 가능한 경우 요청의 로케일로 번역됩니다. 값은 마침표를 소수점 구분 기호로 사용하여 쉼표 없이 정규화된 형식으로 내보내집니다.
상태 요소
태그명
상태
설명
요청 및 행 수에 대한 상태 정보를 포함합니다(스트리밍 요청에만 해당).
요소의 특성
특성명
필수
예:
성공
"true" or "false". 요청이 완료되었는지 여부를 알려줍니다. 성공한 요청에도 경고 메시지가 포함될 수 있습니다.
그러면 스트리밍 요청에서만 응답의 특성이 바뀝니다.
"true"
rowCountSent
r"\d+". 응답 행 수의 숫자 값을 나타냅니다.
"10"