Category: API
Summary: Workforce Management Historical Adherence query is being updated to have multiple downloadUrls as part of the release of WEM-12.
Context: As part of WEM-12, we are expanding a Management Unit to allow up to 1500 users. To ensure scalability of the system, we will now return Historical Adherence results in up to 3 separate downloadUrls instead of a single downloadUrl property.
Impact: 10 customers are currently using the Historical Adherence query route. They will have to switch to looking at the new downloadUrls property for their result instead of the downloadUrl property.
Date of Change: The downloadUrl property is being marked as deprecated now and will be removed no sooner than March 25, 2020. The new downloadUrls property will be available to use no later than Jan 31.
Impacted APIs:
Two APIs are impacted:
- POST /api/v2/workforcemanagement/adherence/historical
- POST /api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery
Also, the notification topic in which the data comes back is impacted in the same way:
- v2.users.{id}.workforcemanagement.historicaladherencequery
The current schema for both of the APIs and the topic is:
{
"id": "string",
"downloadUrl": "string",
"queryState": "Processing|Complete|Canceled|Error"
}
The schema releasing no later than Jan 31 contains the new property and marks the old property as deprecated:
{
"id": "string",
"downloadUrl": "string", // deprecated
"downloadUrls": "string[]",
"queryState": "Processing|Complete|Canceled|Error"
}
After no sooner than March 25, 2020, the schema will remove the downloadUrl property and look like this:
{
"id": "string",
"downloadUrls": "string[]",
"queryState": "Processing|Complete|Canceled|Error"
}
Note: Results for a particular user will be contained in a single download URL. There is no need to merge adherence data for a given user across multiple downloadUrls.