RESTful Refresh Dataset

This function refreshes an existing dataset. You can only access datasets that you created.

Overview

The Refresh Dataset endpoint allows you to update an existing dataset with the latest data without creating a new one. 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 Refresh Dataset uses the following base URL:

https://www.dayforcehcm.com/api/CompanyName/V1/Analytics/Datasets/{datasetId}

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 using via 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:

{
  "Data": {
    "DatasetId": "aeab59f3-33f1-4f94-915b-9dc76181ab58",
    "Status": "Requested"
    "ReportID": 2171
  }
}