Concept: REST-API voor gegevensexport

Overzicht

Belangrijkste functies:

Maak een gegevensexporttaak om gegevens te exporteren uit een door tabellen ondersteunde Prism- gegevensbron ''.
Annuleer een specifieke gegevensexporttaak. De status van de gegevensexporttaak moet 'Gepland' of 'Wordt uitgevoerd' zijn.
Gebruikers in onbeperkte beveiligingsgroepen kunnen alle gegevensexporttaken weergeven en annuleren.
Gebruikers in een beveiligingsgroep kunnen alleen de gegevensexporttaken weergeven en annuleren die ze hebben gemaakt.
Controleer de status van de gegevensexporttaak.
Gepland: de uitvoering van de gegevensexporttaak is gepland in Workday .
Wordt verwerkt: de taak voor gegevensexport wordt momenteel uitgevoerd in Workday .
Geslaagd: Workday heeft de taak voor het exporteren van gegevens voltooid en een of meer uitvoerbestanden met de geëxporteerde gegevens gemaakt.
Geannuleerd: de uitvoering van de gegevensexporttaak is stopgezet in Workday op aanvraag van een gebruiker.
Mislukt: Workday is een fout opgetreden bij het uitvoeren van de gegevensexporttaak.
Download de uitvoerbestanden met de geëxporteerde gegevens.
U kunt alleen de uitvoerbestanden downloaden die zijn toegestaan voor het beveiligingsprofiel van de huidige gebruiker.
U kunt bestanden achter elkaar of parallel downloaden . U kunt de tijd die vereist is om alle uitvoerbestanden downloaden, verkorten door ze parallel te downloaden.
De downloadprestaties zijn afhankelijk van:
Het aantal bestanden.
Het aantal parallelle downloads.
De netwerkbandbreedte tussen de API client en de Workday server. Voorbeeld: als de client zich in een andere geografische regio bevindt dan de server, duurt het langer voordat de bestanden zijn downloaden .

Gebruiksscenario's

URL-basispad

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

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

Aandachtspunten bij de beveiliging

Prism Data Export: Execute
: bepaalt wie gegevensexporttaken kan maken.
Prism Data Export: Manage
: bepaalt wie gegevensexporttaken kan weergeven en annuleren.

Taak voor gegevensexport maken

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

Status taak voor gegevensexport ophalen

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

Uitvoerbestanden downloaden

De ID van de gegevensexporttaak.
De naam van het uitvoerbestand van de gegevensexporttaak.

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

Taak voor gegevensexport annuleren

Prism-gegevensexport: uitvoeren
Prism-gegevensexport: Beheren

Het domein
Prism: Tables Manage
in het functionele gebied Prism Analytics .
Het domein
Prism: Tables Owner Manage
in het functionele gebied Prism Analytics .
machtiging voor tabelweergave voor de tabel.
machtiging Tabeleditor voor de tabel.
machtiging Tabeleigenaar voor de tabel.

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

Beperkingen

Exportfuncties zijn functies met een lage prioriteit en hebben een lagere prioriteit dan andere functies, zoals 'Publiceren'.
U kunt de gegenereerde bestanden niet meer downloaden na zeven dagen, omdat de bestanden dan worden verwijderd.
De volgende maxima worden ingesteld als vangrails om de systeemprestaties en betrouwbaarheid te optimaliseren:
1 miljard rijen per exporttaak.
1000 kolommen per query.
Gelijktijdige downloaden :
Als de systeemlimiet is bereikt, ontvangen u een antwoord van 503 - HIT_SERVER_LIMIT: .
Als een tenant de specifieke limiet overschrijdt, ontvangen u een antwoord 429 - HIT_TENANT_LIMIT .
Taken voor gelijktijdige export:
Per gebruiker of tenant kan slechts één exporttaak tegelijk worden uitgevoerd.
Alle aanvullende exporttaken worden automatisch in de wachtrij geplaatst totdat de huidige taak is voltooid.

Veelvoorkomende fouten

JSON voor invoer onjuist.
Onjuiste SQL-indeling, ongeldig velden/tabelnaam, niet-ondersteunde functies.
Vangrails: aantal velden > 10000.
Er is niet voldaan aan de beveiligingsbeperkingen.

Systeemfouten.
Gaudrails: mislukt als de extractie meer dan 1 miljard rijen had.

Vanwege onvoorziene netwerk- of systeemproblemen is het raadzaam om tijdens het downloaden altijd nieuwe pogingen voor de HTTP- client uit te voeren. Er is een snelheidsbeperking toegepast op het aantal gelijktijdige verbindingen dat met een tenant en een server wordt gemaakt. Mogelijk ziet u af en toe HTTP-statuscodes
429
of
503
vanwege deze afgedwongen limieten. De client wordt aangeraden enige tijd te wachten en de aanvraag opnieuw uit te voeren.

Aandachtspunten bij de prestaties