importTransactions

申请格式


<?xml version='1.0' encoding='UTF-8'?>
<call method="importTransactions" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/>
 <importTransactionsOptions allowParallel="false" useMappings="false"/>
  <rowData>
    <header>Posting Date|Transaction Type|Account|Plan|Transaction Amount</header>
    <rows>
       <row>01/02/2011|Invoice|70110|Marketing|100</row>
    </rows>
  </rowData>
</call>

此 API 的每次调用都必须恰好包含以下每种列出类型的一个元素：

凭据

importTransactionsOptions

rowData

对于 API v30 或更高版本，如果标头中的竖线字符 ( | ) 数量与数据不匹配，将导致出错。

凭据元素
标记名称		凭据
描述		所有 API 调用都必须包含一个凭据元素，用于识别调用 API 的用户。然后，系统会以此用户身份执行 API 调用（系统中的任何审核线索或操作历史记录都将显示此用户执行了该操作），因此，用户必须具有执行该操作所需的权限，才能执行 API 调用。成功。
元素的属性
属性名称	必填？	值	示例
登录	是	调用 API 方法的用户的登录名。此用户必须具有所需的权限才能调用该方法。	sampleuser@company.com
密码	是	调用 API 方法的用户的密码。	my_password
区域设置	否	指定用于解释传入数字和日期的区域设置，以及用于设置传出数字和日期格式的区域设置（使用正确的千位分隔符、月份名称和日期格式）。区域设置还用于指定回复中的任何系统消息应使用的语言。如果未指定，则使用 en_US（美式英语）。	fr_FR
instanceCode	否	如果凭据中指定的用户有权访问多个实例， Adaptive Planning ，此属性可用于指定用户打算访问默认实例以外的实例。如果未指定，则将使用用户的默认实例。要确定可用的实例代码，请使用 exportInstances API。	MYINSTANCE1
元素的内容
（无）

importTransactionsOptions 元素
标记名称		importTransactionsOptions
描述		指定执行导入时要使用的选项。如果至少存在以下一项：deleteStartDate,deleteEndDate，或transactionTypes 已指定，则此方法调用将尝试删除与这些指定条件匹配的任何现有交易。
元素的属性
属性名称	必填？	值	示例
deleteStartDate	否	如果此方法调用旨在删除某些现有交易，则此属性可指定要删除的交易集的开始日期（含该日期和开始日期）。如果未指定，则为日期不晚于deleteEndDate（且与某个可选的指定日期匹配）TransactionTypes) 将被删除。	11/01/2012
deleteEndDate	否	如果此方法调用旨在删除某些现有交易，则此属性可指定要删除的交易集的结束日期（含该日期和结束日期）。如果未指定，则为日期不早于deleteStartDate（并且与某个可选的指定日期匹配）TransactionTypes) 将被删除。	12/31/2012
transactionTypes	否	将要删除的一组交易类型，以竖线符号分隔。如果未指定，则表示介于deleteStartDate 和将删除 deleteEndDate。如果否deleteStartDate 或如果指定了 deleteEndDate，则指定类型的所有交易都将被删除，无论其日期如何。	发票和采购单
allowParallel	是	如果设置为true，则即使此实例已存在另一个正在进行的实际值或交易导入，导入也会继续进行。如果设置为如果此实例已存在正在处理的实际值或交易导入，则将其设置为 false，则导入尝试将失败。	false
useMappings	否	指定是否对行元素内的账户、计划和维度值使用导入映射。已考虑默认为 true。如果如果为 false，则应使用内部编号：账户按代码标识，层级按名称标识，维度值按名称标识。	false
includeContext	否	指定消息是否可以包含上下文块。值为false（从不显示相关信息）或true（如果适用，请显示相关信息）。如果未指定，假设为 true。	false
displayNameEnabled 仅在 API v31+ 中适用于启用了显示名称的实例。	否	displayNameEnabled=true 表示当实例的“启用显示名称”设置为“开启”时，API 应要求负载中包含“账户代码”“层级代码”“维度代码”“维度名称”列。 displayNameEnabled=false 表示即使实例的“启用显示名称”设置为“开启”，API 也应继续遵循 v30 之前版本的 API 合同。 displayNameEnabled 的默认值为“false”。	false
元素的内容
（无）

rowData element
标记名称		rowData
描述		正在导入的数据行的容器。
元素的属性
（无）
元素的内容
刚好 1标头元素，并且恰好是一个rows 元素。

表头元素
标记名称		表头
描述		指定相应数据源中数据列的名称和顺序。rows 元素。
元素的属性
（无）
元素的内容
一行文本，列名称之间用竖线分隔。这些列名称必须与工作表上的维度或字段名称相对应，或者与可包含数据的月份相对应。列名称与要导入数据的工作表的导入模板中的列名称相同，每个列标题与下一个列标题之间用竖线符号或管道符号分隔。对于启用了“显示名称”的实例，标头不支持 "<dimension>" 与 "<dimension> Name" 或 "<dimension> Code" 在 Adaptive Planning 支持的区域设置中使用 API v30 或更高版本。

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

行元素
标记名称		行
描述		正在导入的单个行的数据。
元素的属性
（无）
元素的内容
导入单个行中的字段数据，每个字段的值以竖线或管道符号分隔。数据字段的顺序必须与标头元素中的行顺序相同。如果值中的数字使用千位分隔符，则系统会假定这些分隔符是请求凭据中指定的区域设置中使用的逗号分隔符。

回复格式

以下是交易数据导入成功和失败的响应示例。

成功示例


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <messages>
       <message key="row-imported">1 row was imported.</message>
   </messages>
</response>

失败（有相关信息）


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</message>
       <message key="import-detail">Additional information:</message>
       <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Transaction Type do not exist: Invoice12.</message>
       <message key="invalid-dimension-choice-withCoordinate">
           <context>
               <col header="Posting Date" value="01/02/2011" />
               <col header="Transaction Type" value="Invoice12" />
               <col header="Account" value="70110" />
               <col header="Plan" value="Marketing" />
               <col header="Transaction Amount" value="100.0" />
     
           </context>
     Invalid Dimension Choice: Invoice12 on row 1 column B
   
       </message>
     </messages>
</response>

失败（无相关信息）


<?xml version='1.0' encoding='UTF-8'?>
<response success="false">
   <messages>
       <message key="error-import">Import Failed with the following error: No transactions were imported or deleted during the import.</message>
       <message key="import-detail">Additional information:</message>
       <message key="warning-nonexistent-dimension-value">Warning: No data was imported for rows with the following dimension values because the dimension values for Transaction Type do not exist: Invoice12.</message>
       <message key="invalid-dimension-choice-withCoordinate">Invalid Dimension Choice: Invoice12 on row 1 column B</message>
     </messages>
</response>

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

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

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

相关信息元素
标记名称		context
描述		一个或多个 col 元素的容器。
元素的属性
属性名称	必填？	值	示例
无
元素的内容
一个或多个 col 元素。

col 元素
标记名称		列
描述		表示消息的上下文。提供一个标头/值对，以便识别生成消息的行。
元素的属性
属性名称	必填？	值	示例
表头	是	列的标题。	“账户”
值	是	列中的值。	“GL-29482-38233”
元素的内容
（无）

种类	数据提交
描述	插入新交易。
调用所需的权限	导入
请求时需要的参数	Credentials、ImportTransactionsOptions、RowData