eraseActuals

카테고리	데이터 제출
설명	실제값 버전에서 지정된 기간 및 계정의 숫자 데이터를 지웁니다.
호출에 필요한 권한	데이터 지우기
요청 시 필수 매개변수	자격증명, 지우기 옵션

이 방법을 사용하면 지정된 기간 동안 지정된 계정 세트의 모든 레벨에 대한 실제값 버전에서 숫자 값이 지워집니다. 수식(예: 공유 수식, 셀 수식, 계정 수식)은 지워지지 않습니다. 실제값 지우기 프로세스의 결과로 비어 있는 계정 분할이 삭제됩니다. 빈 분할은 데이터, 수식 또는 셀 메모가 포함되지 않은 분할입니다. 실제값을 지운 결과 분할에서 마지막 데이터가 삭제되면 해당 분할이 삭제됩니다. 이 API는 API를 호출하기 전에 분할이 비어 있는 경우 분할을 그대로 유지합니다.

요청 형식

기본 실제값 버전의 모든 레벨에 대한 모든 총계정원장 계정에서 시작과 종료 사이의 기간에 대한 숫자 값과 새로 비어 있는 분할을 지우려면 다음을 수행합니다.


 <?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
     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>

자격증명 요소
태그명		자격증명
설명		모든 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	아니요	실제값 버전이 두 개 이상인 경우 필수입니다. 이 인스턴스에 계획 제품만 포함된 경우EraseActuals는 유일한 실제값 버전에서 데이터를 지웁니다.	실제값
accountType	예	계정 유형이 총계정원장("GL"), 커스텀("CUSTOM") 또는 큐브 시트("큐브")입니다.	GL
cubeSheetName	아니요	필수accountType="큐브"입니다. 큐브 시트의 이름을 지정합니다.	영업 큐브
시작	예	실제값 시간 범위의 시작 기간 코드를 지정합니다. 코드는 계정의 시간 단위에서 기간을 참조해야 합니다. 큐브 시트를 지정하는 경우 코드는 큐브 시트의 시간 단위에서 기간을 참조해야 합니다. GL 또는 커스텀 계정 유형을 지정하는 경우 코드는 기본 시간 단위를 참조해야 합니다. API v15+의 경우 지정된 기간이 계정의 시간 단위와 일치해야 합니다. 예를 들어, 계정의 시간 단위가 1월에 시작하는 분기인 경우 2월을 시작으로 선택할 수 없습니다.	01/2013
종료	예	실제값 시간 범위의 종료 기간 코드를 지정합니다. 코드는 계정의 시간 단위에서 기간을 참조해야 합니다. 큐브 시트를 지정하는 경우 코드는 큐브 시트의 시간 단위에서 기간을 참조해야 합니다. GL 또는 커스텀 계정 유형을 지정하는 경우 코드는 기본 시간 단위를 참조해야 합니다. API v15+의 경우 지정된 기간이 계정의 시간 단위와 일치해야 합니다. 예를 들어, 계정의 시간 단위가 1월에 시작하는 분기인 경우 2월을 종료일로 선택할 수 없습니다.	03/2013
includeCellNotes	예	'로 설정된 경우true"인 경우EraseActuals는 셀의 데이터도 지우는지 여부와 관계없이 선택한 버전, 계정 유형 및 시간 범위의 모든 셀 메모를 지웁니다. 'false"이면 셀 메모가 삭제되지 않습니다.	true
요소의 콘텐츠
(없음)

응답 형식


 <?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
요소의 콘텐츠
메시지 텍스트입니다. 이 텍스트는 요청에 지정된 로케일의 언어로 표시됩니다(로케일이 지원된다고 가정). 텍스트에는 처리된 행 수, 오류를 일으킨 특정 열 또는 값과 같은 가변 정보가 포함될 수도 있습니다.