概念: データ エクスポート REST API

概要

主な特徴

テーブル保護された Prism データ ソースからデータをエクスポートするデータ エクスポート ジョブを作成します。
特定のデータ エクスポート ジョブをキャンセルする。データ エクスポート ジョブのステータスが "スケジュール済" または "実行中" である必要があります。
制約のないセキュリティ グループのユーザーは、すべてのデータ エクスポート ジョブを表示およびキャンセルできます。
セルフサービス セキュリティ グループに含まれているユーザーは、自分が作成したデータ エクスポート ジョブのみ表示およびキャンセルできます。
データ エクスポート ジョブのステータスを確認してください。
スケジュール済: データ エクスポート ジョブの実行がスケジュールされています。
処理: Workday は現在、データ エクスポート ジョブを実行しています。
成功: データのエクスポート ジョブが完了し、エクスポートされたデータを含む 1 つ以上の出力ファイルが作成されました。
キャンセル: ユーザーのリクエストでデータ エクスポート ジョブの実行が停止されました。
失敗: データ エクスポート ジョブの実行中にエラーが発生しました。
エクスポートされたデータを含む出力ファイルをダウンロードします。
現在のユーザーのセキュリティ プロファイルで許可された出力ファイルのみをダウンロードできます。
ファイルは、順番にダウンロードすることも、並行してダウンロードすることもできます。出力ファイルを並行してダウンロードすることで、すべての出力ファイルのダウンロードにかかる時間を短縮できます。
ダウンロードのパフォーマンスは以下に依存します。
ファイル数。
並行ダウンロードの数。
API クライアントと Workday サーバー間のネットワーク帯域幅。例: クライアントがサーバーとは異なる地域にある場合、ファイルのダウンロードにかかる時間が長くなります。

ユース ケース

URL の基準パス

https://{hostname}/api/prismAnalytics/{version}/{tenantname}/dataExport

https://yourTenantHostName.com/api/prismAnalytics/v3/<TENANT_NAME>/dataExport

セキュリティの考慮事項

Prism Data Export: Execur
: データ エクスポート ジョブを作成できるユーザーを制御します。
Prism Data Export: Manage
: データ エクスポート ジョブを表示およびキャンセルできるユーザーを制御します。

データ エクスポート ジョブの作成

"input": {
"query": " WQL_Query ",
"type": "SQL"
}
 

"output": {
"type": "CSV_GZIP",
“headers”: true
}
 

POST /dataExport

{
 "input": {
  "query": "SELECT agentCity, GET_DISPLAY_ID(billingCompany) AS
 billing_company, GET_DISPLAY_ID(billingCostCenter) AS billing_CostCenter
 FROM cds_insuranceClaimData WHERE claimAmount > 1000",
  "type": "SQL"
 },
 "output": {
  "type": "CSV_GZIP",
  "headers": true
 }
}

{
 "createdMoment": "2017-03-17T00:00:00.000Z",
 "status": "Scheduled",
 "input": {
  "query": "SELECT agentCity, GET_DISPLAY_ID(billingCompany) AS
 billing_company, GET_DISPLAY_ID(billingCostCenter) AS billing_CostCenter
 FROM cds_insuranceClaimData WHERE claimAmount > 1000",
  "type": "SQL"
 },
 "id": "b1bd0e1ac5d410001193bf9340050000"
}

データ エクスポート ジョブのステータスの取得

GET /dataExport

{
 "total": 7,
 "data": [
  {
   "createdMoment": "2023-08-03T22:47:10.929Z",
   "createdBy": {
    "id": "274555853a4446cf8809325243534f34",
    "descriptor": "BLiu / Betty Liu (manager 4300, CostCtrMgr
 30.3, 41200, PayIntPartner; PayPartner, PayAdmin)",
    "fullName": "BLiu / Betty Liu (manager 4300, CostCtrMgr
 30.3, 41200, PayIntPartner; PayPartner, PayAdmin)"
   },
   "status": "Success",
   "input": {
    "query": "SELECT insuranceOfficeState, sourceFileTag,
 sort1, sort2, agentCity, agentCountry, agentNote,
 GET_DISPLAY_ID(billingCompany) AS billing_company,
 GET_DISPLAY_ID(billingCostCenter) AS billing_CostCenter FROM
 cds_insuranceClaimData",
    "type": "SQL"
   },
   "output": {
    "noOfFiles": 4,
    "totalSizeInBytes": 5610214,
    "totalRows": 110408
   },
   "id": "b1bd0e1ac5d4100013ad1f50c6910000"
  },
  ...
 ]
}

GET /dataExport/b1bd0e1ac5d410001193bf9340050000

