Description
We will make a small documentation change in an upcoming release.
Currently, the following two routes return a WfmUserEntityListing, which lists that it returns a list of User objects.
-
/workforcemanagement/managementunits/{managementUnitId}/users -
/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users
In reality, the only the listing has only ever contained the id and selfUri fields, and so we are updating our documentation to more accurately show that the route returns a list of UserReference objects.
There is no functional change here, though this will result in a major SDK version bump
Change Category
Informational
Change Context
Documentation was incorrect
Change Impact
SDK will make a major bump; on updating there will be properties that were previously documented as being returned (the full user object) that will not be documented anymore.
This is not a functional change as the only two properties this has ever returned are id and selfUri
Date of Change
Immediate
Impacted APIs
/workforcemanagement/managementunits/{managementUnitId}/users
/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users
References
[WFM-21657]