exportTransactionDefinition

カテゴリ	Metadata retrieval
説明	インスタンス内のトランザクションの定義 (使用可能な列) を返します。
起動に必要な権限	IMP (データのインポート) または manage_tx (トランザクションフィールド定義の管理)
リクエストに応じてパラメータが必要	認証情報

このメソッドのリクエストには、呼び出し元のユーザーを識別して認証するための認証情報タグのみが含まれています。検証されると、このメソッドはインスタンス内のトランザクションの定義を記述した XML ドキュメントを返します。

リクエストのフォーマット


<?xml version="1.0" encoding="UTF-8"?>
<call method="exportTransactionDefinition" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</call>

認証情報要素
タグ名		認証情報
説明		すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、この API を利用してアクションを実行するために必要な権限がユーザーに与えられている必要があります。を呼び出してください。
要素の特性
特性名	必須？	値	例
ログイン	あり
password	あり	API メソッドを呼び出すユーザーのパスワード。	my_password
ロケール	なし	入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステムメッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。	fr_FR
instanceCode	なし	認証情報で指定されたユーザーがの複数のインスタンスにアクセスできる場合、 Adaptive Planning 、この属性は、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定するのに使用できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンスコードを決定するには、exportInstances API を使用します。	MYINSTANCE1
エレメントの内容
(なし)

回答フォーマット


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
<output>
   <transaction>
     <fields>
       <posting-date name="Posting Date"/>
       <type name="Transaction Type">
         <value id="178" name="Journal Entry"/>
         <value id="179" name="Purchase Order"/>
         <value id="177" name="Invoice"/>
         <value id="180" name="Transaction"/>
       </type>
       <accounts name="Account"/>
       <levels name="Plan"/>
       <dimension id="4" name="Product">
         <value id="48" name="B-2"/>
         <value id="47" name="B-1"/>
         <value id="14" name="A"/>
         <value id="15" name="B-Ste"/>
       </dimension>
       <text-selector id="4" name="Flavor">
         <value id="123" name="Chocolate"/>
         <value id="122" name="Vanilla"/>
       </text-selector>
       <text name="Description"/>
       <number name="Sales Tax"/>
       <date name="Due Date"/>
       <amount name="Transaction Amount"/>
     </fields>
   </transaction>
</output>
</response>

トランザクションの各フィールドは、次のいずれかの要素によって定義されます。

posting-date (1)

type (1)

科目 (1)

組織 (1)

属性 (0 以上)

テキストセレクター (0 以上)

テキスト (ゼロ以上)

数値 (ゼロ以上)

日付 (ゼロ以上)

金額 (1)

トランザクション要素
タグ名		トランザクション
要素の特性
特性名	必須？	値	例
(なし)
エレメントの内容
1 つのフィールド要素

フィールド要素
タグ名		フィールド
説明		すべての必須フィールドと任意のフィールドのコンテナです。
要素の特性
特性名	必須？	値	例
(なし)
エレメントの内容
それぞれのトランザクションに必要なフィールドごとに 1 つの要素を入力します。

posting-date 要素
タグ名		posting-date
説明		取引が計上された必須の日付。
要素の特性
特性名	必須？	値	例
名前	あり	このフィールドの印刷ヘッダー	転記日
エレメントの内容
(なし)

タイプ要素
タグ名		type
説明		必須の取引タイプ
要素の特性
特性名	必須？	値	例
名前	あり	このフィールドの印刷ヘッダー	トランザクションのタイプ
エレメントの内容
1 つ以上の値要素

科目要素
タグ名		科目
説明		このトランザクションが属する科目。階層構造を含む科目メタデータは、exportAccounts を呼び出すことによって取得できます。
要素の特性
特性名	必須？	値	例
名前	あり	このフィールドの印刷ヘッダー	Account
エレメントの内容
(なし)

組織要素
タグ名		組織
説明		このトランザクションが属する組織。階層構造を含む組織のメタデータは、exportLevels を呼び出すことによって取得できます。
要素の特性
特性名	必須？	値	例
名前	あり	このフィールドの印刷ヘッダー	level
エレメントの内容
(なし)

属性要素
タグ名		属性
説明		トランザクションに割り当てることができる属性です。階層構造を含む完全な属性メタデータは、exportDimensions を個別に呼び出すことで取得できます。
要素の特性
特性名	必須？	値	例
ID	あり	属性の内部の数値識別子。	42
名前	あり	このフィールドの印刷ヘッダー	製品
エレメントの内容
1 つ以上の値要素

text-Selector 要素
タグ名		text-selector
説明		取引にタグ付けするために定義された値のカスタムリスト。
要素の特性
特性名	必須？	値	例
ID	あり	テキストセレクターの内部の数値識別子。	42
名前	あり	このフィールドの印刷ヘッダー	フレーバー
エレメントの内容
1 つ以上の値要素

値要素
タグ名		値
説明		エンクローズのタイプ、属性、またはテキストセレクターに定義された値の 1 つ。
要素の特性
特性名	必須？	値	例
ID	あり	値の内部の数値識別子。	42
名前	あり	値の印刷版。	インボイス
エレメントの内容
(なし)

テキスト要素
タグ名		text
説明		取引に対応する一般的なテキスト。
要素の特性
特性名	必須？	値	例
名前	あり	このフィールドの印刷ヘッダー	説明
エレメントの内容
(なし)

数字要素
タグ名		数値
説明		取引に割り当てられる汎用の番号。
要素の特性
特性名	必須？	値	例
名前	あり	このフィールドの印刷されたヘッダー	売上税
エレメントの内容
(なし)

日付要素
タグ名		date
説明		取引に割り当てられる一般的な日付。
要素の特性
特性名	必須？	値	例
名前	あり	このフィールドの印刷ヘッダー	期日
エレメントの内容
(なし)

金額要素
タグ名		金額
説明		取引に必要な金額。
要素の特性
特性名	必須？	値	例
名前	あり	このフィールドの印刷ヘッダー	トランザクションの金額
エレメントの内容
(なし)