개념: 데이터 내보내기 REST API

개요

주요 기능

테이블 기반 Prism 데이터 소스에서 데이터를 내보내는 데이터 내보내기 작업을 생성합니다.
특정 데이터 내보내기 작업을 취소합니다. 데이터 내보내기 작업 상태는 '예정' 또는 '실행중'이어야 합니다.
제약조건이 없는 시큐리티 그룹의 사용자는 모든 데이터 내보내기 작업을 조회하고 취소할 수 있습니다.
셀프서비스 시큐리티 그룹의 사용자는 본인이 생성한 데이터 내보내기 작업만 조회하고 취소할 수 있습니다.
데이터 내보내기 작업의 상태를 확인하십시오.
예정: 데이터 내보내기 작업이 실행되도록 스케줄링되었습니다.
처리 중: 데이터 내보내기 작업이 현재 실행 중입니다.
성공: 데이터 내보내기 작업이 완료되고 내보낸 데이터가 포함된 출력 파일이 하나 이상 생성되었습니다.
취소: 사용자의 요청에 따라 데이터 내보내기 작업 실행이 중지되었습니다.
실패: 데이터 내보내기 작업을 실행하는 동안 오류가 발생했습니다.
내보낸 데이터가 포함된 출력 파일을 다운로드합니다.
현재 사용자의 시큐리티 프로필에서 허용하는 출력 파일만 다운로드할 수 있습니다.
파일을 순차적으로 또는 동시에 다운로드할 수 있습니다. 모든 출력 파일을 동시에 다운로드하여 다운로드하는 데 필요한 시간을 줄일 수 있습니다.
다운로드 성능은 다음에 따라 달라집니다.
파일 수
병행 다운로드 수입니다.
API 클라이언트와 Workday 서버 간의 네트워크 대역폭입니다. 예를 들어 클라이언트가 서버와 다른 지역에 있는 경우 파일 다운로드 시간이 늘어납니다.

사용 사례

URL 기본 경로

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

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

시큐리티 고려사항

Prism 데이터 내보내기: 실행
: 데이터 내보내기 작업을 생성할 수 있는 사용자를 제어합니다.
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개의 응답을 받게 됩니다.
동시 내보내기 작업:
내보내기 작업은 사용자 또는 테넌트당 한 번에 하나만 실행할 수 있습니다.
추가 내보내기 작업은 현재 작업이 완료될 때까지 자동으로 대기열에 추가됩니다.

일반적인 오류

잘못된 입력 json입니다.
잘못된 SQL, 유효하지 않은 필드/테이블명, 지원되지 않는 함수
가드레일: 필드 수 > 10000
시큐리티 제약조건이 충족되지 않았습니다.

시스템 오류
Gaudrails: 추출에 10억 개 이상의 행이 있는 경우 실패합니다.

다운로드 시에는 예상치 못한 네트워크 문제 또는 시스템 문제로 인해 HTTP 클라이언트가 재시도하는 것이 좋습니다. 테넌트 및 서버에 대해 생성되는 동시 연결 수에는 비율 제한이 적용됩니다. 때때로 HTTP 상태 코드가 표시될 수 있습니다.
429
또는
503
이 적용되는 한도 때문입니다. 클라이언트가 잠시 기다린 후 요청을 다시 시도하는 것이 좋습니다.

성능 고려사항