eraseData
在 API v24 + 中受支持。
种类
| 数据提交 |
描述
| 使用适用于层级和账户的可选筛选器，清除账户在指定时段内的计划数据或实际值数据。 |
调用所需的权限
| 清除数据 |
请求时需要的参数
| Credentials, EraseOptions |
针对给定时间段内指定账户集，从计划版本或实际值版本中清除数值。此操作不会清除任何公式（例如共享公式、单元格公式、账户公式）。此操作会删除因清除操作而变空的账户拆分。空拆分是指不包含数据、公式或单元格注释的拆分。如果清除操作会导致拆分中的最后一个数据被删除，则该拆分将被删除。如果拆分在调用此 API 之前为空，则此 API 不会更改拆分。
EraseData 方法提供与 EraseActuals 相同的功能，但还包括清除计划数据的功能，以及对作为目标的特定账户计划组合进行额外控制的功能。与条件匹配的单元格注释也将被删除。
是一项超级用户权限，允许清除整个 Adaptive Planning（包括已锁定层级中的实际值数据或计划数据）。清除数据将重设访问规则和层级所有权限制。您只能从具有数据输入重设功能的计算型账户中删除数据。
此 API 可验证所选账户的时间层级。
清除汇总账户
“清除数据”API 不会清除汇总账户的数据。在请求中单独包含每个账户。
清除层级
如果您在请求中传递父级层级，eraseData API 仅会清除父级层级的数据，而不会清除子级层级的数据。您必须在 API 请求中单独包括每个层级。
申请格式
请求会拒绝无法识别的标记。标记允许不区分大小写的匹配。示例：“账户”元素可接受 <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 调用都必须包含一个凭据元素，用于识别调用 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 | 否 | 在清除计划数据时为必填项。指定要从中清除数据的计划版本的名称。 不会清除任何公式（例如共享公式、单元格公式、账户公式）。 | 复制 2013 年预算 |
accountType | 是 | 指定账户类型是否为总分类账（“GL"), custom ("CUSTOM"）或多维工作表（"多维数据集”）。 | 总分类账 |
cubeSheetName | 否 | 在以下情况下为必填项accountType="CUBE"指定多维工作表的名称。 | 销售多维 |
开始 | 是 | 指定时间范围的开始时段的代码。该代码必须引用账户时间层级中的时段。 如果您指定多维工作表，则代码必须引用多维工作表的时间层级中的时段。 如果您指定总分类账账户类型或自定义账户类型，则代码必须引用默认时间层级。
指定的时段必须与账户的时间层级一致。例如，如果账户的时间层级为“从 1 月开始的季度”，则您不能选择从 2 月开始。 | 01/2013 |
结束 | 是 | 指定时间范围的结束时段的代码。该代码必须引用账户时间层级中的时段。 如果您指定多维工作表，则代码必须引用多维工作表的时间层级中的时段。 如果您指定总分类账账户类型或自定义账户类型，则代码必须引用默认时间层级。
指定的时段必须与账户的时间层级一致。例如，如果账户的时间层级为“季度”（从 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 筛选器的一个或多个层级元素的容器。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
元素的内容
| |||
一个或多个层级元素 | |||
账户元素
| |||
标记名称
| Account | ||
描述
| 要从中清除数据的账户，由账户代码指定。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
代码 | 是 | 为要清除的数据的账户指定账户代码。 | 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>
回复元素
| |||
标记名称
| 回复 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
成功 | 是 | 两者之一正确或false，指示 API 调用是否成功。即使成功调用，响应中也可能包含警告消息。 | 是 |
元素的内容
| |||
单个可选messages 元素 | |||
messages 元素
| |||
标记名称
| 消息 | ||
描述
| 一个或多个容器消息元素。 | ||
元素的属性
| |||
（无） | |||
元素的内容
| |||
一个或多个消息元素。 | |||
消息元素
| |||
标记名称
| 消息 | ||
描述
| 表示从系统发回给调用方的消息。消息用于在请求未成功时显示错误消息，在请求成功时显示警告消息，在成功时显示确认消息。 | ||
元素的属性
| |||
属性名称
| 必填？
| 值
| 示例
|
键 | 否 | 指定密钥后，密钥可用于识别特定消息或消息类型，可用于在客户端程序中自动记录错误并进行恢复。在不同的请求区域设置下，即使消息的语言发生变化，键也不会发生变化。关键字在将来也不太可能因措辞调整或术语变更而发生变化。 | warning-invalid-timespan-start |
元素的内容
| |||
消息的文本。此文本使用请求中指定的区域设置的语言（假设该区域设置受支持）。文本还可能包含可变信息，例如已处理的行数，或者导致错误的特定列或值。 | |||