Conceito: API REST para exportação de dados

Visão geral

Principais recursos

Crie uma tarefa de exportação de dados para exportar dados de uma fonte de dados Prism baseada em tabela.
Cancelar uma tarefa de exportação de dados específica. O status da tarefa de exportação de dados deve ser Programado ou Em execução.
Os usuários em grupos de segurança sem restrição podem visualizar e cancelar todas as tarefas de exportação de dados.
Os usuários em um grupo de segurança de autoatendimento podem visualizar e cancelar apenas as tarefas de exportação de dados que eles criaram.
Verifique o status da tarefa de exportação de dados.
Programado: o Workday programou a execução da tarefa de exportação de dados.
Em processamento: o Workday está executando a tarefa de exportação de dados no momento.
Êxito: o Workday concluiu a tarefa de exportação de dados e criou um ou mais arquivos de saída contendo os dados exportados.
Cancelado: o Workday interrompeu a execução da tarefa de exportação de dados a solicitação de um usuário.
Falha: o Workday encontrou um erro ao tentar executar a tarefa de exportação de dados.
Baixe os arquivos de saída que contêm os dados exportados.
Você só pode download os arquivos de saída permitidos pelo perfil de segurança do usuário atual.
Você pode download de arquivos em sequência ou em paralelo. Você pode reduzir o tempo necessário para download todos os arquivos de saída baixando-os em paralelo.
O desempenho do download depende de:
O número de arquivos.
O número de downloads simultâneos
A largura de banda da rede entre o cliente de API e o servidor do Workday . Exemplo: se o cliente estiver em uma região geográfica diferente da do servidor, o tempo para download os arquivos aumentará.

Casos de uso

Caminho base do URL

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

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

Considerações de segurança

Exportação de dados Prism: executar
: controla quem pode criar tarefas de exportação de dados.
Exportação de dados Prism: gerenciar
: controla quem pode visualizar e cancelar as tarefas de exportação de dados.

Criação de tarefa de exportação de dados

"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"
}

Obtenção de status da tarefa de exportação de dados

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"
}

Download de arquivos de saída

A ID da tarefa de exportação de dados.
O nome do arquivo de saída da tarefa de exportação de dados.

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

Cancelamento de uma tarefa de exportação de dados

Exportação de dados Prism: executar
Exportação de dados Prism: gerenciar

domínio
Prism: Tables Manage
na área funcional Prism Analytics .
domínio
Prism: Tables Owner Manage
na área funcional Prism Analytics .
permissão de visualização da tabela na tabela.
permissão para editar a tabela na tabela.
permissão de proprietário da tabela na tabela.

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"
}

Limitações

Os cargos de exportação são de baixa prioridade e terão precedência mais baixa do que outros cargos, como a publicação.
Você não pode download os arquivos gerados após 7 dias, pois eles serão excluídos.
Estes valores máximos são definidos como medidas de proteção para otimizar o desempenho e a confiabilidade do sistema:
1 bilhões de linhas por tarefa de exportação.
1.000 colunas por consulta.
Solicitações de download simultâneas:
Se o limite do sistema for atingido, você receber uma resposta 503 - HIT_ SERVER_LIMIT.
Se um locatário exceder seu limite específico, você receber uma resposta 429 - HIT_TENENT_LIMIT.
Tarefas de exportação simultâneas:
Apenas uma tarefa de exportação pode ser executada por vez por usuário ou locatário.
Todas as tarefas de exportação adicionais serão colocadas automaticamente na fila até que a tarefa atual seja concluída.

Erros comuns

Json de entrada malformado.
SQL malformado, campos/nome de tabela inválido , funções sem suporte
medidas de proteção: número de campos > 10000
Restrições de segurança não atendidas.

Erros do sistema
Feedbacks: falha se a extração tem mais de 1B linhas.

Durante o download, é sempre recomendável que o cliente HTTP tenha novas tentativas devido a problemas imprevistos na rede ou no sistema. Há uma limitação de taxa aplicada ao número de conexões simultâneas criadas para um locatário e um servidor. De vez em quando você pode ver códigos de status HTTP
429
ou
503
devido a esses limites aplicados. É recomendável que o cliente aguarde um tempo e tente a solicitação novamente.

Considerações de desempenho