eraseData
API v24 이상에서 지원됩니다.
카테고리
| 데이터 제출 |
설명
| 레벨 및 계정에 대한 옵션 필터를 사용하여 계정에 대해 지정된 기간의 계획 또는 실제값 데이터를 지웁니다. |
호출에 필요한 권한
| 데이터 지우기 |
요청 시 필수 매개변수
| 자격증명, 지우기 옵션 |
지정된 기간 동안 지정된 계정 세트의 계획 또는 실제값 버전에서 숫자 값을 지웁니다. 수식(예: 공유 수식, 셀 수식, 계정 수식)은 지워지지 않습니다. 지우기 프로세스의 결과로 비어 있는 계정 분할이 삭제됩니다. 빈 분할은 데이터, 수식 또는 셀 메모가 포함되지 않은 분할입니다. 지우기로 인해 분할에서 마지막 데이터가 삭제되는 경우 해당 분할이 삭제됩니다. 이 API는 API를 호출하기 전에 분할이 비어 있는 경우 분할을 그대로 둡니다.
eraseData 메서드는 eraseActuals와 동일한 기능을 제공하지만, 대상인 특정 계정-계획 조합을 추가로 제어하여 계획 데이터를 지우는 기능도 포함합니다. 조건에 일치하는 셀 메모도 삭제됩니다.
잠긴 레벨을 포함하여 Adaptive Planning 전반에서 실제값 또는 계획 데이터를 지울 수 있는 슈퍼유저 권한입니다. 데이터 지우기는 액세스 규칙 및 레벨 소유권 제한을 재정의합니다. 데이터 입력 재정의가 있는 계산 계정에서만 데이터를 삭제할 수 있습니다.
이 API는 선택한 계정에서 시간 단위를 검증합니다.
롤업 계정 지우기
Erase Data API는 롤업 계정의 데이터를 지우지 않습니다. 요청에 각 계정을 개별적으로 포함합니다.
레벨 지우기
요청에서 parent 레벨을 전달하면 eraseData API는 child 레벨이 아닌 parent 레벨의 데이터만 지웁니다. API 요청에 각 레벨을 개별적으로 포함해야 합니다.
요청 형식
인식할 수 없는 태그를 요청하면 거부됩니다. 태그는 대소문자를 구분하지 않는 매칭을 허용합니다. 예: <accounts>, <Accounts> 및 <ACCOUNTS>는 Accounts 요소에 사용할 수 있습니다.
기본 실제값 버전의 모든 레벨에 대한 실제값 지우기
기본 실제값 버전의 모든 레벨에 대한 모든 총계정원장 계정에서 시작과 종료 사이의 기간에 대한 숫자 값과 새로 비어 있는 분할을 지우려면 다음을 수행합니다.
<?xml version="1.0" encoding="UTF-8"?> <call method="eraseActuals" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE" locale="en_US"/> <eraseOptions actualsVersionName="Actuals" accountType="GL" start="01/2013" end="03/2013" includeCellNotes="false" /> </call>
지정된 시작과 종료 사이의 특정 실제값 버전의 모든 레벨에 대한 단일 큐브 시트에서 숫자 값과 셀 메모를 지우려면 다음을 수행합니다.
<?xml version="1.0" encoding="UTF-8"?> <call method="eraseActuals" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_password"/> <eraseOptions actualsVersionName="Actuals" accountType="CUBE" cubeSheetName="Sales Cube" start="01/2013" end="03/2013" includeCellNotes="true" /> </call>
특정 레벨의 계정에 대한 필터를 사용하여 실제값 데이터 지우기
이 예에서 실제값 버전의 실제값 데이터는
ActualsSubVersion2013
커스텀 계정 WAT_Input_Custom
및 WAT_Test_Custom
레벨의 QA
이 삭제됩니다.<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData" callerName="test caller api name"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE" locale="en_US" /> <eraseOptions actualsVersionName="ActualsSubVersion2013" accountType="CUSTOM" start="01/2010" end="11/2010" includeCellNotes="true"> <filters> <Accounts> <Account code="WAT_Input_Custom"/> <Account code="WAT_Test_Custom"/> </Accounts> <Levels> <Level name="QA"/> </Levels> </filters> </eraseOptions> </call>
특정 커스텀 계정에서 삭제할 필터를 사용하여 계획 데이터 지우기
이 예에서는 계획 버전의 계획 데이터가
clone2013Budget
커스텀 계정 SUM_TEXT
및 LAST_NB
이 삭제됩니다.<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/> <eraseOptions planVersionName="clone2013budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true"> <filters> <Accounts> <Account code="SUM_TEXT"/> <Account code="LAST_NB"/> </Accounts> </filters> </eraseOptions> </call>
특정 레벨의 특정 커스텀 계정에서 삭제할 필터를 사용하여 계획 데이터 지우기
이 예에서는 계획 버전의 계획 데이터가
clone2013Budget
커스텀 계정 WA_SUM
및 SUM_SUM
레벨 Development
및 Hosting
이 삭제됩니다.<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData" callerName="test caller api name"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/> <eraseOptions planVersionName="clone2013Budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true"> <filters> <Accounts> <Account code="WA_SUM"/> <Account code="SUM_SUM"/> </Accounts> <Levels> <Level name="Development"/> <Level name="Hosting"/> </Levels> </filters> </eraseOptions> </call>
특정 레벨의 특정 큐브 계정에서 삭제할 필터를 사용하여 계획 데이터 지우기
이 예에서는 계획 버전의 계획 데이터가
10YearBudget
- 큐브 계정 ExpenseCube.Units
레벨에서 WorldWide Sales
이 삭제됩니다.<?xml version="1.0" encoding="UTF-8"?> <call method="eraseData" callerName="test caller api name"> <credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US" /> <eraseOptions planVersionName="10YearBudget" accountType="CUBE" cubeSheetName="Expense Cube" start="01/2010" end="12/2017" includeCellNotes="true"> <filters> <Accounts> <Account code="ExpenseCube.Units" /> </Accounts> <Levels> <Level name="WorldWide Sales" /> </Levels> </filters> </eraseOptions> </call>
자격증명 요소
| |||
태그명
| 자격증명 | ||
설명
| 모든 API 호출에는 단일Credentials 요소를 사용하여 API를 호출하는 사용자를 식별합니다. 그러면 이 사용자로 API 호출이 수행됩니다(시스템의 모든 감사 추적 또는 액션 이력에 이 사용자가 액션을 수행했음이 표시됨). 따라서 사용자에게 액션을 수행하는 데 필요한 권한이 있어야 API 호출이 성공 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
로그인 | 예 | API 메서드를 호출하는 사용자의 로그인명입니다. 이 사용자는 메서드를 호출하는 데 필요한 권한이 있어야 합니다. | sampleuser@company.com |
비밀번호 | 예 | API 메서드를 호출하는 사용자의 비밀번호입니다. | my_password |
로케일 | 아니요 | 수신 숫자 및 날짜를 해석하고 보내는 숫자 및 날짜의 형식을 지정하는 데 사용할 로케일을 지정합니다(적절한 천 단위 구분 기호, 기간명 및 날짜 서식 사용). 로케일은 응답의 시스템 메시지에 사용할 언어를 지정하는 데도 사용됩니다. 지정하지 않으면 en_US(미국식 영어)가 사용됩니다. | fr_FR |
instanceCode | 아니요 | 자격증명에 지정된 사용자가 의 두 개 이상의 인스턴스에 액세스할 수 있는지 여부 Adaptive Planning 인 경우 이 속성을 사용하여 사용자가 기본 인스턴스가 아닌 다른 인스턴스에 액세스하려고 함을 지정할 수 있습니다. 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다. 사용가능한 인스턴스 코드를 확인하려면 exportInstances API를 사용합니다. | MYINSTANCE1 |
요소의 콘텐츠
| |||
(없음) | |||
eraseOptions 요소
| |||
태그명
| eraseOptions | ||
설명
| 실제값 또는 계획 데이터를 지울 때 사용되는 옵션을 지정합니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
actualsVersionName | 아니요 | 실제값 데이터를 지우는 데 필요합니다. 데이터를 지울 실제값 버전의 이름을 지정합니다. 수식(예: 공유 수식, 셀 수식, 계정 수식)은 지우지 않습니다. | ActualsSubVersion2013 |
planVersionName | 아니요 | 계획 데이터를 지우는 데 필요합니다. 데이터를 지울 계획 버전의 이름을 지정합니다. 수식(예: 공유 수식, 셀 수식, 계정 수식)은 지우지 않습니다. | clone2013Budget |
accountType | 예 | 계정 유형이 총계정원장("GL"), 커스텀("CUSTOM") 또는 큐브 시트("큐브")입니다. | GL |
cubeSheetName | 아니요 | 필수accountType="큐브"입니다. 큐브 시트의 이름을 지정합니다. | 영업 큐브 |
시작 | 예 | 시간 범위의 시작 기간 코드를 지정합니다. 코드는 계정의 시간 단위에서 기간을 참조해야 합니다. 큐브 시트를 지정하는 경우 코드는 큐브 시트의 시간 단위에서 기간을 참조해야 합니다. GL 또는 커스텀 계정 유형을 지정하는 경우 코드는 기본 시간 단위를 참조해야 합니다.
지정된 기간은 계정의 시간 단위와 일치해야 합니다. 예를 들어, 계정의 시간 단위가 1월에 시작하는 분기인 경우 2월을 시작으로 선택할 수 없습니다. | 01/2013 |
종료 | 예 | 시간 범위의 종료 기간 코드를 지정합니다. 코드는 계정의 시간 단위에서 기간을 참조해야 합니다. 큐브 시트를 지정하는 경우 코드는 큐브 시트의 시간 단위에서 기간을 참조해야 합니다. GL 또는 커스텀 계정 유형을 지정하는 경우 코드는 기본 시간 단위를 참조해야 합니다.
지정된 기간은 계정의 시간 단위와 일치해야 합니다. 예를 들어, 계정의 시간 단위가 1월에 시작하는 분기인 경우 2월을 종료일로 선택할 수 없습니다. | 03/2013 |
includeCellNotes | 예 | 'true'로 설정하면 eraseData는 에서 데이터도 지우는지 여부와 관계없이 선택한 버전, 계정 유형 및 시간 범위(및 필터가 지정된 경우 필터와 일치하는 계정 레벨 조합)의 모든 셀 메모를 지웁니다. 셀 'false'이면 셀 메모가 삭제되지 않습니다. | true |
displayNameEnabled
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다. | 아니요 | displayNameEnabled=true는 eraseData가 의 표시명 속성을 준수해야 함을 나타냅니다. code 인스턴스에 대해 표시명 사용이 설정된 경우displayNameEnabled=false는 인스턴스에 대해 '표시명 사용'이 켜져 있는 경우에도 eraseData API가 v30 이전 API 계약을 계속 따라야 함을 나타냅니다. eraseData API가 표시명 속성을 무시합니다. code .displayNameEnabled의 기본값은 'false'입니다. | True |
요소의 콘텐츠
| |||
(없음) | |||
필터 요소
| |||
태그명
| 필터 | ||
설명
| 데이터를 지울 때 사용할 계정 및 레벨 필터를 지정합니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
요소의 콘텐츠
| |||
계정 요소, 레벨 요소 또는 계정 요소와 레벨 요소 둘 다 | |||
계정 요소
| |||
태그명
| 계정 | ||
설명
| eraseData 필터의 하나 이상의 계정 요소에 대한 컨테이너입니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
요소의 콘텐츠
| |||
하나 이상의 계정 요소 | |||
레벨 요소
| |||
태그명
| 레벨 | ||
설명
| eraseData 필터의 하나 이상의 레벨 요소에 대한 컨테이너입니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
요소의 콘텐츠
| |||
하나 이상의 레벨 요소 | |||
계정 요소
| |||
태그명
| 계정 | ||
설명
| 데이터가 지워질 소스 계정으로, 계정 코드로 지정됩니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
코드 | 예 | 지울 데이터의 계정에 대한 계정 코드를 지정합니다. | WA_SUM |
요소의 콘텐츠
| |||
(없음) | |||
레벨 요소
| |||
태그명
| Level | ||
설명
| 지울 계정 데이터의 레벨로, 레벨명으로 지정됩니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
이름 | 예 | 지워지는 계정 데이터의 레벨명을 지정합니다. | 전 세계 영업 |
코드
표시명을 활성화하는 인스턴스의 API v30 이상에서만 사용할 수 있습니다. | 아니요 | 레벨의 코드입니다.
인스턴스에 대해 표시명 사용이 설정된 경우 필수입니다. | 전 세계 영업 |
요소의 콘텐츠
| |||
(없음) | |||
응답 형식
<?xml version="1.0" encoding="UTF-8"?> <response success="true"> <messages> <message key="erase-actuals-success">Successfully erased actuals data.</message> <message key="erase-actuals-facts-deleted">4 facts deleted.</message> <message key="erase-actuals-notes-deleted">2 notes deleted.</message> <message key="erase-actuals-splits-deleted">1 splits deleted.</message> </messages> </response>
응답 요소
| |||
태그명
| 응답 | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
성공 | 예 | 둘 중 하나true 또는false - API 호출의 성공 여부를 나타냅니다. 성공한 호출의 경우에도 응답에 경고 메시지가 포함될 수 있습니다. | true |
요소의 콘텐츠
| |||
단일 옵션메시지 요소 | |||
메시지 요소
| |||
태그명
| 메시지 | ||
설명
| 하나 이상의 컨테이너메시지 요소 | ||
요소의 특성
| |||
(없음) | |||
요소의 콘텐츠
| |||
하나 이상메시지 요소 | |||
메시지 요소
| |||
태그명
| 메시지 | ||
설명
| 시스템에서 호출자에게 다시 전송되는 메시지를 나타냅니다. 메시지는 요청이 성공하지 못한 경우의 오류 메시지, 요청이 성공한 경우의 경고 메시지, 성공의 경우 확인 메시지에 사용됩니다. | ||
요소의 특성
| |||
특성명
| 필수
| 값
| 예:
|
키 | 아니요 | 지정된 경우 키는 특정 메시지 또는 메시지 유형을 식별하는 방법이며, 클라이언트 프로그램에서 자동화된 오류 기록 및 복구를 위해 유용합니다. 메시지의 언어가 변경되더라도 다른 요청 로케일에서는 키는 변경되지 않습니다. 또한 향후에는 문구 조정 또는 용어 변경으로 인해 키가 변경되지 않을 것입니다. | warning-invalid-timespan-start |
요소의 콘텐츠
| |||
메시지 텍스트입니다. 이 텍스트는 요청에 지정된 로케일의 언어로 표시됩니다(로케일이 지원된다고 가정). 텍스트에는 처리된 행 수, 오류를 일으킨 특정 열 또는 값과 같은 가변 정보가 포함될 수도 있습니다. | |||