updateLevel
API v20 이상에서는 지원되지 않습니다. updateLevels를사용합니다.
카테고리
| 메타데이터 수정 |
설명
| 레벨을 업데이트합니다. 성공하면 API가 방금 업데이트된 레벨에 대한 세부내용을 반환합니다. |
호출에 필요한 권한
| 조직 구조 |
요청 시 필수 매개변수
| 자격증명 |
이 메서드의 요청에는 호출 사용자를 식별하고 권한을 부여하는 자격증명 태그가 포함되어 있습니다. 레벨을 생성하려면 사용자에게 조직 구조 권한이 있어야 합니다.
이 메서드는 게시되지 않은 변경사항이 있는 경우 오류를 반환합니다.
요청 형식
<?xml version='1.0' encoding='UTF-8'?> <call method="updateLevel" callerName="fred"> <credentials login="sampleuser@company.com" password="my_pwd" /> <level id="41" name="New Level Name" shortName="NewLvlName" > <attributes> <attribute attributeId="20" valueId="199" /> </attributes> </level> </call>
자격증명 요소
| |||
태그명
| 자격증명 | ||
설명
| 모든 API 호출에는 API를 호출하는 사용자를 식별하는 단일 자격증명 요소가 포함되어야 합니다. 그러면 이 사용자로 API 호출이 수행됩니다(시스템의 모든 감사 추적 또는 액션 이력에 이 사용자가 액션을 수행했음이 표시됨). 따라서 사용자에게 액션을 수행하는 데 필요한 권한이 있어야 API 호출이 성공 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
로그인 | 예 | API 메서드를 호출하는 사용자의 로그인명입니다. 이 사용자는 메서드를 호출하는 데 필요한 권한이 있어야 합니다. | sampleuser@company.com |
비밀번호 | 예 | API 메서드를 호출하는 사용자의 비밀번호입니다. | my_password |
로케일 | 아니요 | 수신 숫자 및 날짜를 해석하고 보내는 숫자 및 날짜의 형식을 지정하는 데 사용할 로케일을 지정합니다(적절한 천 단위 구분 기호, 월명 및 날짜 서식 사용). 로케일은 응답의 시스템 메시지에 사용할 언어를 지정하는 데도 사용됩니다. 지정하지 않으면 en_US(미국식 영어)가 사용됩니다. | fr_FR |
instanceCode | 아니요 | 자격증명에 지정된 사용자가 의 두 개 이상의 인스턴스에 액세스할 수 있는지 여부 Adaptive Planning 인 경우 이 속성을 사용하여 사용자가 기본 인스턴스가 아닌 다른 인스턴스에 액세스하려고 함을 지정할 수 있습니다. 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다. 사용가능한 인스턴스 코드를 확인하려면 exportInstances API를 사용합니다. | MYINSTANCE1 |
요소의 콘텐츠
| |||
(없음) | |||
레벨 요소
| |||
태그명
| level | ||
설명
| 업데이트할 레벨을 지정합니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
ID | 예 | 업데이트할 레벨의 ID입니다. | 34 |
이름 | 예 | 레벨의 이름입니다. 이름은 고유해야 합니다.
| 신규 레벨명 |
shortName | 아니요 | 레벨의 약식 이름입니다. | NewLvName |
proceedWithWarnings | 아니요 | 사용자가 경고 메시지를 무시하고 생성 작업을 계속할지 여부를 나타냅니다. 0은 아니요, 1은 예입니다. 경고가 있고 MaintainWithWarnings=0이면 레벨이 생성되지 않습니다. 경고가 있는 경우 레벨을 생성하려면 MaintainWithWarnings=1을 설정합니다. | 1 |
요소의 콘텐츠
| |||
레벨과 연결된 하나 이상의 레벨 특성을 설정하려는 경우 하나의 옵션 특성 요소 | |||
특성 요소
| |||
태그명
| 특성 | ||
설명
| 하나 이상의 레벨 특성 요소에 대한 컨테이너입니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
(없음) | |||
요소의 콘텐츠
| |||
하나 이상의 특성 요소 | |||
특성 요소
| |||
태그명
| 특성 | ||
설명
| 하나의 레벨 특성 요소에 대한 컨테이너입니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
attributeID | 예 | 시스템에서 생성된 레벨 특성의 ID입니다. | 20 |
valueID | 예 | 시스템에서 생성된 레벨 특성 값의 고유 ID입니다.
이 특성 태깅을 제거하려면 valueID=""를 설정하십시오. | 170 |
요소의 콘텐츠
| |||
(없음) | |||
응답 형식
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <levels> <level="41" name="New Level Name" shortName="NewLvlName" currency="USD"> <attribute attributeId="20" name="Regional Code" valueId="199" value="A-145" /> </level> </levels> </output> </response>
출력 요소
| |
태그명
| 출력 |
요소의 특성
| |
(없음) | |
요소의 콘텐츠
| |
단일 필수 레벨 요소 이 출력 랩퍼는 모든 API 응답에서 표준이며, 성공한 API 호출의 유효한 출력을 포함합니다. | |
레벨 요소
| |||
태그명
| 개 레벨 | ||
설명
| 하나 이상의 레벨 요소에 대한 컨테이너입니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
요소의 콘텐츠
| |||
하나 이상의 레벨 요소 요청에 액세스할 수 없는 레벨이 포함된 경우, 조직의 최상위 레벨을 나타내는 하나의 레벨 요소만 있게 됩니다. | |||
레벨 요소
| |||
태그명
| level | ||
설명
| exportLevels API 호출에 대한 응답으로 반환되는 단일 조직 레벨을 나타냅니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
ID | 예 | 레벨의 내부 시스템 ID 번호입니다. | 7 |
이름 | 예 | 리포트 및 시트에 표시되는 레벨의 이름입니다. | Development |
통화 | 예 | 조직의 이 레벨에 지정된 통화의 통화 코드입니다. 통화는 exportActiveCurrencies 호출에서 찾을 수 있는 인스턴스에 대해 구성된 통화 중 하나입니다. | INR |
shortName | 아니요 | 조직 관리에 입력된 레벨의 약어입니다(있는 경우). | 개발자 |
AvailableStart | 아니요 | 레벨 사용가능 실제값 버전의 시작일이며, 요청에 실제값 버전이 지정된 경우에만 적용됩니다. 값은 기간 코드(예: '01/2012') 또는 버전의 시작을 나타내는 특수 값 '시작'일 수 있습니다. | 01/2012 |
availableEnd | 아니요 | 레벨 사용가능 실제값 버전의 종료일이며, 요청에 실제값 버전이 지정된 경우에만 적용됩니다. 값은 기간 코드(예: '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 | 예 | 레벨이 링크 레벨인지 여부를 나타냅니다. 0은 아니요, 1은 예입니다. | 1 |
isElimination | 예 | 레벨이 소거 레벨인지 여부를 나타냅니다. 0은 아니요, 1은 예입니다. | 0 |
요소의 콘텐츠
| |||
이 레벨의 직계 child 레벨마다 하나의 중첩 레벨 요소 이 레벨에 하나 이상의 특성이 연결된 경우 하나의 특성 요소 | |||
특성 요소
| |||
태그명
| 특성 | ||
설명
| 하나 이상의 특성 요소에 대한 컨테이너입니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
(없음) | |||
요소의 콘텐츠
| |||
하나 이상의 특성 요소 | |||
특성 요소
| |||
태그명
| 특성 | ||
설명
| 레벨이 연결된 비어 있지 않은 단일 레벨 특성 매핑을 나타냅니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
이름 | 예 | 레벨 특성의 이름입니다. | 법인 할인 |
값 | 예 | 레벨과 연결된 레벨 특성의 값입니다. | 예 |
attributeID | 예 | 레벨 특성의 내부 시스템 ID 번호입니다. | 20 |
valueID | 예 | 레벨 특성 값의 내부 시스템 ID 번호입니다. | 188 |
요소의 콘텐츠
| |||
(없음) | |||