recalculateSheet
API v16 이상에서 지원
카테고리
| 데이터 제출 |
설명
| 요청시 재계산 속성을 사용하여 시트 재계산 |
호출에 필요한 권한
| 시트 편집 권한 |
요청 시 필수 매개변수
| 자격증명 |
이 메서드의 요청에는 호출 사용자를 식별하고 권한을 부여하는 자격증명 태그가 포함되어 있습니다. 재계산하려면 사용자에게 '시트 편집 권한' 권한이 있어야 합니다.
요청 형식
<?xml version='1.0' encoding='UTF-8'?> <call method="recalculateSheet" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_password"/> <version name="Default Structure"/> <sheet name="Expense Cube"/> <level name="Corporate Plan"/> </call>
- version 요소 - 버전이 지정되지 않은 경우 오류가 발생합니다.
- 시트 요소 - 시트 요소를 지정하지 않으면 요청시 재계산 옵션이 있는 모든 시트가 지정된 버전의 최상위 레벨에서 재계산됩니다. 이 경우 레벨은 무시됩니다.
- 레벨 요소
- 레벨을 지정하지 않으면 지정된 버전의 최상위 레벨에서 시트가 재계산됩니다.
- 사용자에게 지정된 레벨에 대한 액세스 권한이 없으면 오류가 발생합니다.
- 지정된 버전의 레벨 및 해당 descendant 항목에 대한 시트가 재계산됩니다.
자격증명 요소
| |||
태그명
| 자격증명 | ||
설명
| 모든 API 호출에는 단일 Credentials 요소를 사용하여 API를 호출하는 사용자를 식별합니다. 그러면 이 사용자로 API 호출이 수행됩니다(시스템의 모든 감사 추적 또는 액션 이력에 이 사용자가 액션을 수행했음이 표시됨). 따라서 사용자에게 액션을 수행하는 데 필요한 권한이 있어야 API 호출이 성공 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
로그인 | 예 | API 메서드를 호출하는 사용자의 로그인명입니다. 이 사용자는 메서드를 호출하는 데 필요한 권한이 있어야 합니다. | sampleuser@company.com |
비밀번호 | 예 | API 메서드를 호출하는 사용자의 비밀번호입니다. | my_password |
로케일 | 아니요 | 수신 숫자 및 날짜를 해석하고 보내는 숫자 및 날짜의 형식을 지정하는 데 사용할 로케일을 지정합니다(적절한 천 단위 구분 기호, 기간명 및 날짜 서식 사용). 로케일은 응답의 시스템 메시지에 사용할 언어를 지정하는 데도 사용됩니다. 지정하지 않으면 en_US(미국식 영어)가 사용됩니다. | fr_FR |
instanceCode | 아니요 | 자격증명에 지정된 사용자가 의 두 개 이상의 인스턴스에 액세스할 수 있는지 여부 Adaptive Planning 인 경우 이 속성을 사용하여 사용자가 기본 인스턴스가 아닌 다른 인스턴스에 액세스하려고 함을 지정할 수 있습니다. 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다. 사용가능한 인스턴스 코드를 확인하려면 exportInstances API를 사용합니다. | MYINSTANCE1 |
요소의 콘텐츠
| |||
(없음) | |||
버전 요소
| |||
태그명
| 버전 | ||
설명
| 요청된 데이터를 수신하는 데 사용해야 하는 버전을 나타냅니다. 각 호출에 대해 버전을 제공해야 합니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
이름 | 아니요 | 버전의 이름입니다. | 기본 구조 |
ID | 아니요 | 버전의 ID입니다. ID는 name이 없는 경우에만 고려됩니다. | 4 |
요소의 콘텐츠
| |||
(없음) | |||
시트 요소
| |||
태그명
| 시트 | ||
설명
| 이름 또는 ID로 정의된 시트 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
이름 | 아니요 | 시트의 이름입니다. | 경비 큐브 |
ID | 아니요 | 시트의 ID입니다. ID는 name이 없는 경우에만 고려됩니다. | 1 |
요소의 콘텐츠
| |||
(없음) | |||
레벨 요소
| |||
태그명
| level | ||
설명
| 이름 또는 ID로 정의된 레벨 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
이름 | 아니요 | 레벨의 이름입니다. | 법인 플랜 |
ID | 아니요 | 레벨의 ID입니다. 레벨은 name이 없는 경우에만 고려됩니다. | 1 |
요소의 콘텐츠
| |||
(없음) | |||
응답 형식
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> </response>
응답 요소
| |||
태그명
| 응답 | ||
설명
| 이름 또는 ID로 정의된 레벨 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
성공 | 예 | API 호출의 성공 여부를 나타내는 'true' 또는 'false'입니다. 성공한 호출의 경우에도 응답에 경고 메시지가 포함될 수 있습니다. | true |
요소의 콘텐츠
| |||
단일 옵션 메시지 요소 | |||
메시지 요소
| |||
태그명
| 메시지 | ||
설명
| 하나 이상의 컨테이너 메시지 요소 | ||
요소의 특성
| |||
(없음) | |||
요소의 콘텐츠
| |||
하나 이상 메시지 요소 | |||
메시지 요소
| |||
태그명
| 메시지 | ||
설명
| 시스템에서 호출자에게 다시 전송되는 메시지를 나타냅니다. 메시지는 요청이 성공하지 못한 경우의 오류 메시지, 요청이 성공한 경우의 경고 메시지, 성공의 경우 확인 메시지에 사용됩니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
키 | 아니요 | 지정된 경우 키는 특정 메시지 또는 메시지 유형을 식별하는 방법이며, 클라이언트 프로그램에서 자동화된 오류 기록 및 복구를 위해 유용합니다. 메시지의 언어가 변경되더라도 다른 요청 로케일에서는 키는 변경되지 않습니다. 또한 향후에는 문구 조정 또는 용어 변경으로 인해 키가 변경되지 않을 것입니다. | invalid-attributevalueid |
요소의 콘텐츠
| |||
| |||