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

概要

主な機能

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

ユース ケース

URL 基本パス

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

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

セキュリティの考慮事項

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

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

"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、無効なフィールド/テーブル名、サポートされていません。
ガードレール: フィールド数が 10000 以上。
セキュリティ上の制約が満たされていません。

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

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

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