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

exportLevels

이 API는 사용자 개념: 액세스 규칙API v22 이상
카테고리
메타데이터 검색
설명
시스템에 있는 모든 조직 레벨의 전체 목록에 대한 메타데이터를 반환합니다.
호출에 필요한 권한
없음(인스턴스에 대해 유효한 자격증명이어야 함)
요청 시 필수 매개변수
자격증명
이 메서드의 요청에는 호출 사용자를 식별하고 권한을 부여하는 자격증명 태그와 응답에 포함할 레벨을 나타내는 포함 태그(옵션)가 포함되어 있습니다. 사용자 자격증명이 확인되면 이 메서드는 요청에 해당하는 시스템의 조직 레벨 세트를 설명하는 XML 문서를 반환합니다. 레벨은 중첩된 트리 방식으로 반환되며, 바깥쪽 태그로 표시되는 레벨이 묶인 레벨의 parent인 경우 하나의 레벨 태그가 다른 레벨 태그를 묶습니다.

레벨 필터링

  • 사용불가 레벨/버전 필터링은 버전이 지정된 경우 항상 적용됩니다.
  • 사용자가 요청에서 사용자 지정 시트를 지정하는 경우:
    • 사용자에게 해당 시트에 대한 액세스 권한이 있으면 레벨이 반환됩니다. 관리자 사용자의 경우
      inaccessibleValues
      이 true이면 시트에 대한 레벨이 반환됩니다.
    • 사용자에게 시트에 대한 액세스 권한이 있으면 사용자의 레벨 액세스 권한과 관계없이 시트의 모든 레벨이 반환됩니다.
  • 사용자가 요청에서 레벨 지정 시트를 지정하는 경우:
    • 다음에 의해 필요한 경우 사용자 액세스 필터링이 적용됩니다.
      inaccessibleValues,
      사용자가 액세스할 수 없는 레벨을 응답에 포함할지 여부를 결정합니다.
    • 그러면 시트 필터링이 적용됩니다.

요청 형식


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportLevels" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_pwd"/>
   <include versionID="3" inaccessibleValues="false"/>
   <sheet id="3" />
