eraseActuals

种类	数据提交
描述	清除实际值版本的指定时段和账户中的数值数据。
调用所需的权限	清除数据
请求时需要的参数	Credentials, EraseOptions

对于给定时间段内指定账户集的所有层级，此方法将从实际值版本中清除数值。此操作不会清除任何公式（例如共享公式、单元格公式、账户公式）。此操作将删除因清除实际值流程而变空的账户拆分。空拆分是指不包含数据、公式或单元格注释的拆分。如果清除实际值会导致拆分中的最后一个数据被删除，则该拆分将被删除。如果拆分在调用此 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 调用都必须包含一个凭据元素，用于识别调用 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 ("CUSTOM"）或多维工作表（"多维数据集”）。	总分类账
cubeSheetName	否	在以下情况下为必填项accountType="CUBE"指定多维工作表的名称。	销售多维
开始	是	指定实际值时间范围的开始时段的代码。该代码必须引用账户时间层级中的时段。如果您指定多维工作表，则代码必须引用多维工作表的时间层级中的时段。如果您指定总分类账账户类型或自定义账户类型，则代码必须引用默认时间层级。对于 API v15+，指定的时段必须与账户的时间层级一致。例如，如果账户的时间层级为“从 1 月开始的季度”，则您不能选择从 2 月开始。	01/2013
结束	是	指定实际值时间范围的结束时段的代码。该代码必须引用账户时间层级中的时段。如果您指定多维工作表，则代码必须引用多维工作表的时间层级中的时段。如果您指定总分类账账户类型或自定义账户类型，则代码必须引用默认时间层级。对于 API v15+，指定的时段必须与账户的时间层级一致。例如，如果账户的时间层级为“季度”（从 1 月开始），则您不能选择 2 月作为结束时间。	03/2013
includeCellNotes	是	如果设置为“true"，则无论是否同时清除单元格中的数据，“清除实际值”都将清除所选版本、账户类型和时间范围内的所有单元格注释。如果“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>

回复元素
标记名称		回复
元素的属性
属性名称	必填？	值	示例
成功	是	两者之一正确或false，指示 API 调用是否成功。即使成功调用，响应中也可能包含警告消息。	是
元素的内容
单个可选messages 元素

messages 元素
标记名称		消息
描述		一个或多个容器消息元素。
元素的属性
（无）
元素的内容
一个或多个消息元素。

消息元素
标记名称		消息
描述		表示从系统发回给调用方的消息。消息用于在请求未成功时显示错误消息，在请求成功时显示警告消息，在成功时显示确认消息。
元素的属性
属性名称	必填？	值	示例
键	否	指定密钥后，密钥可用于识别特定消息或消息类型，可用于在客户端程序中自动记录错误并进行恢复。在不同的请求区域设置下，即使消息的语言发生变化，键也不会发生变化。关键字在将来也不太可能因措辞调整或术语变更而发生变化。	warning-invalid-timespan-start
元素的内容
消息的文本。此文本使用请求中指定的区域设置的语言（假设该区域设置受支持）。文本还可能包含可变信息，例如已处理的行数，或者导致错误的特定列或值。