Associating active workplan with agent schedules

[Guy_Brown]

I am using
/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}
to see the agents active schedule for the week, however it does not give the segment start times to mark adherence. I can return the workplan using /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans, but it does not give a start date of the work plan. Is there a middle call that can show which workplan was associated with each scheduled week?

[Langsford_Jay]

Schedule history is for knowing past changes to a schedule. We have adherence APIs and events. Not sure of your use case, but the schedule info needed for adherence would be https://developer.genesys.cloud/useragentman/workforcemanagement/#post-api-v2-workforcemanagement-businessunits--businessUnitId--weeks--weekId--schedules--scheduleId--agentschedules-query (which does have a work plan reference)

[Guy_Brown]

I am not seeing the workplan association or the details of the schedule

{
"id": "8b4429fb-3ba1-45e7-8cf5-01387e307bf5",
"weekDate": "2023-05-15",
"weekCount": 1,
"description": "WB May 15,2023 - Mid Month on a Monday",
"published": true,
"shortTermForecast": {
"id": "77e228df-79b4-4432-8632-72d4fab4f2be",
"weekDate": "2023-05-15",
"selfUri": "/api/v2/workforcemanagement/businessunits/857142bd-f85f-4873-b5b1-cf554244f60b/weeks/2023-05-15/shorttermforecasts/77e228df-79b4-4432-8632-72d4fab4f2be"
},
"generationResults": {
"failed": false,
"runId": "aa79e482-2cd1-4a52-b9f1-9929030a9448",
"messageCount": 29,
"messageSeverityCounts": [
{
"severity": "Information",
"count": 29
}
]
},
"metadata": {
"version": 2,
"modifiedBy": {
"id": "8ffe8d86-c0fb-4d5b-beb6-884304d53d24",
"selfUri": "/api/v2/users/8ffe8d86-c0fb-4d5b-beb6-884304d53d24"
},
"dateModified": "2023-05-23T18:53:33.204Z",
"createdBy": {
"id": "288e245d-8704-49d8-8be4-63b71a0940b9",
"selfUri": "/api/v2/users/288e245d-8704-49d8-8be4-63b71a0940b9"
},
"dateCreated": "2023-05-02T19:24:05.865Z"
},
"managementUnits": [
{
"managementUnit": {
"id": "d11696c3-7245-41f2-99cf-85cc119fe84b",
"selfUri": "/api/v2/workforcemanagement/managementunits/d11696c3-7245-41f2-99cf-85cc119fe84b"
},
"agentCount": 18,
"agents": [
{
"id": "14a68aeb-90b7-456e-a2af-fcae22eb179d",
"selfUri": "/api/v2/users/14a68aeb-90b7-456e-a2af-fcae22eb179d"
},
{
"id": "cb39a5c1-e810-4415-80bf-b3ef948cacf7",
"selfUri": "/api/v2/users/cb39a5c1-e810-4415-80bf-b3ef948cacf7"
},
{
"id": "10a11063-cf52-4445-ab12-0c695d1fa575",
"selfUri": "/api/v2/users/10a11063-cf52-4445-ab12-0c695d1fa575"
},
{
"id": "6d792bf0-c1bd-457d-8fec-0c0c23241d28",
"selfUri": "/api/v2/users/6d792bf0-c1bd-457d-8fec-0c0c23241d28"
},
{
"id": "b9414d2e-4efc-4fdd-a8b9-f2aa3d558831",
"selfUri": "/api/v2/users/b9414d2e-4efc-4fdd-a8b9-f2aa3d558831"
},
{
"id": "4fc6bdfc-b1b2-406e-8bda-92be6f8878a8",
"selfUri": "/api/v2/users/4fc6bdfc-b1b2-406e-8bda-92be6f8878a8"
},
{
"id": "525eac94-aede-444c-970d-02bcd5343e84",
"selfUri": "/api/v2/users/525eac94-aede-444c-970d-02bcd5343e84"
},
{
"id": "005a16d6-1618-4aa1-9fe1-4f22ce4f1ffc",
"selfUri": "/api/v2/users/005a16d6-1618-4aa1-9fe1-4f22ce4f1ffc"
},
{
"id": "bea0fa14-cdb5-4371-8f20-59f7335ab883",
"selfUri": "/api/v2/users/bea0fa14-cdb5-4371-8f20-59f7335ab883"
},
{
"id": "3d9d7a0a-27f0-445b-a6b8-7b2af150dc9f",
"selfUri": "/api/v2/users/3d9d7a0a-27f0-445b-a6b8-7b2af150dc9f"
},
{
"id": "73b826db-954c-465b-9100-99f26a7eea4e",
"selfUri": "/api/v2/users/73b826db-954c-465b-9100-99f26a7eea4e"
},
{
"id": "1ecfb94a-bbda-4a05-b6f1-cd41c154cab7",
"selfUri": "/api/v2/users/1ecfb94a-bbda-4a05-b6f1-cd41c154cab7"
},
{
"id": "afe76e1a-d6f5-41b2-8bf7-699cba290d55",
"selfUri": "/api/v2/users/afe76e1a-d6f5-41b2-8bf7-699cba290d55"
},
{
"id": "77dcbf88-f381-4c64-b4e0-7a1a27c5b4dd",
"selfUri": "/api/v2/users/77dcbf88-f381-4c64-b4e0-7a1a27c5b4dd"
},
{
"id": "d673047e-a92c-43f3-b434-f0f30249f3b5",
"selfUri": "/api/v2/users/d673047e-a92c-43f3-b434-f0f30249f3b5"
},
{
"id": "4e4139a1-283b-4ca4-9dfc-e3a47444f0d6",
"selfUri": "/api/v2/users/4e4139a1-283b-4ca4-9dfc-e3a47444f0d6"
},
{
"id": "8ee4abf4-6b8d-415b-8ef7-41fecd4fe337",
"selfUri": "/api/v2/users/8ee4abf4-6b8d-415b-8ef7-41fecd4fe337"
},
{
"id": "ab2be140-1dc4-452c-b687-03bb8537f82c",
"selfUri": "/api/v2/users/ab2be140-1dc4-452c-b687-03bb8537f82c"
}
]
},
{
"managementUnit": {
"id": "24da905f-e43b-46ce-a8c9-6e6b9059f33e",
"selfUri": "/api/v2/workforcemanagement/managementunits/24da905f-e43b-46ce-a8c9-6e6b9059f33e"
},
"agentCount": 0,
"agents": []
}
],
"selfUri": "/api/v2/workforcemanagement/businessunits/857142bd-f85f-4873-b5b1-cf554244f60b/weeks/2023-05-15/schedules/8b4429fb-3ba1-45e7-8cf5-01387e307bf5"
}

[brian.trezise]

That looks like you called GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}, which only returns the top level schedule metadata.

To get the full schedule details, which includes workplan references, you need the link Jay posted above.

Not sure if this is helpful, it's also worth noting that if you're calculating adherence this is something we already supply so depending on what you're trying to accomplish you may be re-inventing the wheel. Adherence data is available both in near-real time and historically. We have a tutorial for fetching historical adherence data.