importTransactions
カテゴリ
| データの送信 |
説明
| 新しいトランザクションを挿入する。 |
起動に必要な権限
| インポート |
リクエストに応じてパラメータが必要
| 認証情報、ImportTransactionsOptions、RowData |
この方法は、"トランザクション" へのアクセス権がある場合にのみ適用されます。
トランザクションはインポート中のみ削除できます。インポート中にすべてのトランザクションを削除する場合は、1 つの空白行をインポートし、残りのデータを削除することを検討してください。
このメソッドは、特定の条件に一致する既存のトランザクション行の削除、新しいトランザクション行のシステムへの挿入、または 1 回の呼び出しで両方のアクションを実行する (トランザクション行のセットを別の行のセットに置き換える) ために使用できます。
リクエストのフォーマット
<?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 コールの各呼び出しには、リストされた各タイプの要素を 1 つずつ含める必要があります。
- 認証情報
- importTransactionsOptions
- rowData
ヘッダー内のパイプ文字 (|) の数とデータとが一致しない場合、API v30 以上ではエラーが発生します。
認証情報要素
| |||
タグ名
| 認証情報 | ||
説明
| すべての API 呼び出しに単一の値を含める必要がありますcredentials 要素を使用して、API を呼び出したユーザーを識別する。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しが成功: | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
ログイン | あり | API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。 | sampleuser@company.com |
password | あり | API メソッドを呼び出すユーザーのパスワード。 | my_password |
ロケール | なし | 入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。 | fr_FR |
instanceCode | なし | 認証情報で指定されたユーザーが の複数のインスタンスにアクセスできる場合、 Adaptive Planning 、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。 | MYINSTANCE1 |
エレメントの内容
| |||
(なし) | |||
importTransactionsOptions
element
| |||
タグ名
| importTransactionsOptions | ||
説明
| インポートの実行時に使用するオプションを指定します。以下のうち 1 つ以上の場合deleteStartDatedeleteEndDate、またはtransactionTypes が指定されている場合、このメソッド呼び出しは、指定された条件に一致する既存のトランザクションの削除を試みます。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
deleteStartDate | なし | このメソッド呼び出しの目的が、既存のトランザクションの削除を目的としている場合、この属性は削除するトランザクション セットの開始日を指定します (含む)。指定しない場合、日付が指定日以前のすべての取引が使用されます。deleteEndDate (指定されたオプションのいずれかに一致TransactionTypes) は削除されます。 | 11/01/2012 |
deleteEndDate | なし | このメソッド呼び出しの目的が、既存のトランザクションの削除を目的としている場合、この属性は削除するトランザクション セットの終了日を指定します (含む)。指定しない場合は、日付が指定日以降のすべての取引が使用されます。deleteStartDate (指定したオプションのいずれかに一致TransactionTypes) は削除されます。 | 12/31/2012 |
transactionTypes | なし | パイプ記号で区切られた、削除されるトランザクション タイプのセット。指定しない場合、次の間に指定されたすべての取引が指定されます。deleteStartDatedeleteEndDate は削除されます。いいえの場合deleteStartDate またはdeleteEndDate が指定されている場合、指定されたタイプのすべてのトランザクションは、日付に関係なく削除されます。 | 発注書 |
allowParallel | あり | オンにした場合True の場合、このインスタンスに対してすでに別の実績またはトランザクションのインポートが処理されていても、インポートが続行されます。オンにした場合false の場合、このインスタンスに対して処理中の実績またはトランザクションのインポートがすでに存在する場合、インポートは失敗します。 | false |
useMappings | なし | 行要素内で科目、計画、属性値のインポート マッピングを使用するかどうかを指定します。検討済デフォルトでは true。条件false の場合、使用すべき内部識別子: 科目はコードで識別され、組織と属性値は名前で識別されます。 | false |
includeContext | なし | メッセージにコンテキスト ブロックを含めることができるかどうかを指定します。値のタイプfalse (コンテキストを表示しない) またはtrue (該当する場合はコンテキストを表示)。指定しない場合、真であると想定されます。 | false |
displayNameEnabled
表示名が有効になっているインスタンスの API v31+ でのみ使用できます。 | なし | displayNameEnabled=true は、インスタンスに対して "表示名の有効化" 設定がオンになっている場合、API がペイロードの科目コード、組織コード、属性コード、属性名列を想定する必要があることを示します。 displayNameEnabled=false は、インスタンスの "表示名の有効化" 設定がオンになっている場合でも、API は 30 日前の API 契約に従う必要があることを示します。 displayNameEnabled のデフォルト値は "false" です。 | false |
エレメントの内容
| |||
(なし) | |||
rowData element
| |||
タグ名
| rowData | ||
説明
| インポートするデータの行のコンテナです。 | ||
要素の特性
| |||
(なし) | |||
エレメントの内容
| |||
正確に 1ヘッダー要素 - 正確に 1 つ行要素 | |||
ヘッダー要素
| |||
タグ名
| ヘッダー | ||
説明
| 対応するデータの列の名前と順序を指定します行要素 | ||
要素の特性
| |||
(なし) | |||
エレメントの内容
| |||
縦棒で列名が区切られたテキスト行。これらの列名は、シートの属性もしくはフィールドの名前、あるいはデータを含む月に対応している必要があります。これらは、データのインポート先のシートのインポート テンプレートにある列名と同じで、各列ヘッダーは縦の棒またはパイプの記号で隣の列と区切られます。
表示名を有効にするインスタンスの場合、ヘッダーでは次の操作がサポートされません。 "<dimension>" 次の値との組み合わせ "<dimension> Name" または "<dimension> Code" Adaptive Planning でサポートされているロケールの API v30 以上。 | |||
行要素
| |||
タグ名
| 行 | ||
説明
| 1 つ以上のコンテナ行要素 | ||
要素の特性
| |||
(なし) | |||
エレメントの内容
| |||
1 つ以上行要素 | |||
行要素
| |||
タグ名
| 行 | ||
説明
| インポート中の単一行のデータ | ||
要素の特性
| |||
(なし) | |||
エレメントの内容
| |||
インポートされている単一行のフィールドのデータ。各フィールドの値は、縦棒またはパイプ記号で区切られます。データ フィールドは、ヘッダー要素の行と同じ順序である必要があります。値の数字が千単位の区切り文字を使用している場合、それらはリクエストの認証情報で指定されたロケールで使用されているカンマ区切り文字であると想定されます。 | |||
回答フォーマット
これらは、トランザクション データのインポートが成功した場合または失敗した場合の応答の例です。
成功例
<?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>
回答エレメント
| |||
タグ名
| response | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
成功 | あり | 両方真またはfalse。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。 | true |
エレメントの内容
| |||
単一 (任意)メッセージ要素 | |||
メッセージ要素
| |||
タグ名
| メッセージ | ||
説明
| 1 つ以上のコンテナメッセージ要素 | ||
要素の特性
| |||
(なし) | |||
エレメントの内容
| |||
1 つ以上メッセージ要素 | |||
メッセージ要素
| |||
タグ名
| message | ||
説明
| システムから呼び出し元に送り返されるメッセージを表します。メッセージは、リクエストが成功しない場合のエラー メッセージ、リクエストが成功した場合の警告メッセージ、成功した場合の確認メッセージに使用されます。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
キー | なし | キーを入力すると、特定のメッセージやメッセージのタイプを識別することができ、クライアント プログラムにおけるエラーの記録と復旧の自動化に役立ちます。メッセージの言語が変わってもキーはリクエストのロケールの中で変更されません。また、単語の調整や用語の変更によってキーが将来変更される可能性も低いです。 | invalid-attributevalueid |
エレメントの内容
| |||
| |||
コンテキスト要素
| |||
タグ名
| context | ||
説明
| 1 つ以上の列要素のコンテナです。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
なし | |||
エレメントの内容
| |||
1 つ以上の列要素 | |||
列要素
| |||
タグ名
| col | ||
説明
| メッセージのコンテキストを示します。ヘッダーと値のペアを指定して、メッセージを生成している行を識別できるようにします。 | ||
要素の特性
| |||
特性名
| 必須？
| 値
| 例
|
ヘッダー | あり | 列のヘッダー。 | "Account" |
値 | あり | 列の値。 | "GL-29482-38233" |
エレメントの内容
| |||
(なし) | |||