</call>
자격증명 요소
태그명
자격증명
설명
모든 API 호출에는 API를 호출하는 사용자를 식별하는 단일 자격증명 요소가 포함되어야 합니다. 그런 다음 이 사용자로 API 호출이 수행됩니다(시스템의 모든 감사 추적 또는 액션 이력에 이 사용자가 액션을 수행했음이 표시됨). 따라서 사용자에게 액션을 수행하는 데 필요한 권한이 있어야 API가 실행됩니다. 성공하려면 이 옵션을 선택하십시오.
요소의 특성
특성명
필수
값
예:
로그인
예
API 메서드를 호출하는 사용자의 로그인명입니다. 이 사용자는 메서드를 호출하는 데 필요한 권한이 있어야 합니다.
sampleuser@company.com
비밀번호
예
API 메서드를 호출하는 사용자의 비밀번호입니다.
my_password
로케일
아니요
수신 숫자 및 날짜를 해석하고 보내는 숫자 및 날짜의 형식을 지정하는 데 사용할 로케일을 지정합니다(적절한 천 단위 구분 기호, 월명 및 날짜 서식 사용). 로케일은 응답의 시스템 메시지에 사용할 언어를 지정하는 데도 사용됩니다. 지정하지 않으면 en_US(미국식 영어)가 사용됩니다.
fr_FR
instanceCode
아니요
자격증명에 지정된 사용자가 의 두 개 이상의 인스턴스에 액세스할 수 있는지 여부
Adaptive Planning
인 경우 이 속성을 사용하여 사용자가 기본 인스턴스가 아닌 다른 인스턴스에 액세스하려고 함을 지정할 수 있습니다. 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다. 사용가능한 인스턴스 코드를 확인하려면 exportInstances API를 사용합니다.
MYINSTANCE1
요소의 콘텐츠
(없음)
요소 포함
태그명
포함
설명
응답에서 포함하거나 제외해야 하는 레벨 정보의 측면을 나타내는 플래그 세트를 나타냅니다. 이 요소는 옵션입니다. 이 요소가 없으면 기본값은 inAccessibleValues에 대해 false이고, versionName/versionID에 대해서는 공백(또는 모든 버전)입니다.
요소의 특성
특성명
필수
값
예:
개 그룹
API v23+에서 사용가능
아니요
응답의 레벨 요소에 groupIds 특성이 포함되는지 여부를 나타냅니다. true인 경우 응답의 groupId에 레벨이 속한 모든 그룹이 쉼표로 구분된 목록이 포함됩니다. 특성이 없거나 해당 값이 true 또는 false가 아닌 경우 기본값 false가 사용됩니다.
true
inaccessibleValues
API v18 이상에서 사용할 수 있습니다.
아니요
사용자가 액세스할 수 없는 레벨을 응답에 포함할지 여부입니다. true 또는 false입니다.
요소 또는 해당 특성이 없는 경우 기본값은 false입니다.
false로 설정하면 사용자가 직접 또는 암시적으로 데이터에 액세스할 수 있는 레벨만 응답에 포함됩니다. 이는 응답이 더 이상 단일 root 레벨 트리가 아니라 전체 트리의 일련의 연결되지 않은 하위 트리일 수 있음을 의미합니다.
'조직 구조: 모든 레벨' 또는 '모든 레벨로 가져오기' 권한이 있는 사용자만 이 옵션을 true로 설정할 수 있습니다.
false
inaccessibleLevels
API v17 이하에서 사용할 수 있습니다. API v18 이상에서는 사용할 수 없습니다.
아니요
true 또는 false입니다. 사용자가 액세스할 수 없는 레벨을 응답에 포함할지 여부입니다.
요소 또는 해당 특성이 없는 경우 기본값은 true입니다. false로 설정하면 사용자가 직접 또는 암시적으로 데이터에 액세스할 수 있는 레벨만 응답에 포함됩니다. 이는 응답이 더 이상 단일 root 레벨 트리가 아니라 전체 트리의 일련의 연결되지 않은 하위 트리일 수 있음을 의미합니다.
true
versionName
API v18에서 업데이트됨
아니요
요청한 버전명에 사용할 수 있는 레벨만 응답에 포함할지 여부를 나타냅니다. 요소 또는 해당 특성이 없는 경우 기본값은 모든 레벨을 반환하는 것입니다. 버전명이 지정되면 지정된 버전에 사용가능한 레벨만 반환됩니다.
inAccessibleValues 특성도 적용되며, 지정된 버전에서 사용가능하고 요청 사용자가 액세스할 수 있는 레벨만 반환됩니다.
지정된 버전명을 찾을 수 없으면 이 API는 오류를 반환합니다. versionName 및 versionID 특성이 모두 전달되면 versionID가 무시됩니다.
버전을 지정할 때 사용자에게 버전에 대한 액세스 권한이 있는 경우에만 호출이 성공합니다.
Engineering
versionID
API v18에서 업데이트됨
아니요
버전 ID 번호를 매개변수로 사용한다는 점을 제외하면 위의 versionName과 동일합니다. 요청된 버전에 사용가능한 레벨만 응답에 포함할지 여부를 나타냅니다. 요소 또는 해당 특성이 없는 경우 기본값은 모든 레벨을 반환하는 것입니다. 버전 ID가 지정되면 지정된 버전에 사용가능한 레벨만 반환됩니다.
inAccessibleValues 특성도 적용되며, 지정된 버전에서 사용가능하고 요청 사용자가 액세스할 수 있는 레벨만 반환됩니다.
지정된 버전 ID를 찾을 수 없으면 이 API는 오류를 반환합니다. versionName 및 versionID 특성이 모두 전달되면 versionID가 무시됩니다.
버전을 지정할 때 사용자에게 버전에 대한 액세스 권한이 있는 경우에만 호출이 성공합니다.
3
카테고리 미지정
인스턴스가 보안을 위해액세스 규칙을사용하는 경우 API v22 이상에서 지원됩니다.
아니요
응답에 팬텀 레벨을 포함할지 여부를 나타냅니다. 기본값은 false입니다. 사용자에게 액세스 권한이 있는 경우에만 가상 레벨이 응답에 포함됩니다.
false
displayNameEnabled
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다.
아니요
displayNameEnabled=true는 exportLevels가 의 표시명 속성을 준수해야 함을 나타냅니다.
code
,
displayNameType
및
description
인스턴스에 대해 표시명 사용이 설정된 경우
displayNameEnabled=false는 인스턴스에 대해 '표시명 사용'이 활성화된 경우에도 exportLevels API가 v30 이전 API 계약을 계속 따라야 함을 나타냅니다. exportLevels API는 표시명 속성을 무시합니다.
code
,
displayNameType
및
description
.
displayNameEnabled의 기본값은 'false'입니다.
false
요소의 콘텐츠
(없음)
시트 요소
태그명
시트
설명
시트에 사용가능한 레벨만 응답에 포함되는 시트를 나타냅니다. 이 요소는 옵션입니다. 이 요소가 없으면 API가 특정 시트와 관계없이 레벨 정보를 반환합니다. 지정된 시트가 레벨 지정 시트인 경우 이 필터링은 버전 및 사용자 액세스 필터링(있는 경우)의 맨 위에 적용됩니다. 지정된 시트가 현재 사용자가 액세스할 수 있는 사용자 지정 시트인 경우 버전 필터링 후 해당 시트의 모든 레벨이 반환됩니다.
요소의 특성
특성명
필수
값
예:
ID
예
시트의 내부 시스템 ID 번호입니다.
234
요소의 콘텐츠
(없음)

