Skip to main content
Documentation
Documentation
Administrator Guide
Last Updated: 2025-09-19
Steps: Export Data from a Prism Data Source

Steps: Export Data from a Prism Data Source

Security:
  • Prism Data Export: Execute
     domain in the Prism Analytics functional area.
  • Any of these security requirements for table you export from:
    • Prism: Tables Manage
       domain in the Prism Analytics functional area.
    • Prism: Tables Owner Manage
       domain in the Prism Analytics functional area.
    • Table Viewer
      permission on the table.
    • Table Editor
       permission on the table.
    • Table Owner
       permission on the table.
The
Prism Analytics
 REST API enables you to programmatically export data from a table-backed Prism data source. Use this URL when you use the REST API to access the REST resources using version 3: 
https://{hostname}/api/prismAnalytics/v3/{tenantname}
  1. Register your API client in your tenant using the
    Register API Client for Integrations
     task.
    Select
    Include Workday Owned Scope
     when you register. For more information, see Register API Clients for Integrations.
  2. Create a data export job.
    Use the
    POST /dataExport REST
     endpoint. Workday returns the ID of the data export job in the response body. See Creating Data Export Job.
    Workday runs a background job to export data from the Prism data source into 1 or more files. When the data export job successfully completes, Workday generates a collection of output files in your tenant containing the data exported from the Prism data source. You can download the exported files later.
  3. Check the status of the data export job.
    You can use these tasks and API resources:
    • Process Monitor. Search for the Prism Data Export type.
    • Prism Activities Dashboard.
    • GET /dataExport/{id}
       REST resource.
    Check the status of the data export job periodically, but not too often, until the status is Success. Workday doesn't automatically notify you when the job is complete. See Getting Data Export Job Status.
    When the status parameter is Success, Workday returns:
    • A results parameter that contains an array of the generated output files. Workday uses this format for the results: 
      "results": [
{
"name": " file_name ",
"length": length
},
...
]
    • Any warnings encountered when running the data export job.
  4. When the data export job has a status of Success, get the file names of the generated output files using the
    GET /dataExport/{id}
     endpoint. This endpoint will list the names and sizes of all generated files.
  5. Download the generated output files of a successful data export job.
    You can download files either sequentially or in parallel. See Downloading Output Files.