주 컨텐츠로 이동
Adaptive Planning
customReportValues

customReportValues

API v37에서 업데이트되었습니다.
카테고리
데이터 검색
설명
요청된 인스턴스에서 요청된 리포트 조건에 대한 데이터 세트를 반환합니다.
호출에 필요한 권한
없음(사용자에게 권한 세트가 지정되어 있어야 함)
요청 시 필수 매개변수
자격증명, 리포트
API 버전 15 이상의 경우exportTime을호출하여 올바른 시간 요소 ID를 검색합니다.
API v36용으로 2023R2에 릴리스된 향상된 성능 및 확장성을 요청에 활용하는 방법은참조: customReportValues 성능 조건을확인하십시오.
이 메서드의 요청에는 데이터를 검색하고 값을 반환하는 데 사용할 수 있는 리포트 사양이 포함되어 있습니다. API는 내부 ID 번호를 입력으로 사용합니다. 메타데이터 검색 API를 호출하여 유효한 ID를 가져올 수 있습니다. 결과는 좌표 및 값으로 표시됩니다. 응답은 해당하는 경우 경고 및 오류 메시지도 반환합니다.
이 API는 매트릭스 리포트를 기반으로 합니다. 이 요청에서는 호출자가 X축(열), Y축(행) 및 API에서 검색하는 모든 데이터를 필터링하는 데 사용되는 필터 축(옵션)에서 요소를 지정해야 합니다. 매트릭스 리포트에는 리포트에 표시되는 데이터를 결정하는 축이 포함되어 있습니다. 각 축은 리포트의 가장자리를 정의합니다. 모든 매트릭스 리포트에는 세 가지 축이 있습니다.
  • X축(상단 가장자리) 리포트의 열 세트를 정의합니다.
  • Y축(왼쪽 가장자리) 리포트의 행 세트를 정의합니다.
  • 필터 축: 리포트의 모든 데이터에 적용되는 속성을 정의하는 글로벌 축 자세한 내용은 필터 축 예를 참조하십시오.
축은 여러 세그먼트로 나눌 수 있습니다. 세그먼트는 단일 축에서 디멘션 세트를 구분하는 방법입니다. 필터 축은 하나의 세그먼트만 포함할 수 있지만, 다른 두 축은 원하는 만큼 세그먼트를 포함할 수 있습니다.
각 세그먼트에는 무제한의 계층이 있을 수 있습니다. 계층은 해당 디멘션의 어떤 요소가 해당 디멘션 아래의 행 또는 열에 적용되는지 설명하는 데 사용되는 단일 논리적 디멘션을 나타냅니다. 세그먼트는 논리적 디멘션당 최대 하나의 계층만 포함할 수 있습니다.
각 계층은 계층 디멘션의 요소를 하나 이상 포함할 수 있습니다. (계층의 모든 요소는 계층에 지정된 디멘션에 속해야 합니다.) 요소는 일반적으로 계정 디멘션의 특정 계정 또는 시간 디멘션의 회계 분기와 같은 디멘션의 항목입니다. 그러면 시스템에서 이러한 요소를 사용하여 리포트에서 찾은 데이터를 선택하고 집계합니다.
X축 또는 Y축의 세그먼트에 여러 계층이 포함된 경우, 각 계층의 요소는 다른 모든 계층의 모든 요소와 결합되어 계층 요소의 가능한 모든 조합의 데카르트 곱을 형성합니다. 각 열 또는 행은 각 계층에서 하나의 요소를 선택하는 하나의 가능한 요소 조합을 나타냅니다. 예를 들어, X축의 세그먼트(상단을 따라 있는 열)에 5개의 요소가 있는 계층과 2개의 요소가 있는 두 번째 계층이 포함된 경우, 세그먼트는 10개의 개별 열을 생성하며, 이는 에 있는 요소의 가능한 모든 조합을 나타냅니다. 선택합니다. 요소 유형은 여러 축에 배치할 수 없습니다. 예를 들어, 계정 요소 유형을 행에 배치하면 열 또는 필터에 계정을 추가할 수 없습니다.
계층에는 개별 요소 또는 롤업 요소가 모두 포함될 수 있습니다. 롤업 요소는 해당 요소 아래에 지정된 모든 요소를 임의로 롤업합니다. 롤업 요소는 필터에서 허용되지 않습니다.
필터 축은 X축 및 Y축과 매우 유사하게 동작하지만 한 가지 약간의 차이점이 있습니다. 필터 축은 리포트의 모든 데이터에 적용되므로 해당 계층을 결합하여 여러 행 또는 열을 형성할 수 없습니다. 대신 필터 축은 각 계층의 모든 요소를 결합하여 해당 요소가 단일 집계로 롤업되는 것처럼 모든 요소의 데이터를 집계합니다.
참조 기본 매트릭스 리포트 생성세그먼트, 축 및 디멘션 요소에 대한 자세한 내용은 을 참조하십시오.