{
 "createdMoment": "2023-08-03T22:08:42.928Z",
 "createdBy": {
  "id": "274555853a4446cf8809325243534f34",
  "descriptor": "BLiu / Betty Liu (manager 4300, CostCtrMgr 30.3,
 41200, PayIntPartner; PayPartner, PayAdmin)",
  "fullName": "BLiu / Betty Liu (manager 4300, CostCtrMgr 30.3,
 41200, PayIntPartner; PayPartner, PayAdmin)"
 },
 "status": "Success",
 "input": {
  "query": "SELECT agentCity, GET_DISPLAY_ID(billingCompany) AS
 billing_company, GET_DISPLAY_ID(billingCostCenter) AS billing_CostCenter
 FROM cds_insuranceClaimData WHERE claimAmount > 1000",
  "type": "SQL"
 },
 "output": {
  "createdTime": "2023-08-03T22:08:53.725Z",
  "expirationTime": "2023-08-10T22:08:53.725Z",
  "noOfFiles": 2,
  "totalSizeInBytes": 359680,
  "totalRows": 41301,
  "results": [
   {
    "name":
 "part-00000-70e49bea-487e-4a3e-b43e-be3935e951c1-c000.csv.gz",
    "length": 298913
   },
   {
    "name":
 "part-00001-70e49bea-487e-4a3e-b43e-be3935e951c1-c000.csv.gz",
    "length": 60767
   }
  ]
 },
 "id": "b1bd0e1ac5d410001193bf9340050000"
}

出力ファイルのダウンロード中

データ エクスポート ジョブの ID。
データ エクスポート ジョブの出力ファイルの名前。

GET /dataExport/b1bd0e1ac5d410001193bf9340050000/results/part-00000-70e49bea-487e-4a3e-b43e-be3935e951c1-c 000.csv.gz

データ エクスポート ジョブのキャンセル

Prism データのエクスポート: 実行
Prism データのエクスポート: 管理

"Prism Analytics" 業務分野の
"Prism: Tables Manage
" ドメイン
"Prism Analytics" 業務分野の
"Prism: Tables Owner Manage
" ドメイン
テーブルに対する "テーブル ビューアー" 権限
テーブルに対する "テーブル エディタ" 権限
テーブルに対する "テーブル所有者" 権限

POST /dataExport/b1bd0e1ac5d4100018d18abc4ea00000/cancel

{
 "createdMoment": "2023-08-04T00:21:24.914Z",
 "createdBy": {
  "id": "274555853a4446cf8809325243534f34",
  "descriptor": "BLiu / Betty Liu (manager 4300, CostCtrMgr 30.3,
 41200, PayIntPartner; PayPartner, PayAdmin)",
  "fullName": "BLiu / Betty Liu (manager 4300, CostCtrMgr 30.3,
 41200, PayIntPartner; PayPartner, PayAdmin)"
 },
 "status": "Canceled",
 "input": {
  "query": "SELECT agentCity, GET_DISPLAY_ID(billingCompany) AS
 billing_company, GET_DISPLAY_ID(billingCostCenter) AS billing_CostCenter
 FROM cds_insuranceClaimData",
  "type": "SQL"
 },
 "id": "b1bd0e1ac5d4100018d18abc4ea00000"
}

制限事項

"エクスポート ジョブ" は優先順位の低いジョブであり、パブリッシュなどの他のジョブよりも優先順位が低くなります。
7 日経過しないファイルは削除されるため、生成されたファイルをダウンロードすることはできません。
以下の最大値は、システムのパフォーマンスと信頼性を最適化するためのガイドラインとして設定されます。
エクスポート ジョブごとに 10 億行
クエリーごとに 1,000 列
同時ダウンロード リクエスト:
システムの上限に達した場合、503 - HIT_SERVER_LIMIT 応答が返されます。
テナントが特定の制限を超えた場合、429 - HIT_TENANT_LIMIT 応答が返されます。
同時エクスポート ジョブ:
ユーザーまたはテナントごとに一度に実行できるエクスポート ジョブは 1 つだけです。
追加のエクスポート ジョブは、現在のジョブが完了するまで自動的に待機します。

よくあるエラー

不正な入力 json です。
不正な sql、無効なフィールド/テーブル名、サポートされていない関数。
ガイドライン: フィールド数が 10,000 を超えています。
セキュリティ制約が満たされていません。

システム エラー
ガイダンス: 抽出行が 1B を超える場合は失敗します。

ダウンロードする際、予期しないネットワーク問題またはシステムの問題により、HTTP クライアントによる再試行が常に推奨されます。テナントと サーバーに対して作成される同時接続の数にレート制限が適用されます。HTTP ステータス コードが表示されることがあります
429
または
503
(適用される制限により)クライアントがしばらく待ってから、リクエストを再試行することをお勧めします。

パフォーマンスの考慮事項