Wrap-up Codes
Permissions
To apply and remove wrapup codes for the current user requires this permission:
- Workitems > wrapupSelf > Edit
To apply and remove wrapup codes for other users requires this permission:
- Workitems > wrapup > Edit
To view wrapup codes on a workitem
- Workitems > wrapup > View
To apply a wrap-up code to a workitem for the current user:
{
"action": "Add",
"wrapupCode": "e7cab1ce-2784-42db-8645-7fd546281fa3"
}To remove a wrap-up code, set action to Remove instead.
To apply a wrap-up code on behalf of another user:
{
"action": "Add",
"wrapupCode": "e7cab1ce-2784-42db-8645-7fd546281fa3"
}A maximum of 5 wrap-up codes can be added for a given user on a workitem. The same wrap-up code can be applied to multiple users. It is not possible to add the same wrap-up code more than once for a given user.
Once a wrap-up code is applied to a workitem for a user, the user must have at least one wrap-up code on that workitem (i.e the last wrap-up code for a user cannot be removed)
For a workitem to have a wrap-up code applied, the following criteria needs to be met:
- The workitem has to be in a queue
- The wrap-up code has to be available to the queue the workitem is in
Viewing Wrap-up Codes on a Workitem
To view all wrap-up codes on a workitem:
{
"entities": [
{
"workitem": {
"id": "7fc57191-3c02-4caa-98db-90c2a7250326",
"selfUri": "/api/v2/taskmanagement/workitems/7fc57191-3c02-4caa-98db-90c2a7250326"
},
"wrapupCode": {
"id": "f9311ee8-275a-4f48-88cc-d9c57da0aed3",
"selfUri": "/api/v2/routing/wrapupcodes/f9311ee8-275a-4f48-88cc-d9c57da0aed3"
},
"modifiedBy": {
"id": "3ad73a9d-b0b2-48ff-b3c0-1fb166875167",
"selfUri": "/api/v2/users/3ad73a9d-b0b2-48ff-b3c0-1fb166875167"
},
"user": {
"id": "54e3b8f1-cfac-41f8-8da6-67fb19233748",
"selfUri": "/api/v2/users/54e3b8f1-cfac-41f8-8da6-67fb19233748"
},
"dateModified": "2023-01-16T17:39:34.740Z"
}
]
}To view all wrap-up codes on a workitem for a given user:
{
"entities": [
{
"workitem": {
"id": "7fc57191-3c02-4caa-98db-90c2a7250326",
"selfUri": "/api/v2/taskmanagement/workitems/7fc57191-3c02-4caa-98db-90c2a7250326"
},
"wrapupCode": {
"id": "f9311ee8-275a-4f48-88cc-d9c57da0aed3",
"selfUri": "/api/v2/routing/wrapupcodes/f9311ee8-275a-4f48-88cc-d9c57da0aed3"
},
"modifiedBy": {
"id": "3ad73a9d-b0b2-48ff-b3c0-1fb166875167",
"selfUri": "/api/v2/users/3ad73a9d-b0b2-48ff-b3c0-1fb166875167"
},
"user": {
"id": "54e3b8f1-cfac-41f8-8da6-67fb19233748",
"selfUri": "/api/v2/users/54e3b8f1-cfac-41f8-8da6-67fb19233748"
},
"dateModified": "2023-01-16T17:39:34.740Z"
}
]
}