필터 축 예

아래 예에서는 필터 축에 사용할 수 있는 모든 요소를 보여줍니다.
<axis type="FILTER"> <segment> <!-- Account filter --> <tier type="acct"> <el id="258" /> </tier> <!-- Time filter --> <tier type="time"> <el id="342" /> </tier> <!-- Level filter --> <tier type="lvl"> <el id="354" /> </tier> <!-- Version filter --> <tier type="ver"> <el id="385" offset="1" offset-strata="2"/> </tier> <!-- Currency filter --> <tier type="cur"> <el id="448" /> </tier> <!-- Account Attribute filter --> <tier entity-id="23" type="aAttr"> <el id="512" /> </tier> <!-- Level Attribute filter --> <tier entity-id="25" type="lAttr"> <el id="607" /> </tier> <!-- Dimension Attribute filter --> <tier entity-id="21" type="dAttr"> <el id="649" /> </tier> <!-- Dimension filter --> <tier entity-id="1" type="dim"> <el id="717" /> </tier> </segment> </axis>

요청 형식

요청에 대한 XML 스키마는customReportValues REST 사양에서 찾을 수 있습니다.
<?xml version='1.0' encoding='UTF-8'?>      <call method="customReportValues" callerName="a string that identifies your client application">         <credentials login="sampleuser@company.com" password="my_pwd" locale="fr_FR" instanceCode="INSTANCE1"></credentials>         <requestInfo>            <!-- Add elements here that we want to show up in the ELK logs -->         </requestInfo>         <report suppress-zeroes="1" include-element-code="1"> <!-- Run report suppressing blanks, but not zero values. Add calc element codes to the response -->             <!-- columns -->             <axis type="X">                 <segment>                     <!-- time columns -->                     <tier type="time">                         <!-- Timespan creates multiple time columns from Jan-2014 to Dec-2014.Ids specified in timespan element are retrieved from exportTime API output.                                'show-time' is a mandatory attribute specifying list of strata ids -->                         <el complex-type="timespan" end="179001" start="168001" show-time="3,2,1"/>                         <el id="180001" /> <!-- single column of Jan 2015 . This id is retrieved from exportTime API output-->                         <subtotal code="Subtotal" /> <!-- subtotal of the output of all the time elements left of this subtotal element -->                     </tier>                 </segment>             </axis>             <!-- rows -->             <axis type="Y">                 <segment>                     <!-- There are 2 tiers with 2 elements and 4 elements, respectively. Without considering expansion, this generates 8 rows of:                          1. dimension value with id 135, account with id 51                          2. dimension value with id 135, account with id 53                          3. dimension value with id 135, difference between account with id 51 and account with id 53                          4. dimension value with id 135, calculation using the formula - Sum of account with id 51 and the output of the difference element from previous row                          5. dimension value with id 199, account with id 51                          6. dimension value with id 199, account with id 53                          7. dimension value with id 199, difference between account with id 51 and account with id 53                          8. dimension value with id 199, calculation using the formula - Sum of account with id 51 and the output of the difference element from previous row.                                                     Assume dimension value 135 has child 150, which has children 160,161,162. Dimension value 199 has child 200, which has children 210,211,212.                           With expansion, element of dimension value 135 with rollup-mode 'D' and 'suppress-elt-rollup' would yield to {135,160,161,162}.                          Element of dimension value 199 with 'rollup-mode' 'X' and 'start-expanded' 199,200 would yield to {199,200,210,211,212}.                          In total, there will be 9 x 4 = 36 rows in cartesian without suppress zero.                      --> -                     <tier entity-id="13" type="dim"> <!-- dimension values with id 135 and 199 from dimension with id of 13 -->                         <el id="135" rollup-mode="D" suppress-elt-rollup="1"/> <!-- Expand to Leaves operation on tag dimension id=135, return "Leaves + root" -->                         <el id="199" rollup-mode="X" start-expanded="199,200"/> <!-- Custom expansion with start expanded on tag dimension id=199 and 200, where 200 is a child of 199, return 199 and the the immediate children of 199 and 200 -->                      </tier>                     <tier type="acct"> <!-- account with id of 51 and 53 -->                         <el id="51" />                         <el id="53" />                                                 <diff operand-a="51" operand-b="53" code="Difference" /> <!-- difference between account with id 51 and account with id 53 -->                         <calc formula="[51]+RPT.Difference" /> <!-- calculation using the formula - Sum of account with id 51 and the output of the difference element (previous element) -->                     </tier>                  </segment>             </axis>         </report>     </call>
이 API 호출을 호출할 때마다 나열된 각 유형의 요소가 정확히 하나만 포함되어야 합니다.
자격증명
리포트
자격증명 요소
태그명
자격증명
설명
모든 API 호출에는 API를 호출하는 사용자를 식별하는 단일 자격증명 요소가 포함되어야 합니다. 그런 다음 이 사용자로 API 호출이 수행됩니다(시스템의 모든 감사 추적 또는 액션 이력에 이 사용자가 액션을 수행했음이 표시됨). 따라서 사용자에게 액션을 수행하는 데 필요한 권한이 있어야 API 호출이 성공
요소의 특성
특성명
필수
예:
로그인
API 메서드를 호출하는 사용자의 로그인명입니다. 이 사용자는 메서드를 호출하는 데 필요한 권한이 있어야 합니다.
sampleuser@company.com
비밀번호
API 메서드를 호출하는 사용자의 비밀번호입니다.
my_password
로케일
아니요
수신 숫자 및 날짜를 해석하고 보내는 숫자 및 날짜의 형식을 지정하는 데 사용할 로케일을 지정합니다(적절한 천 단위 구분 기호, 월명 및 날짜 서식 사용). 로케일은 응답의 시스템 메시지에 사용할 언어를 지정하는 데도 사용됩니다. 지정하지 않으면 en_US(미국식 영어)가 사용됩니다.
fr_FR
instanceCode
아니요
자격증명에 지정된 사용자가 의 두 개 이상의 인스턴스에 액세스할 수 있는지 여부
Adaptive Planning
인 경우 이 특성을 사용하여 사용자가 기본 인스턴스가 아닌 다른 인스턴스에 액세스하려고 함을 지정할 수 있습니다. 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다. 사용가능한 인스턴스 코드를 확인하려면 exportInstances API를 사용합니다.
MYINSTANCE1
요소의 콘텐츠
(없음)
리포트 요소
태그명
리포트
설명
리포트를 구성하는 요소를 지정합니다.
요소의 특성
특성명
필수
예:
값이 0인 항목 표시 안함
API v37에서 업데이트되었습니다.
아니요
이 특성은 행 레벨의 표시 안함을 제어합니다. 이를 지정하면 출력에 0개 또는 빈 행이 포함되는지 여부가 제어됩니다. 유효한 값은 0(아무 것도 표시 안함 - 모든 행 표시), 1(비어 있는 항목 표시 안함 - 빈 셀만 포함하는 행 표시 안함), 2(비어 있는 항목 표시 안함 및 0 - 비어 있거나 0인 셀만 포함하는 행 표시 안함)입니다. 이 특성을 지정하지 않으면 기본값은 2입니다. 해당 셀의 셀 탐색기 값이 비어 있는 경우 해당 셀은 비어 있는 것으로 간주됩니다.
이 특성은 'cell-inclusions' 특성과 함께 작동합니다. 기본 동작을 확인하려면 '셀 포함'을 참조하십시오.
0
셀 포함
API v37에서 사용할 수 있습니다.
아니요
이 속성은 'suppress-0' 속성에 따라 표시되지 않은 모든 행에 대해 셀 레벨에서 표시 안함을 제어합니다. 이를 지정하면 출력에 0 또는 빈 셀이 포함되는지 여부가 제어됩니다. 유효한 값은 0(모두 포함 - 모든 셀 표시), 1(데이터 및 0 포함 - 빈 셀 제외), 2(데이터만 포함 - 0 및 빈 셀 제외)입니다.
기본 동작: 이 특성을 지정하지 않으면 'suppress-0' 특성에 따라 기본 동작이 지정됩니다.  다양한 'suppress-0' 특성 값에 대한 동작:
"suppress-zeroes"
"셀 포함 동작(값)
0
모든 셀 포함(0)
1
데이터 및 0개의 셀 포함(1)
2
데이터 셀만 포함(2)
0
show-cell-notes
아니요
지정된 경우 이 속성은 셀 메모를 표시하거나 숨깁니다. 0=셀 메모 표시 안함(기본값), 1=셀 메모 표시
1
롤업 표시 안함
아니요
지정된 경우 이 특성은 롤업 행 및 열을 표시하거나 숨깁니다. 롤업 행 및 열은 리포트에 child 항목이 있는 parent 항목에 대해서만 표시되지 않습니다. 유효한 값은 0(롤업 표시 안함) 또는 1(롤업 표시 안함)입니다. 기본값은 0입니다.
1
include-element-code
아니요
이 특성이 지정된 경우 이 특성은 Calc(소계, 차이 및 계산) 요소의 코드를 추가하거나 숨깁니다. 유효한 값은 0(계산 요소의 출력에 코드 추가 안함) 또는 1(계산 요소의 출력에 코드 추가)입니다. 기본값은 0입니다.
1
요소의 콘텐츠
자세한 내용은 요청 형식을 참조하십시오.

