exportData
カテゴリ | データ取得 |
説明 | リクエスト インスタンス内のリクエストされたバージョンからデータ セットを返します。 |
起動に必要な権限 | なし (インスタンスに対して有効な認証情報である必要があります) |
リクエストに応じてパラメータが必要 | 認証情報、バージョン、フォーマット、フィルタ |
このメソッドのリクエストには、指定されたバージョンのデータを検索し、リクエストされたフィルタおよびフォーマットに一致する値を返すために使用されるパラメータが含まれています。これは Adaptive Planning からデータを取得するために使用される基本的な方法であり、標準科目、GL 科目、モデル科目、キューブ科目、カスタム科目、メトリック科目、前提条件、為替レートを含むあらゆる科目から値を取得するために使用できます。
計画バージョンをエクスポートする場合、エクスポートには実績のオーバーレイ期間の実績データが含まれます。シートの UI と同様に、実績または計画データが表示されます。
エクスポート時に個々の分割の値を集計
exportData.
API v16 以降の場合は、以下のようになります。
exportData
仮想バージョンのデータもエクスポートします。参照 customReportValuesは、より対象を絞ったデータ取得のアプローチに使用します。
参照 参考: exportData パフォーマンス 2024R1 でリリースされた API v39 のパフォーマンスと拡張性の改善をリクエストで活用する方法について。
リクエストのフォーマット
<?xml version='1.0' encoding='UTF-8'?> <call method="exportData" callerName="a string that identifies your client application" stream="true"> <credentials login="sampleuser@company.com" password="my_pwd" instanceCode="INSTANCE1"/> <version name="Budget 2014" isDefault="false"/> <format useInternalCodes="true" includeUnmappedItems="false" /> <filters> <accounts> <account code="A100" isAssumption="true" includeDescendants="false"/> <account code="L100" isAssumption="false" includeDescendants="true"/> </accounts> <levels> <level name="Development" isRollup="true" includeDescendants="true"/> <level name="QA" isRollup="false" includeDescendants="false"/> </levels> <dimensionValues> <dimensionValue dimName="Customer" name="A Corp" directChildren="true"/> <dimensionValue dimName="Region" name="" uncategorized="true" directChildren="false"/> </dimensionValues> <timeSpan start="11/2013" end="12/2014"/> </filters> <dimensions> <dimension name="Product"/> <dimension name="CountryRegion"/> </dimensions> <rules includeZeroRows="false" includeRollups="false" markInvalidValues="false" markBlanks="false" timeRollups="single"> <currency useCorporate="false" useLocal="false" override="AUD"/> </rules> </call>
この API コールの各呼び出しには、リストされた各タイプの要素を 1 つずつ含める必要があります。
- 呼び出す
- 認証情報
- バージョン
- フォーマット
リクエストには次の要素のいずれかを含めることができます。
- フィルタ
- 科目 > 科目
- > 組織
- dimensionValues > dimensionValue
- timeSpan
- 属性 > 属性
- ルール > 通貨
要素の呼び出し | |||
タグ名 | 呼び出す | ||
説明 | そのメソッド属性を使用して呼び出されている API メソッドを示します。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
方法 | あり | 呼び出されるメソッド。 | exportData |
callerName | あり | クライアント アプリケーションを識別する文字列。 | "Adaptive Planning クライアント アプリケーションの例" |
stream
API v39 以上で使用可能 | なし | 処理されるとすぐに、exportData がクライアントへのデータのストリーミングを開始できるようにします。デフォルトでは、false に設定されています。exportData でストリーミングを有効化するには、応答形式を変更する必要があることに注意してください。 | true |
エレメントの内容 | |||
次のタイプごとに 1 つの要素を正確に入力します。
| |||
認証情報要素 | |||
タグ名 | 認証情報 | ||
説明 | すべての API 呼び出しには、API を呼び出したユーザーを識別するための単一の認証情報要素が含まれている必要があります。その後、この API 呼び出しはこのユーザーとして実行されます (システムの監査証跡やアクション履歴は、このユーザーがアクションを実行したことを示します)。そのため、API 呼び出しを成功させるためには、アクションを実行するために必要な権限がユーザーに与えられている必要があります..
Planning UI の "エクスポート機能" 権限は、exportData には影響しません。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
ログイン | あり | API メソッドを呼び出すユーザーのログイン名。このユーザーは、メソッドを呼び出すために必要な権限を持っている必要があります。 | sampleuser@company.com |
以下 | あり | API メソッドを呼び出すユーザーのパスワード。 | my_password |
ロケール | なし | 入力される数値と日付の解釈、および出力する数値と日付の形式設定 (適切な千単位の区切り文字、月名、日付の形式設定を使用) に使用されるロケールを指定します。ロケールは、応答内のシステム メッセージを表示する言語を指定するためにも使用されます。指定しない場合は、en_US (米国英語) が使用されます。 | fr_FR |
instanceCode | なし | 認証情報で指定されたユーザーが Adaptive Planning の複数のインスタンスにアクセスできる場合、この属性を使用して、ユーザーがデフォルトのインスタンス以外のインスタンスにアクセスしようとしていることを指定できます。指定しない場合、ユーザーのデフォルトのインスタンスが使用されます。使用可能なインスタンス コードを決定するには、exportInstances API を使用します。 | MYINSTANCE1 |
エレメントの内容 | |||
(なし) | |||
バージョン要素 | |||
タグ名 | バージョン | ||
説明 | リクエストされたデータの取得に使用するバージョンを示します。呼び出しごとにバージョンを指定する必要があります。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
名前 | なし | データの受信に使用されるバージョンの名前。1 つの API コールでアクセスできるバージョンは 1 つだけです。名前が指定されていない場合は、この要素の isDefault フラグを true に設定する必要があります。 | 2014 年予算 |
isDefault | なし | 呼び出し元が名前に関係なく、インスタンスの現在のデフォルト バージョンにアクセスしたい場合、この特性は true に設定できます。その場合、タグの name 特性 (存在する場合) は無視されます。そうしないと、この値が false の場合、またはこの特性が存在しない場合、この呼び出しを成功させるためには、指定された名前のバージョンが存在し、ユーザーがアクセスできる必要があります。 | false |
エレメントの内容 | |||
(なし) | |||
フォーマット要素 | |||
タグ名 | フォーマット | ||
説明 | 返されるデータの個々のフィールドで使用すべきフォーマットのタイプを示します。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
useInternalCodes | あり | 科目管理および組織管理にそれぞれ入力されたコードを使用して科目コードと組織コードが発行されるようにするには、"true" に設定します。"エクスポート" タブにある "エクスポート科目マッピング" または "エクスポート組織マッピング" を使用して出力データにコードをマッピングするには、"false" に設定します。 | true |
useIds | なし | "true" に設定すると、科目、組織、属性がコードの代わりに ID で表されます。また、「 」セクションの科目、組織、属性を ID で表す必要があります。 リクエストに存在しない場合は、デフォルトで "false" になります。 | true |
includeUnmappedItems | なし | この属性が適用されるのは、useInternalCodes が false で、エクスポート マッピングが使用されている場合のみです。指定されていない場合、"エクスポート" タブに "マッピングのエクスポート" がない項目は出力されません。includeUnmappedItems が "true" に設定されている場合、エクスポート マッピングのない科目または組織は、内部コード (科目管理または組織管理で設定されたもの) をコードとして使用して生成され、マッピングされたアイテムとマッピングされていないアイテムの混合が生成されます。がデータ セット (完全なデータ セット) である場合。このフラグが "false" に設定されていると、アイテムのエクスポート マッピングが指定されていないと、リクエストされたアイテムの一部がエクスポートされない可能性があります。 | false |
includeCodes | なし | このオプションが意味を持つのは、有効な有効化表示名の設定がオンになっている場合のみです。 API 応答に組織のコード列を含めるには、"true" に設定します。 API 応答で組織のコード列を除外するには、"false" に設定します。 デフォルト値は false です。 | false |
includeNames
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | このオプションが意味を持つのは、有効な有効化表示名の設定がオンになっている場合のみです。 API 応答に組織の名前列を含める場合は、"true" に設定します。 API 応答で組織の名前列を除外するには、"false" を設定します。 デフォルト値は false です。 | false |
includeDisplayNames
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | このオプションが意味を持つのは、有効な有効化表示名の設定がオンになっている場合のみです。 API 応答に組織の表示名列を含める場合は、"true" に設定します。 API 応答で組織の表示名列を除外するには、"false" を設定します。 デフォルト値は false です。 | false |
displayNameEnabled
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | displayNameEnabled=true は、インスタンスに対して "表示名の有効化" がオンになっている場合、組織と属性のエンティティを指定するために、exportData API がリクエストの code 特性を必須とすることを示します。 displayNameEnabled=false は、インスタンスの "表示名の有効化" 設定がオンになっている場合でも、exportData API が v30 前の API 契約に引き続き従うことを示します。code 特性の代わりに name 特性が使用されます。
各組織と属性について、名前とコード特性値が一致している必要があります。 displayNameEnabled のデフォルト値は "false" です。 | false |
エレメントの内容 | |||
(なし) | |||
フィルタ要素 | |
タグ名 | フィルタ |
説明 | リクエストされたバージョンのどのデータを API で取得するかを決定するフィルタの仕様を保持します。この要素は、取得する科目、組織、月、および属性値を指定します。 |
要素の特性 | |
(なし) | |
エレメントの内容 | |
単一の必須の科目要素、単一の任意の組織要素、必須の単一の timeSpan 要素、および任意の単一の dimensionValues 要素。 | |
科目要素 | |
タグ名 | 科目 |
説明 | 1 つ以上の科目要素のコンテナです。 |
要素の特性 | |
(なし) | |
エレメントの内容 | |
1 つ以上の科目要素 | |
科目要素 | |||
タグ名 | account | ||
説明 | exportData API コールでデータをエクスポートする科目を指定します。複数の科目要素が科目要素内に配置されている場合、いずれかの科目要素に一致するすべての科目がエクスポートされます。特定の科目要素の結果が一致する科目がない場合、その要素は無視されますが、他の要素は引き続き適用されます。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
コード | あり | エクスポートする科目のコード。このコードは "科目の管理" で指定されます。 | Current_Assets |
isAssumption | あり | コードが前提条件科目または非前提条件科目を指定しているかどうかを示します。前提条件と科目の両方に単一のコードを使用できます。このフラグを使用して科目のタイプを示します。 | false |
includeDescendants | あり | エクスポートに指定した科目のすべての子孫を含めるかどうかを示します。true に設定した場合、この科目のすべての子 (その子など) がエクスポートされます。false に設定した場合、この科目は単一の合計科目値としてエクスポートされます。 | true |
エレメントの内容 | |||
(なし) | |||
組織要素 | |
タグ名 | 組織 |
説明 | 1 つ以上の組織要素のコンテナです。 |
要素の特性 | |
(なし) | |
エレメントの内容 | |
1 つ以上の組織要素アクセスできない組織がリクエストに含まれている場合、組織要素は 1 つしかなくなりません。これは組織の最上位組織を表します。 | |
組織要素 | |||
タグ名 | level | ||
説明 | exportData API コールでデータをエクスポートする組織を指定します。複数の組織要素が組織要素内に配置されている場合、指定した組織はすべてエクスポートされます。特定の組織要素がインスタンス内に一致する組織がない場合、その要素は無視されますが、他の要素は引き続き適用されます。
次のすべての条件を満たす場合、名前ではなくコードでフィルタする必要があります。
| ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
コード
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | あり "コード" は常に "名前" と相互排他的です。これらの条件が両方とも当てはまる場合、コードのみを使用する必要があります。
| エクスポートする組織のコード。このコードは "Organization Administration" で指定されます。
"コード" は、有効な有効表示名の設定がオンの場合にのみサポートされます。 | 開発 |
名前 | あり 名前は常にコードと相互排他的です。format 要素で displayNameEnabled="false" にした場合は、name のみを使用します。指定されていない場合は、これがデフォルトになります。 | エクスポートする組織の名前。この名称は、"組織の管理" で指定されたものです。
名前は、有効な表示名の設定がオフになっている場合にのみ、v30 以前の API リクエストでサポートされます。 API はコード特性をリクエストに含まれる名前文字列と照合することによって組織を取得するため、名前特性は機能的には code 特性として扱われます。組織を名前で正常に取得するには、組織の名前とコード特性が一致している必要があります。 | 開発 |
isRollup | あり | この組織に子がある場合、isRollup="true" はその組織の合計値 (すべての子の値を含む) を出力し、isRollup="false" はその組織の未分類値 (編集で入力された値) のみを出力します。その組織のデータ)この組織に子がない場合は、isRollup を false に設定する (またはタグ全体を省略する) 必要があります。 | false |
includeDescendants | あり | エクスポートに指定した組織のすべての子孫を含めるかどうかを示します。true に設定した場合、この組織のすべての子もエクスポートされます。同様に、その子もエクスポートされます。false に設定した場合、この組織は単独でエクスポートされます。これは isRollup とは異なることに注意してください。isRollup はこの組織で出力される値に影響します。一方、"子孫を含む" は、子孫もエクスポートに含める必要があるかどうかを示します。isRollup と includeDescendants の両方が true に設定されており、組織が親組織である場合、出力にはこの組織と各子孫における合計組織と非合計組織 (未分類) の両方の値が含まれます。 | true |
エレメントの内容 | |||
(なし) | |||
期間要素 | |||
タグ名 | timeSpan | ||
説明 | 応答で返される期間を示します。指定された範囲 (以下を含む) の期間は、データの個別の列として出力に含まれます。集計またはロールアップされていない。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
start | あり | データがエクスポートされる期間の範囲内の最初の期間のコード。開始期間は最下位期間でなければなりません。 | 2015/01 |
終了 | あり | データがエクスポートされる期間の範囲内の最後の期間のコード。終了期間は最下位期間である必要があります。 | 03/2015 |
stratum | なし | エクスポートされたデータの時間層のコード。指定する場合、開始期間と終了期間がその時間層内に収まっている必要があります。時間層は、リクエストで最上位の時間層を持つ科目と同じかそれ以上である必要があります。次を参照してください。
たとえば、四半期の層を示すには、すべての科目の層が四半期、年、またはそれ以上である必要があります。 | month |
エレメントの内容 | |||
(なし) | |||
dimensionValues element | |
タグ名 | dimensionValues |
説明 | 1 つ以上の dimensionValue 要素のコンテナです。この要素は任意であり、属性値のフィルタリングが必要でない場合は表示されません。 |
要素の特性 | |
(なし) | |
エレメントの内容 | |
1 つ以上の dimensionValue 要素 | |
dimensionValue element | |||
タグ名 | dimensionValue | ||
説明 | 指定された dimensionValue に一致する値のみをエクスポート データに含めることを示します。dimensionValues 要素内の異なる属性からの複数の値は、属性によってグループ化されたものとして機能します。各属性で dimensionValue の少なくとも 1 つが一致する場合、データが返されます。同じ属性内の dimensionValues では、データはどの属性値にも一致します。たとえば、リクエストで属性値として「Region=East」、「Region=West」、「Product=Product_A」が指定されている場合、データは「East」または「West Region」のいずれかに一致する必要がありますが、エクスポートされるには「Product_A Product」とも一致している必要があります。
次のすべての条件を満たす場合、名前ではなくコードでフィルタする必要があります。
| ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
dimName | なし | 属性値が属する属性の名前 (下記の名前特性を参照)。 | 地域 |
コード
表示名を有効にしたインスタンスの API v30 以上でのみ使用できます。 | なし | エクスポートする属性値のコード。code 特性が意味を持つのは、そのインスタンスに対して有効な表示名の設定がオンになっている場合のみです。 | |
名前 | なし | エクスポートする属性値の名前。
名前は、有効な表示名の設定がオフになっている場合にのみ、v30 以前の API リクエストでサポートされます。 | 米国西部 |
directChildren | なし | true に設定すると、API によってこの属性値の直接の子それぞれの合計データがエクスポートされますが、値自体の合計はエクスポートされません。つまり、これによって exportData によって、指定された値から属性ツリーの "1 レベル下" の値がエクスポートされます。指定しない場合は、デフォルトで false になります。 | false |
未分類 | なし | 真に設定した場合、属性値の「未分類」値と一致し、その子孫値 (存在する場合) の値とは一致しません。子のない属性値には影響しません。指定しない場合は、デフォルトで false になります。 | true |
uncategorizedOfDimension | なし | dimName/name 特性の代わりに uncategorizedOfDimension を指定します。
| 15 |
directChildrenOfDimension | なし | dimName/name 特性の代わりに、directChildlenOfDimension を指定します。
| 12 |
ID | なし | dimName/name 特性の代わりに ID を指定してください。
| 14 |
エレメントの内容 | |||
(なし) | |||
属性要素 | |
タグ名 | 属性 |
説明 | 1 つ以上の属性要素のコンテナです。 |
要素の特性 | |
(なし) | |
エレメントの内容 | |
1 つ以上の属性要素 | |
属性要素 | |||
タグ名 | 属性 | ||
説明 | エクスポートされたデータを指定した属性でブレークダウン (スライス) する必要があることを示します。このタグはフィルタ タグの一部ではなく、フィルタリングを制御しません。代わりに、科目と組織の組み合わせごとにエクスポートされる行数を制御します。属性タグで指定された各属性について、既存の値の組み合わせはそれぞれ別の行のデータとしてエクスポートされます。属性要素に含まれる各属性により、その属性名でラベル付けされた追加の列が出力に表示されます。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
名前 | あり | エクスポートをスライスする属性の名前。属性によってスライスすることができないエクスポート内のデータ行は 1 回だけ表示され、この属性の属性値名が表示される列に属性名自体が表示されます。 | 顧客 |
エレメントの内容 | |||
(なし) | |||
ルール要素 | |||
タグ名 | ルール | ||
説明 | 出力される行のタイプと一部のフィールド値がどのように表示されるかを制御する追加の出力ルールを指定します。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
includeZeroRows | なし | "true" に設定すると、ゼロまたは空白のみの場合でも行が除外されます。データのない行を出力から除外するには、"false" に設定します。デフォルト値は false です。 このオプションは、アプリケーション ユーザー インターフェイス内では、属性を含むエクスポートでは使用できません。 API コールでは、属性別にデータをエクスポートするときは True が無視されます。データのある属性値のデータのみが出力されます。 | true |
includeRollups API v24 以前で使用できます。 API v25+ では使用できません。 | なし | 真に設定した場合、子孫の値に加えて、フィルタ タグ内のすべての科目と組織の合計値が含まれます。この特性は、dimensionValue フィルタまたは属性タグで指定されたカスタム属性がどのように機能するかには影響しません。デフォルト値は false です。includeRollups フラグは、科目または組織に明示的なフィルタリングが適用されていない場合にのみ適用されます。フィルタに個々の科目が含まれている場合、含めるには個々の合計科目を指定する必要があります。 | false |
includeRollupAccounts API v25+ で使用できます。 | なし | 真に設定した場合、フィルタ タグ内のすべての科目の合計値が、子孫の値に加えて含まれます。この特性は、dimensionValue フィルタまたは属性タグで指定されたカスタム属性がどのように機能するかには影響しません。デフォルト値は false です。 | false |
includeRollupLevels API v25+ で使用できます。 | なし | 真に設定した場合、フィルタ タグ内のすべての組織の合計値が子孫の値に加えて含まれます。この特性は、dimensionValue フィルタまたは属性タグで指定されたカスタム属性がどのように機能するかには影響しません。デフォルト値は false です。 | false |
markInvalidValues | なし | true に設定した場合、エクスポート時に無効な値に文字 "I" が追加されます。それ以外の場合は、無効な値に "=NA()" を追加して Excel との互換性を持たせます。デフォルト値は false です。 | false |
markBlanks API v24 で更新されました。 | なし | 真に設定した場合、空白値は "B" として出力されます。そうしないと、空白の値はゼロとして出力されます。デフォルト値は false です。 includeZeroRows=false の場合、空白とゼロのみを組み合わせた行は、markBlanks=true であっても応答に出力されません。 | false |
timeRollups | なし | 真、偽、単一の 3 つの値があります。true に設定すると、四半期および年の合計は、エクスポートされた月単位内の適切な位置に表示されます。四半期の合計は四半期の最後の月の直後に表示され、年の合計は最終四半期の四半期合計の直後に表示されます。単一に設定した場合、個々の月、四半期、または年は返されず、期間要素に含まれるすべての月の単一の時間合計のみが返されます。false に設定すると、時間合計列は使用されず、個々の月のみが返されます。デフォルト値は false です。 | false |
エレメントの内容 | |||
任意の通貨要素。エクスポートで使用する通貨を指定します。 | |||
通貨要素 | |||
タグ名 | 通貨 | ||
説明 | 通貨科目の値を出力するときに出力で使用すべき通貨を示します。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
useCorporate | なし | 通貨要素に設定できるのは、3 つの属性のうち 1 つのみです。useCorporate が true に設定されている場合、「社用通貨」 (組織ツリーの最上位にある通貨) を使用する必要があることを示します。デフォルト値は false です。 | false |
useLocal | なし | 通貨要素に設定できるのは、3 つの属性のうち 1 つのみです。useLocal が true に設定されている場合は、通貨値が存在する組織組織の通貨で通貨値を出力する必要があることを示します。出力の各行は組織を示し、その行の通貨値はその組織の通貨になります。デフォルト値は false です。 | false |
上書き | なし | 通貨要素に設定できるのは、3 つの属性のうち 1 つのみです。上書きが存在する場合、インスタンスに対して設定された通貨のいずれかの 3 文字の通貨コードを指定する必要があります。指定すると、エクスポートされるすべての通貨金額がその通貨に換算されます。 | AUD |
エレメントの内容 | |||
(なし) | |||
以下の要素により、(適切な権限を持つ) ユーザーは任意の時間合計のエクスポートをリクエストできます。これらのエレメントには、API v40 以上を使ったリクエストが必要です。
時間要素 | |||
タグ名 | time | ||
説明 | データのエクスポート時に期間をマッピングするために使用するカレンダー XML を含む。これは、 で生成された時間 XML を抽出した形式である必要があります。 exportTimeAPIこのセクションに含まれる期間は、フィルタの期間要素と一致している必要があります。この要素は、任意の合計カレンダーを使用する場合にのみ必要です。
API v40 以降でのみ使用可能です。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
エレメントの内容 | |||
(なし) | |||
層要素 | |||
タグ名 | stratum | ||
説明 | カレンダーの層を表します。
API v40 以降でのみ使用可能です。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
コード | あり | 時間層の一意のユーザー定義識別子。 | 年 |
ID | あり | システムによって生成される時間層の一意の整数識別子。 | 7 |
エレメントの内容 | |||
(なし) | |||
期間要素 | |||
タグ名 | 期間 | ||
説明 | 単一の暦期間を表します。
API v40 以降でのみ使用可能です。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
コード | あり | 期間の一意のユーザー定義の識別子。 | 2004 年第 1 四半期 |
stratumId | あり | 期間が属する層の ID。 | 2 |
timeslot | あり | 期間のタイム スロット。 | 16 |
ID | あり | システムによって生成される期間の一意の整数識別子。 | 16002 |
start | あり | YYYY-MM-DD の形式で指定された期間の開始日 (含む)。 | 2004-01-01 |
終了 | あり | YYYY-MM-DD の形式での、期間の終了日 (除外)。 | 2004-01-01 |
エレメントの内容 | |||
(なし) | |||
任意の時間合計のリクエストの例を
次に示します。
<call method="exportData" callerName="test caller api name"> <credentials login="admin@example.com" password="password" locale="en_US" instanceCode="EXAMPLEINST" /> <version name="Budget 2004" isDefault="true" /> <format useInternalCodes="true" includeUnmappedItems="false" useIds="false" /> <rules includeZeroRows="false" includeRollupAccounts="true" includeRollupLevels="false" markInvalidValues="false" markBlanks="false" timeRollups="false"> <currency useCorporate="false" useLocal="true" /> </rules> <filters> <accounts> <account code="70310" isAssumption="false" includeDescendants="true" /> </accounts> <timeSpan start="01/1999" end="06/1999" /> </filters> <time isCustom="1"> <stratum code="month" label="Month" shortName="Month" id="1" /> <period code="01/1999" label="Jan-1999" shortName="Jan" stratumId="1" id="-12001" start="1999-01-01" end="1999-02-01" /> <period code="02/1999" label="Feb-1999" shortName="Feb" stratumId="1" id="-11001" start="1999-02-01" end="1999-03-01" /> <period code="03/1999" label="Mar-1999" shortName="Mar" stratumId="1" id="-10001" start="1999-03-01" end="1999-04-01" /> <period code="04/1999" label="Apr-1999" shortName="Apr" stratumId="1" id="-9001" start="1999-04-01" end="1999-05-01" /> <period code="05/1999" label="May-1999" shortName="May" stratumId="1" id="-8001" start="1999-05-01" end="1999-06-02" /> <period code="06/1999" label="Jun-1999" shortName="Jun" stratumId="1" id="-7001" start="1999-06-01" end="1999-07-01" /> </time> </call>
回答フォーマット
非ストリーミングの応答フォーマット
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <messages> <message key="warning-invalid-timespan-start">Ignoring start of timespan, which precedes start of version; timsepan start: Nov-2009, version start date: Jan-2014</message> </messages> <output><![CDATA[ Account Name,Account Code,Level Name,[01/2014,02/2014,03/2014,04/2014,05/2014,06/2014,07/2014,08/2014,09/2014,10/2014,11/2014,12/2014] "Benefits",30120,"Engineering (Rollup)",10653.75,10653.75,10653.75,11506.05,11506.05,11506.05,11506.05,11506.05,11506.05,10462.05,10426.05,10426.05 "Furniture",70310,"Engineering (Rollup)",1740.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0,2610.0 ... ]]> </output> </response>
ストリーミング用の応答フォーマット
<?xml version="1.0" encoding="UTF-8"?> <response> <output> <![CDATA[Account Name,Account Code,Level Name,Q1-2004,Q2-2004,Q3-2004,Q4-2004,Q1-2005,Q2-2005 "Current Assets","Current_Assets","Engineering",33.0,33.0,33.0,33.0,33.0,33.0 "Other Assets","Other_Assets","Engineering",41.0,41.0,41.0,41.0,41.0,41.0]]> </output> <messages> <message>Exporting data failed. Retry the export. Contact Support if the export continues to fail. </message> </messages> <status success="false" rowCountSent="2"/> </response>
ストリーミング リクエストと非ストリーミング リクエストでは、応答の構造が変更されていることに注意してください。たとえば、メッセージ要素とステータスは出力後に発生します。
回答エレメント | |||
タグ名 | 回答 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
成功 | あり | 真偽のいずれか。API 呼び出しが成功したかどうかを示します。呼び出しが成功した場合でも、応答に警告メッセージが含まれる場合があります。 | true |
廃止 | なし | レスポンス タグに存在し、true に設定されている場合、この属性は呼び出しているメソッドまたは API のバージョンが廃止されており、正式に廃止されたことを示します。現時点では機能し続けていますが、まもなく機能が停止する可能性があります。通常、この属性は存在しません。 | false |
エレメントの内容 | |||
単一の任意のメッセージ要素と、厳密に 1 つの必須の出力要素。 | |||
メッセージ要素 | |
タグ名 | メッセージ |
説明 | 1 つ以上のメッセージ要素のコンテナです。 |
要素の特性 | |
(なし) | |
エレメントの内容 | |
1 つ以上のメッセージ要素 | |
メッセージ要素 | |||
タグ名 | メッセージ | ||
説明 | システムから呼び出し元に送り返されるメッセージを表します。メッセージは、リクエストが成功しない場合のエラー メッセージ、リクエストが成功した場合の警告メッセージ、成功した場合の確認メッセージに使用されます。 | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
キー | なし | キーを入力すると、特定のメッセージやメッセージのタイプを識別することができ、クライアント プログラムにおけるエラーの記録と復旧の自動化に役立ちます。メッセージの言語が変わってもキーはリクエストのロケールの中で変更されません。また、単語の調整や用語の変更によってキーが将来変更される可能性も低いです。 | invalid-attributevalueid |
エレメントの内容 | |||
メッセージのテキスト。このテキストは、リクエストで指定されたロケールの言語になります (そのロケールがサポートされている場合)。テキストには、処理された行数や、エラーの原因となった特定の列や値などの可変情報を含めることもできます。 | |||
出力要素 | |
タグ名 | output |
説明 | エクスポートの結果データが、CDA ブロックに含まれます。 |
要素の特性 | |
(なし) | |
エレメントの内容 | |
エクスポートの CSV 形式のデータを含む CDA ブロック。行は改行文字で区切られます。返されるデータの最初の行は、後続の各行の形式を説明する一連の "列ヘッダー" です。属性とフィルタリング要素が最初に表示され、その後に一連の要求された期間値が表示されます。合計組織の "(Rollup)" サフィックスなどの期間コードとシステムが生成するラベルは、可能な場合、リクエストのロケールに翻訳されます。値は、小数点記号としてピリオドを使用し、カンマのない標準化された形式で出力されます。 | |
ステータス要素 | |||
タグ名 | status | ||
説明 | リクエストおよび行数のステータス情報が含まれます (ストリーミング リクエストのみ) | ||
要素の特性 | |||
特性名 | 必須? | 値 | 例 |
成功 | あり | "true" または "false"。リクエストが正常に完了したかどうかを通知します。正常に完了したリクエストにも、警告メッセージが含まれている場合があります。
これは、ストリーミング リクエストにおいてのみ応答の属性を置き換えます。 | "true" |
rowCountSent | あり | r"\d+".回答内の行数を数値で表します。 | "10" |