exportConfigurableModelData
API v19以降でサポートされています
|
カテゴリ |
データの取得 |
|
説明 |
要求されたバージョンおよびインスタンスでリクエストされたモデルシートから行のセットを返します。 |
|
呼び出しに必要な権限 |
リクエストされているシート、バージョン、およびインスタンスへの読み取りアクセス。 |
|
リクエストに必要なパラメータ |
認証情報、モデルシート、バージョン、ジョブ |
このメソッドのリクエストには、どのモデル行が返されるかを決定するために使用するパラメーターが含まれます。ユーザーは、シート、バージョン、およびモデルシートを含むインスタンスへの読み取りアクセス権を持つ必要があります。
ベストプラクティス: exportSheetsを呼び出して、exportConfigurableModelDataリクエストに必要なモデルシート名とIDを取得します。
リクエストの形式
<?xml version='1.0' encoding='UTF-8'?><call method="exportConfigurableModelData" callerName="me"> <credentials login="user@example.com" password="password"/> <version name="Budget 2017"/> <job jobNumber="0" pageNumber="1" pageSize="200"/> <modeled-sheet name="Capital Model" isGlobal="false" includeAllColumns="false" useNumericIDs="false"/> <filters> <timeSpan start="Mar-2016" end="Dec-2017"/> <levels> <level name="Hosting" includeDescendants="true"/> </levels> </filters></call>
|
認証情報要素 |
|||
|
タグ名 |
認証情報 |
||
|
説明 |
すべてのAPI呼び出しには、APIを呼び出すユーザーを識別する単一の認証情報要素が含まれている必要があります。APIコールはこのユーザーとして実行されるため（システム内の変更履歴または操作履歴は、このユーザーが操作を実行したことを示します）、API呼び出しを成功させるには、ユーザーが操作を実行するために必要な権限を持っている必要があります。 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
|
ログイン |
Y |
APIメソッドを呼び出すユーザーのログイン名。このユーザーは、呼び出されるメソッドに必要な権限を含むロールを持っている必要があります。 |
sampleuser@company.com |
|
パスワード |
Y |
APIメソッドを呼び出すユーザーのパスワード。 |
my_password |
|
要素の内容 |
|||
|
（なし） |
|||
|
バージョン要素 |
|||
|
タグ名 |
バージョン |
||
|
説明 |
モデル行を取得するバージョンを指定します。 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
| 名前 | Y | バージョンの名前。 | 予算2 |
|
要素の内容 |
|||
|
1つまたは複数の組織要素が含まれています。 |
|||
|
モデルシート要素 |
|||
|
タグ名 |
モデルシート |
||
|
説明 |
モデル行を取得するモデルシートを指定します。識別子としてモデルシートのIDまたは名前を使用します。 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
| 名前 | Y | モデルシートの名前。 | 実行予算 |
| isGlobal | N | シートがユーザー割当シートまたは組織割当シートのいずれであるかを指定します。trueの場合は、ユーザー割当シートです。falseの場合は、組織割当シートです。 | false |
|
includeAllColumns API v22以降でサポートされています |
N | 応答内のすべての列を含めるかどうかを指定します。true以外の値はすべてfalseになります。 | false |
|
useNumericIDs API v22以降でサポートされています |
N |
応答の内部 ID を数値形式にするかどうか指定します。例: 「
|
true |
|
要素の内容 |
|||
| （なし） | |||
|
ジョブエレメント |
|||
|
タグ名 |
ジョブ |
||
|
説明 |
APIコールジョブのAPIハンドラーのシリアル番号を指定します。 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
| jobNumber | Y |
初期コールの場合は0です。応答でジョブ番号が返されます。その後のリクエストには、このジョブ番号を使用します。 APIハンドラーはその後、シートをメモリに読み込むシートモデルを作成します。リクエストがタイムアウトし、ガベージコレクションが実行されるまで、シートはメモリに残ります。APIはその後、上記の他のパラメーターとともに、最初のページを返します。 |
2 |
| pageSize | N | デフォルトのpageSizeを上書きして、APIユーザーが各コールで取得するページあたりの行数を指定できるようにします。jobNumber="0"の場合、最初のコールでのみ有効です。pageSizeがシートの行数より大きい場合、pageSizeは無視されます。 | 200 |
| pageNumber | Y |
複数のページが存在する場合、リクエストされるページ番号を指定します。ページ番号インデックスは「1」で始まります。 APIハンドラーは、同じリクエストAPIと認証を使用して後続のコールを行う同じユーザー用です。 後続のリクエストは、最後の応答時間から3分以内に行う必要があります。 |
1 |
|
要素の内容 |
|||
| （なし） | |||
|
フィルタ要素 |
|||
|
タグ名 |
フィルター |
||
|
説明 |
すべてのフィルター関連要素のコンテナ。 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
|
要素の内容 |
|||
|
組織要素。 |
|||
|
組織要素 |
|||
|
タグ名 |
組織 |
||
|
説明 |
1つの組織要素のコンテナは、行の取得元の組織を指定します。 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
|
要素の内容 |
|||
|
1つの組織要素。 |
|||
|
組織要素 |
|||
|
タグ名 |
組織 |
||
|
説明 |
リクエストのフィルタリングに使用する組織を指定します。 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
|
名前 |
Y |
リクエストされる組織の名前。 |
本社 |
| includeDescendants | N |
指定された組織のすべての子孫をエクスポートに含めるかどうかを示します。trueに設定した場合、この組織の子だけでなく、その子、孫などすべてがエクスポートされます。falseに設定した場合、この組織が単独でエクスポートされます。 falseを指定すると、Adaptive PlanningウェブUIの組織（のみ）として示される組織をエクスポートできます。 |
true |
|
要素の内容 |
|||
|
組織名 |
|||
|
timeSpan 要素 |
|||
|
タグ名 |
timeSpan |
||
|
説明 |
モデルシートにtimeSpan要素がある場合、開始と終了は、シートからエクスポートするデータの期間を指定します。timeSpan が含まれていない場合、バージョンの日付範囲全体のデータがエクスポートされます。（時間管理UIからの）内部期間コードまたはシートビューからのローカライズされた時間ラベルを使用して、timeSpanの開始または終了を指定します。 TimeSpanは、Adaptive Planning UI内のモデルシートの開始および終了のリーフ時間選択の [表示オプション] > [時間設定] の機能を複製します。 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
|
開始 |
N |
エクスポートする範囲の最初の期間のシートに表示される時間コードまたはローカライズされた時間ラベル。開始期間はリーフ期間でなければなりません。開始が指定されていない場合、バージョンの開始が使用されます。 |
Jan-2016 01/2016 |
| 終了 | N |
エクスポートする範囲の最後の期間の時間コードまたはローカライズされた時間ラベル。終了期間はリーフ期間でなければなりません。終了が指定されていない場合、バージョンの終了が使用されます。 |
Nov-2016 11/2016 |
timeSpanの例
2016年1月月初から2016年4月月末。Jan-2016 は、時間管理 UI によって示される内部期間コードです。04/2016 はシートの時間ラベルです。
<timeSpan start="Jan-2016" end="04/2016"/>
2016 年 2 月月初からバージョンの終了日。02/2016 はシートの時間ラベルです。
<timeSpan start="02/2016"/>
バージョンの開始日から2016年11月月末。Nov-2016は、時間管理UIによって示される内部期間コードです。
<timeSpan start="" end="Nov-2016"/>
応答形式
<?xml version="1.0" encoding="UTF-8"?><response success="true"> <output> <data jobNumber="3"> <![CDATA["InternalID","Plan","CapitalAssetClass","Label","Price","Currency","Mar-2016","Q1-FY16","Apr-2016","May-2016","Jun-2016","Q2-FY16","Jul-2016","Aug-2016","Sep-2016","Q3-FY16","Oct-2016","Nov-2016","Dec-2016","Q4-FY16","FY2016","Jan-2017","Feb-2017","Mar-2017","Q1-FY17","Apr-2017","May-2017","Jun-2017","Q2-FY17","Jul-2017","Aug-2017","Sep-2017","Q3-FY17","Oct-2017","Nov-2017","Dec-2017","Q4-FY17","FY2017""S1325","Development","Furniture","Chairs","90","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","""S1326","Development","Furniture","Desks","200","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","""S1327","Development","Computers","EngineerWS","2500","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","""S1328","Development","Computers","ManagerWS","1000","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","""S1323","G & A","Facility","Garage","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","""S1324","G & A","OtherEquipment","CD_Maker","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""]]> </data> </output></response>
|
応答要素 |
|||
|
タグ名 |
応答 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
|
成功 |
Y |
APIコールが成功したかどうかを示すtrueまたはfalse。コールが成功しても、応答に警告メッセージが含まれる場合があります。 |
true |
|
要素の内容 |
|||
|
単一のメッセージ要素、および1つの必須出力要素。 |
|||
|
メッセージ要素 |
|
|
タグ名 |
メッセージ |
|
説明 |
1つまたは複数のメッセージ要素のコンテナ。 |
|
要素の特性 |
|
|
（なし） |
|
|
要素の内容 |
|
|
1つまたは複数のメッセージ要素。 |
|
|
メッセージ要素 |
|||
|
タグ名 |
メッセージ |
||
|
説明 |
システムから送信者に送り返されるメッセージを表します。メッセージは、リクエストが成功しない場合のエラーメッセージ、リクエストが成功した場合の警告メッセージ、および成功した時点での確認メッセージに使用されます。 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
|
キー |
N |
キーを指定すると、特定のメッセージまたはメッセージのタイプを識別する方法となり、クライアントプログラムでのエラーの自動記録とリカバリに役立ちます。キーは、メッセージの言語が変更された場合でも、ロケールの異なるリクエストの下で変更されることはありません。また、文言の調整や用語の変更により、キーが将来変更されることはほとんどありません。 |
invalid-attributevalueid |
|
要素の内容 |
|||
|
メッセージのテキスト。このテキストは、リクエストで指定されたロケールの言語で表示されます（ロケールがサポートされていることを前提としています）。テキストには、処理された行の数、またはエラーの原因となった特定の列または値などの変数情報も含まれる場合があります。 |
|||
|
ジョブエレメント |
|||
|
タグ名 |
ジョブ |
||
|
説明 |
返されたデータのジョブおよびデータページング情報を指定することにより、ユーザーが一連のコールを行い、モデルシートからフィルタリングされたデータセットのすべてのデータを抽出できるようにします。 | ||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
| jobNumber | N | APIコールのジョブ用にサーバーによって割り当てられた専用APIハンドラーのシリアル番号。後続のすべてのリクエストで使用されます。 | 2 |
| pageCount | N | フィルターセットに使用できるデータの合計ページ数。 | 3 |
| pageNumber | N | 返される現在のデータセットのページ番号。 | 1 |
|
要素の内容 |
|||
|
1つまたは複数の組織要素。リクエストがアクセス不可の組織を含む場合、全社を表す1つの組織要素のみが存在します。 |
|||
|
出力要素 |
|||
|
タグ名 |
出力 |
||
| 説明 |
この応答は、エクスポートされるモデル行のCSV形式データダンプを含むCDATAブロックを返します。CDATAブロックの最初の行は、CSVの「ヘッダー行」で、その後の行はすべてデータ行です。フィルタリングリクエストに一致する行がない場合、ヘッダー行のみが出力されます。 CSVの列は、最大5つのハードコード化された内部フォーカス列で始まります。これらの列は、行とその不変のプロパティの一部を識別できます。シートに表示される列は、以下に関係なく続きます。
API応答のすべての列は、シートの表示/定義された列であり、宣言された列ヘッダーはヘッダー行のラベルになります。これには、シートに配置された特性列が含まれます。期間科目の場合、列ヘッダーは、exportData APIと同じ形式の現在のバージョンの月です。 |
||
|
要素の特性 |
|||
|
特性名 |
必須? |
値 |
例 |
| レベル | N | この行または分割/行が存在する組織の名前。これは、リクエストされている組織が合計組織であるかどうかに関係なく表示されます。 | エンジニアリング |
|
要素の内容 |
|||
|
CDATAブロックには以下が含まれます。
|
|||