응답 형식


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
 <levels seqNo="21">
   <level id="1" name="Corporate Rollup" currency="USD" isImportable="1" workflowStatus="I">
     <level id="2" name="Engineering" currency="USD" shortName="Engr" isImportable="1" workflowStatus="I">
       <level id="7" name="Development" currency="USD" shortName="Dev" isImportable="1" workflowStatus="I"/>
       <level id="8" name="QA" currency="INR" isImportable="0" workflowStatus="L"/>
       <level id="9" name="Documentation" currency="PKR" shortName="Doc" isImportable="1" workflowStatus=R"/>
     </level>
     <level id="3" name="Professional Services" currency="USD" shortName="Prof.Srv" isImportable="0" workflowStatus="A">
       <attributes>
         <attribute name="Corporate Discount" value="Available" attributeId="20" valueId="188" />
         <attribute name="Transfers Restricted" value="Yes" attributeId="21" valueId="194" />
       </attributes>
     </level>
   </level>
 </levels>
</output>
</response>
응답 요소
태그명
응답
요소의 특성
특성명
필수
값
예:
성공
예
API 호출의 성공 여부를 나타내는 true 또는 false입니다. 성공한 호출의 경우에도 응답에 경고 메시지가 포함될 수 있습니다.
true
폐지
아니요
이 특성이 응답 태그에 있고 true로 설정된 경우, 이 특성은 호출 중인 메서드 또는 API의 버전이 폐기되어 공식적으로 폐기됨을 나타냅니다. 현재로서는 계속 작동하지만 잠시 후 작동이 중지될 수 있습니다. 일반적으로 이 특성은 없습니다.
false
요소의 콘텐츠
단일 옵션 메시지 요소와 정확히 하나의 필수 출력 요소
출력 요소
태그명
출력
요소의 특성
(없음)
요소의 콘텐츠
단일 계정 요소 이 출력 랩퍼는 모든 API 응답에서 표준이며, 성공한 API 호출의 유효한 출력을 포함합니다.
레벨 요소
태그명
개 레벨
설명
레벨 요소의 컨테이너입니다.
요소의 특성
특성명
필수
값
예:
seqNo
API v17에 추가되었지만 향후 사용을 위해 예약되어 있습니다.
요소의 콘텐츠
하나 이상의 레벨 요소 요청에 액세스할 수 없는 레벨이 포함된 경우, 조직의 최상위 레벨을 나타내는 하나의 레벨 요소만 있게 됩니다.
레벨 요소
태그명
level
설명
exportLevels API 호출에 대한 응답으로 반환되는 단일 조직 레벨을 나타냅니다.
요소의 특성
특성명
필수
값
예:
ID
예
레벨의 내부 시스템 ID 번호입니다.
7
코드
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다.
아니요
레벨의 코드입니다.
Development
이름
예
리포트 및 시트에 표시되는 레벨의 이름입니다.
Development
displayName
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다.
아니요
displayNameType에서 파생된 레벨의 표시명입니다.
Development
통화
예
조직의 이 레벨에 지정된 통화의 통화 코드입니다. 통화는 exportActiveCurrencies 호출에서 찾을 수 있는 인스턴스에 대해 구성된 통화 중 하나입니다.
INR
publishCurrency
API v24 이상에서 사용가능
아니요
이 레벨에서 게시하도록 지정된 통화의 통화 코드입니다. 이 속성은 인스턴스에 대해 1의 거듭제곱이 활성화된 경우에만 적용할 수 있습니다. 통화는 exportActiveCurrencies 호출에서 찾을 수 있는 인스턴스에 대해 구성된 통화 중 하나입니다.
USD
shortName
아니요
레벨 관리에 입력된 레벨의 약어입니다(있는 경우).
개발자
AvailableStart
아니요
레벨 사용가능 실제값 버전의 시작 기간으로, 요청에 ACTUALS 버전이 지정된 경우에만 적용됩니다. 값은 기간 코드(예: '01/2012') 또는 버전의 시작을 나타내는 특수 값 '시작'일 수 있습니다.
01/2013
availableEnd
아니요
실제값 버전 레벨의 사용가능 설정 종료 기간으로, 요청에 ACTUALS 버전이 지정된 경우에만 적용됩니다. 값은 기간 코드(예: '12/2013')이거나 버전의 종료를 나타내는 특수 값 'END'일 수 있습니다.
12/2013
isImportable
아니요
연결된 레벨을 지정된 버전에서 가져올 수 있는지 여부를 나타냅니다. '0'은 가져올 수 없음을 나타내고, '1'은 가져올 수 있음을 나타냅니다. 지정된 버전에서 하나 이상의 타임슬롯을 가져올 수 있는 경우 레벨을 가져올 수 있습니다. isImportable 특성은 요청에 versionName 또는 versionID가 지정된 경우에만 내보내집니다.
참고: isImportable은 지정된 버전에서 레벨을 가져올 수 있음을 나타낼 뿐이며, API를 호출하는 사용자에게 해당 버전 또는 레벨로 가져올 수 있는 권한이 있음을 나타내는 것은 아닙니다. exportVersions를 사용하여 사용자가 가져오기에 사용할 수 있는 버전을 확인합니다.
1
workflowStatus
아니요
연결된 레벨의 워크플로 상태를 내보냅니다. I: '진행 중', S는 '제출', R은 '거부', A는 '승인', L은 '잠금' 이 회사에 대해 워크플로가 활성화되어 있고 계획 versionName 또는 versionID가 요청에 지정된 경우에만 응답에 포함됩니다. 실제값 버전에서는 워크플로를 사용할 수 없습니다.
I
isLinked
예
레벨이 링크 레벨인 경우 1입니다. 그렇지 않으면 0입니다.
1
isElimination
예
레벨이 소거 레벨인 경우 1입니다. 그렇지 않으면 0입니다.
0
hasChildren
아니요
레벨에 child 레벨이 있는지 여부를 나타냅니다. 'false': 아니요, 'true': 예 이 특성은 child에 액세스할 수 있는지 여부와 관계없이 child가 있는 모든 레벨에 대해 설정됩니다. 레벨에 child 레벨이 있지만 child 레벨에 액세스할 수 없는 경우 hasChildren 특성은 여전히 true로 설정됩니다.
true
설명
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다.
아니요
레벨 관리에 입력된 레벨에 대한 설명(있는 경우)
요소의 콘텐츠
이 레벨의 직계 child 레벨마다 하나의 중첩 레벨 요소 이 레벨에 하나 이상의 특성이 연결된 경우 하나의 특성 요소
특성 요소
태그명
특성
설명
하나 이상의 특성 요소에 대한 컨테이너입니다.
요소의 특성
특성명
필수
값
예:
(없음)
요소의 콘텐츠
하나 이상의 특성 요소
특성 요소
태그명
특성
설명
레벨이 연결된 비어 있지 않은 단일 레벨 특성 매핑을 나타냅니다.
요소의 특성
특성명
필수
값
예:
이름
예
레벨 특성의 이름입니다.
법인 할인
값
유효 표시명 설정이 ON인 API v34에서 지원됩니다.
예
레벨과 연결된 레벨 특성의 값입니다.
예
valueCode
표시명을 활성화하는 인스턴스의 API v32 및 API v33에서만 사용할 수 있습니다.
유효 표시명 설정이 ON인 API v34에서는 지원되지 않습니다.
아니요
이 특성의 특성 값 코드입니다.
API v32 및 v33에서 valueCode는 다음과 같은 경우에만 의미가 있습니다.
  • 인스턴스에 대해 표시명 설정이 ON입니다.
  • displayNameEnabled=1
예
valueName
표시명을 활성화하는 인스턴스의 API v32 및 API v33에서만 사용할 수 있습니다.
유효 표시명 설정이 ON인 API v34에서는 지원되지 않습니다.
아니요
이 특성의 특성 값 이름입니다.
API v32 및 API v33에서 valueName은 다음과 같은 경우에만 의미가 있습니다.
  • 인스턴스에 대해 표시명 설정이 ON입니다.
  • displayNameEnabled=1value
예
valueDisplayName
표시명을 활성화하는 인스턴스의 API v32 이상에서만 사용할 수 있습니다.
예
특성 값의 표시명입니다.
API v32 이상의 경우 valueDisplayName은 다음과 같은 경우에만 의미가 있습니다.
  • 인스턴스에 대해 표시명 설정이 ON입니다.
  • displayNameEnabled=1value
예
attributeID
예
레벨 특성의 내부 시스템 ID 번호입니다.
20
valueID
예
레벨 특성 값의 내부 시스템 ID 번호입니다.
188
요소의 콘텐츠
(없음)