The following function retrieves the contents of a report's dataset. You can only access the datasets that you created.
Overview
The Get Dataset request allows the consuming application to retrieve the contents of a report's dataset. Required parameters for the call include DatasetId, clientNamespace, and BearerToken, though the authorization provided by the BearerToken can also be provided through basic user authentication
The URL for the Get Dataset request uses the following base URL:
https://www.dayforcehcm.com/api/ClientName/V1/Analytics/Datasets/datasetId
Note: Datasets expire if they have not been accessed using the Get Dataset endpoint for 63 days. If a Get Dataset request is sent for an expired dataset, then a 204 No Content response will be returned because the requested dataset has expired.
Parameters
Note: An asterisk (*) next to a parameter name denotes a required parameter.
datasetId* (string)
- Uniquely identifies a dataset.
ClientNamespace* (string)
- Uniquely identifies the client's Dayforce instance. This is needed to log in.
BearerToken* (string)
- Authorization Token is mandatory for this API. Testing this API in the Dayforce Developer's Network (DDN) is not supported. This authorization may also be provided with basic user authentication.
Response
The response is in JSON format as illustrated in the example below:
]
{
"Name": " Care",
"Start Date": null,
"Due Date": null,
"Completed Date": null,
"Priority Level": 0,
"Budget Hours": 0.00000,
"% Time Elapsed": null,
"Product Group": null,
"Product Module": null,
"Project Type": null,
"Project Client": null,
"Project Phase": null,
"Account #": null,
"IFRS": false,
"Clock Code": null,
"XRef Code": null,
"Ledger Code": null,
"Certified Payroll Project Number": null
}
]