응답 형식

응답의 XML 스키마는customReportValues REST 사양에서 찾을 수 있습니다.
<?xml version="1.0" encoding="utf-8"?> <response success="true"> <messages> <!-- Dimension value id 13 is invalid. Rows with value id 13 has been removed from the report. --> <message type="WARNING" key="invalid-dim-attr-id" values="199,13">Invalid value Id 199 for dimension/attribute type id 13 </message> </messages> <!-- Global filters. Although the request did not supply any filters, defaults are used when dimension types are not specified. Reporting against version with id 2 which is the current version. Level with id 1 is the top most level this user has access to. --> <filters> <coords> <coord type="ver" rollup="1"> <el id="2" /> </coord> <coord type="lvl" rollup="1"> <el id="1" /> </coord> </coords> </filters> <!-- Only two time columns Dec-2014 and Jan-2015 have data, all other columns have been removed --> <cols> <col id="1"> <coords> <coord type="time"> <el id="179001" /> </coord> </coords> </col> <col id="2"> <coords> <coord type="time"> <el id="180001" /> </coord> </coords> </col> <col id="3"> <coords> <coord code="Subtotal" type="subtotal" /> </coords> </col> </cols> <rows> <row> <!-- Row coordinates are account with id 51 and dimension value with id of 135 from dimension with id of 13 --> <coords> <coord type="acct"> <el id="51" /> </coord> <coord type="dim" entity-id="13"> <el id="135" /> </coord> </coords> <cell value="2.345" col="1" /> <!-- This value’s coordinates are the row coordinates listed above, matches column position 1 and the global filters. --> <cell value="2.345" col="2" /> <!-- This value’s coordinates are the row coordinates listed above, matches column position 2 and the global filters. --> <cell value="4.69" col="3" /> <!-- This value’s coordinates are the row coordinates listed above, matches column position 2 and the global filters. --> </row> <row> <!-- Row coordinates are account with id 53 and dimension value with id of 135 from dimension with id of 13 --> <coords> <coord type="acct"> <el id="53" /> </coord> <coord type="dim" entity-id="13"> <el id="135" /> </coord> </coords> <cell value="5.34" col="1" /> <!-- This value’s coordinates are the row coordinates listed above, matches column position 1 and the global filters. --> <cell value="7.44" col="2" /> <!-- This value’s coordinates are the row coordinates listed above, matches column position 2 and the global filters. --> <cell value="12.78" col="3" /> <!-- This value’s coordinates are the row coordinates listed above, matches column position 2 and the global filters. --> </row> <row> <coords> <coord code="Difference" type="diff" /> <coord type="dim" entity-id="13"> <el id="135" /> </coord> </coords> <cell value="2.995" col="1" /> <cell value="5.095" col="2" /> <cell value="8.09" col="3" /> </row> <row> <coords> <coord type="calc" /> <coord type="dim" entity-id="13"> <el id="135" /> </coord> </coords> <cell value="5.34" col="1" /> <cell value="7.44" col="2" /> <cell value="12.78" col="3" /> </row> </rows> </report> </output> </response>
응답 요소
태그명
응답
요소의 특성
특성명
필수
예:
성공
API 호출의 성공 여부를 나타내는 true 또는 false입니다. 성공한 호출의 경우에도 응답에 경고 메시지가 포함될 수 있습니다.
true
폐지
아니요
응답 태그에 있고 true로 설정된 경우, 이 특성은 호출 중인 메서드 또는 API의 버전이 폐기되어 공식적으로 폐기되었음을 나타냅니다. 현재로서는 계속 작동하지만 잠시 후 작동이 중지될 수 있습니다. 일반적으로 이 특성은 없습니다.
false
요소의 콘텐츠
단일 옵션 메시지 요소와 정확히 하나의 필수 출력 요소
메시지 요소
태그명
메시지
설명
하나 이상의 메시지 요소에 대한 컨테이너입니다.
요소의 특성
(없음)
요소의 콘텐츠
하나 이상의 메시지 요소
메시지 요소
태그명
메시지
설명
시스템에서 호출자에게 다시 전송되는 메시지를 나타냅니다. 이 메시지는 요청이 성공하지 못한 경우의 오류 메시지, 요청이 성공한 경우의 경고 메시지, 성공한 경우의 확인 메시지에 사용됩니다.
요소의 특성
특성명
필수
예:
type
유형은 메시지 유형을 식별하는 방법입니다. 유형은 INFO, WARNING 및 ERROR입니다. '오류' 유형은 이 요청이 처리되지 않았음을 의미합니다.
경고
키는 특정 메시지 또는 메시지 유형을 식별하는 방법이며, 클라이언트 프로그램에서 자동 오류 기록 및 복구를 위해 유용합니다. 메시지의 언어가 변경되더라도 다른 요청 로케일에서는 키는 변경되지 않습니다. 또한 향후에는 문구 조정 또는 용어 변경으로 인해 키가 변경되지 않을 것입니다.
warning-invalid-time-span-start
아니요
지정된 경우 값은 메시지 텍스트에 사용되는 변수를 나타냅니다.
199,12
요소의 콘텐츠
메시지 텍스트입니다. 이 텍스트는 요청에 지정된 로케일의 언어로 표시됩니다(로케일이 지원된다고 가정). 이 텍스트에는 처리된 행 수, 오류가 발생한 특정 열 또는 값과 같은 가변 정보가 포함될 수도 있습니다.
출력 요소
태그명
출력
설명
요소의 특성
(없음)
요소의 콘텐츠
자세한 내용은응답 XML을참조하십시오.