{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Task Management API", "version": "v2" }, "items": [ { "info": { "name": "Task Management", "type": "folder" }, "items": [ { "info": { "name": "Get bulk jobs created by the currently logged in user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/jobs/users/me", "params": [ { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" }, { "name": "action", "value": "", "type": "query", "description": "The bulk job action." } ] }, "docs": "Get bulk jobs created by the currently logged in user." }, { "info": { "name": "Get the bulk add job associated with the job id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/add/jobs/:bulkJobId", "params": [ { "name": "bulkJobId", "value": "", "type": "path", "description": "Bulk job id" } ] }, "docs": "Get the bulk add job associated with the job id." }, { "info": { "name": "Update workitem bulk add job.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/add/jobs/:bulkJobId", "params": [ { "name": "bulkJobId", "value": "", "type": "path", "description": "Bulk job id" } ] }, "docs": "Update workitem bulk add job." }, { "info": { "name": "Delete a bulk add job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/add/jobs/:bulkJobId", "params": [ { "name": "bulkJobId", "value": "", "type": "path", "description": "Bulk job id" } ] }, "docs": "Delete a bulk add job" }, { "info": { "name": "Get bulk add job results.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/add/jobs/:bulkJobId/results", "params": [ { "name": "bulkJobId", "value": "", "type": "path", "description": "Bulk job id" } ] }, "docs": "Get bulk add job results." }, { "info": { "name": "Create a workitem bulk add job.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/add/jobs" }, "docs": "Create a workitem bulk add job." }, { "info": { "name": "Get bulk terminate job results.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/terminate/jobs/:bulkJobId/results", "params": [ { "name": "bulkJobId", "value": "", "type": "path", "description": "Bulk job id" } ] }, "docs": "Get bulk terminate job results." }, { "info": { "name": "Get the bulk job associated with the job id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/terminate/jobs/:bulkJobId", "params": [ { "name": "bulkJobId", "value": "", "type": "path", "description": "Bulk job id" } ] }, "docs": "Get the bulk job associated with the job id." }, { "info": { "name": "Update workitem bulk terminate job.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/terminate/jobs/:bulkJobId", "params": [ { "name": "bulkJobId", "value": "", "type": "path", "description": "Bulk job id" } ] }, "docs": "Update workitem bulk terminate job." }, { "info": { "name": "Delete a Bulk job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/terminate/jobs/:bulkJobId", "params": [ { "name": "bulkJobId", "value": "", "type": "path", "description": "Bulk job id" } ] }, "docs": "Delete a Bulk job" }, { "info": { "name": "Create a workitem bulk terminate job.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/bulk/terminate/jobs" }, "docs": "Create a workitem bulk terminate job." }, { "info": { "name": "Query for workbins", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workbins/query" }, "docs": "Query for workbins" }, { "info": { "name": "Get a workbin", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workbins/:workbinId", "params": [ { "name": "workbinId", "value": "", "type": "path", "description": "Workbin ID" } ] }, "docs": "Get a workbin" }, { "info": { "name": "Update the attributes of a workbin", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/workbins/:workbinId", "params": [ { "name": "workbinId", "value": "", "type": "path", "description": "Workbin ID" } ] }, "docs": "Update the attributes of a workbin" }, { "info": { "name": "Delete a workbin", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/taskmanagement/workbins/:workbinId", "params": [ { "name": "workbinId", "value": "", "type": "path", "description": "Workbin ID" } ] }, "docs": "Delete a workbin" }, { "info": { "name": "Get all versions of a workbin", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workbins/:workbinId/versions", "params": [ { "name": "workbinId", "value": "", "type": "path", "description": "Workbin ID" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" } ] }, "docs": "Get all versions of a workbin" }, { "info": { "name": "Get a version of a workbin", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workbins/:workbinId/versions/:entityVersion", "params": [ { "name": "workbinId", "value": "", "type": "path", "description": "Workbin ID" }, { "name": "entityVersion", "value": "", "type": "path", "description": "Workbin version" } ] }, "docs": "Get a version of a workbin" }, { "info": { "name": "Get a listing of a workbin's attribute change history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workbins/:workbinId/history", "params": [ { "name": "workbinId", "value": "", "type": "path", "description": "Workbin ID" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" } ] }, "docs": "Get a listing of a workbin's attribute change history" }, { "info": { "name": "Create a workbin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workbins" }, "docs": "Create a workbin" }, { "info": { "name": "Create a workitem", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems" }, "docs": "Create a workitem" }, { "info": { "name": "Query for workitems", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/query" }, "docs": "This query requires at least one EQ filter on the workbinId, assigneeId, queueId or typeId attributes. A maximum of three filters are allowed." }, { "info": { "name": "Create a workitem query job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/query/jobs" }, "docs": "Create a workitem query job" }, { "info": { "name": "Get the workitem query job associated with the job id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/query/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get the workitem query job associated with the job id." }, { "info": { "name": "Get results from for workitem query job ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/query/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get results from for workitem query job " }, { "info": { "name": "Disconnect the assignee of the workitem", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/disconnect", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "Workitem ID" } ] }, "docs": "Disconnect the assignee of the workitem" }, { "info": { "name": "Terminate a workitem", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/terminate", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "Workitem ID" } ] }, "docs": "Terminate a workitem" }, { "info": { "name": "Get a workitem", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "Workitem ID" }, { "name": "expands", "value": "", "type": "query", "description": "Which fields to expand. Comma separated if more than one." } ] }, "docs": "Get a workitem" }, { "info": { "name": "Update the attributes of a workitem", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "Workitem ID" } ] }, "docs": "Update the attributes of a workitem" }, { "info": { "name": "Delete a workitem", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "Workitem ID" } ] }, "docs": "Delete a workitem" }, { "info": { "name": "Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/assignment", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "Workitem ID" } ] }, "docs": "Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages." }, { "info": { "name": "Get all versions of a workitem", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/versions", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "Workitem ID" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" } ] }, "docs": "Get all versions of a workitem" }, { "info": { "name": "Get a version of a workitem", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/versions/:entityVersion", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "Workitem ID" }, { "name": "entityVersion", "value": "", "type": "path", "description": "Workitem version" } ] }, "docs": "Get a version of a workitem" }, { "info": { "name": "Get a listing of a workitem's attribute change history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/history", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "Workitem ID" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" } ] }, "docs": "Get a listing of a workitem's attribute change history" }, { "info": { "name": "Cancel the assignment process for a workitem that is currently queued for assignment through ACD.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/acd/cancel", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "Workitem ID" } ] }, "docs": "Cancel the assignment process for a workitem that is currently queued for assignment through ACD." }, { "info": { "name": "Get a specific named core type.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/schemas/coretypes/:coreTypeName", "params": [ { "name": "coreTypeName", "value": "", "type": "path", "description": "Name of the core type" } ] }, "docs": "Get a specific named core type." }, { "info": { "name": "Get the core types from which all schemas are built.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/schemas/coretypes" }, "docs": "Get the core types from which all schemas are built." }, { "info": { "name": "Get quantitative limits on schemas", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/schemas/limits" }, "docs": "Get quantitative limits on schemas" }, { "info": { "name": "Get a schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Get a schema" }, { "info": { "name": "Update a schema", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Update a schema" }, { "info": { "name": "Delete a schema", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Delete a schema" }, { "info": { "name": "Get a specific version of a schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/schemas/:schemaId/versions/:versionId", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" }, { "name": "versionId", "value": "", "type": "path", "description": "Schema version" } ] }, "docs": "Get a specific version of a schema" }, { "info": { "name": "Get all versions of a schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/schemas/:schemaId/versions", "params": [ { "name": "schemaId", "value": "", "type": "path", "description": "Schema ID" } ] }, "docs": "Get all versions of a schema" }, { "info": { "name": "Get a list of schemas.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/schemas" }, "docs": "Get a list of schemas." }, { "info": { "name": "Create a schema", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/schemas" }, "docs": "Create a schema" }, { "info": { "name": "Get all wrapup codes added for the given user for a workitem.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/users/:userId/wrapups", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "The ID of the Workitem." }, { "name": "userId", "value": "", "type": "path", "description": "The ID of the user" }, { "name": "expands", "value": "", "type": "query", "description": "Which fields, if any, to expand." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" } ] }, "docs": "Get all wrapup codes added for the given user for a workitem." }, { "info": { "name": "Add/Remove a wrapup code for a given user in a workitem.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/users/:userId/wrapups", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "The ID of the Workitem." }, { "name": "userId", "value": "", "type": "path", "description": "The ID of the user" } ] }, "docs": "Add/Remove a wrapup code for a given user in a workitem." }, { "info": { "name": "Add/Remove a wrapup code for the current user in a workitem.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/users/me/wrapups", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "The ID of the Workitem." } ] }, "docs": "Add/Remove a wrapup code for the current user in a workitem." }, { "info": { "name": "Get all wrapup codes added for all users for a workitem.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/workitems/:workitemId/wrapups", "params": [ { "name": "workitemId", "value": "", "type": "path", "description": "The ID of the Workitem." }, { "name": "expands", "value": "", "type": "query", "description": "Which fields, if any, to expand." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" } ] }, "docs": "Get all wrapup codes added for all users for a workitem." }, { "info": { "name": "Get a status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/statuses/:statusId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "statusId", "value": "", "type": "path", "description": "Status id" } ] }, "docs": "Get a status" }, { "info": { "name": "Update the attributes of a status", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/statuses/:statusId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "statusId", "value": "", "type": "path", "description": "Status id" } ] }, "docs": "Update the attributes of a status" }, { "info": { "name": "Delete a status", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/statuses/:statusId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "statusId", "value": "", "type": "path", "description": "Status id" } ] }, "docs": "Delete a status" }, { "info": { "name": "Get list of statuses for this worktype.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/statuses", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" } ] }, "docs": "Get list of statuses for this worktype." }, { "info": { "name": "Add a status to a worktype", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/statuses", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" } ] }, "docs": "Add a status to a worktype" }, { "info": { "name": "Query for worktypes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/query" }, "docs": "Optional request field 'expands' may include 'schema' to populate the name on each worktype's schema reference." }, { "info": { "name": "Get a worktype", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "expands", "value": "", "type": "query", "description": "Which fields, if any, to expand." } ] }, "docs": "Get a worktype" }, { "info": { "name": "Update the attributes of a worktype", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" } ] }, "docs": "Update the attributes of a worktype" }, { "info": { "name": "Delete a worktype", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" } ] }, "docs": "Delete a worktype" }, { "info": { "name": "Get all versions of a worktype", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/versions", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" } ] }, "docs": "Get all versions of a worktype" }, { "info": { "name": "Get a version of a worktype", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/versions/:entityVersion", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "entityVersion", "value": "", "type": "path", "description": "Worktype version" } ] }, "docs": "Get a version of a worktype" }, { "info": { "name": "Get a listing of a worktype's attribute change history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/history", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Ascending or descending sort order" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields." } ] }, "docs": "Get a listing of a worktype's attribute change history" }, { "info": { "name": "Create a worktype", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes" }, "docs": "Create a worktype" }, { "info": { "name": "Get a date based rule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/datebased/rules/:ruleId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "ruleId", "value": "", "type": "path", "description": "ruleId" } ] }, "docs": "Get a date based rule" }, { "info": { "name": "Update the attributes of a date based rule", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/datebased/rules/:ruleId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "ruleId", "value": "", "type": "path", "description": "ruleId" } ] }, "docs": "Update the attributes of a date based rule" }, { "info": { "name": "Delete a date based rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/datebased/rules/:ruleId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "ruleId", "value": "", "type": "path", "description": "ruleId" } ] }, "docs": "Delete a date based rule" }, { "info": { "name": "Get all date based rules for a worktype", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/datebased/rules", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." } ] }, "docs": "Get all date based rules for a worktype" }, { "info": { "name": "Add a date based rule to a worktype", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/datebased/rules", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" } ] }, "docs": "Add a date based rule to a worktype" }, { "info": { "name": "Get an attribute change rule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/onattributechange/rules/:ruleId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "ruleId", "value": "", "type": "path", "description": "ruleId" } ] }, "docs": "Get an attribute change rule" }, { "info": { "name": "Update the attributes of a rule", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/onattributechange/rules/:ruleId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "ruleId", "value": "", "type": "path", "description": "ruleId" } ] }, "docs": "Update the attributes of a rule" }, { "info": { "name": "Delete a rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/onattributechange/rules/:ruleId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "ruleId", "value": "", "type": "path", "description": "ruleId" } ] }, "docs": "Delete a rule" }, { "info": { "name": "Get all attribute-change rules for a worktype", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/onattributechange/rules", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." } ] }, "docs": "Get all attribute-change rules for a worktype" }, { "info": { "name": "Add an attribute-change rule to a worktype", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/onattributechange/rules", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" } ] }, "docs": "Add an attribute-change rule to a worktype" }, { "info": { "name": "Get an on-create rule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/oncreate/rules/:ruleId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "ruleId", "value": "", "type": "path", "description": "ruleId" } ] }, "docs": "Get an on-create rule" }, { "info": { "name": "Update the attributes of a rule", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/oncreate/rules/:ruleId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "ruleId", "value": "", "type": "path", "description": "ruleId" } ] }, "docs": "Update the attributes of a rule" }, { "info": { "name": "Delete a rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/oncreate/rules/:ruleId", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "ruleId", "value": "", "type": "path", "description": "ruleId" } ] }, "docs": "Delete a rule" }, { "info": { "name": "Get all on-create rules for a worktype", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/oncreate/rules", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200." } ] }, "docs": "Get all on-create rules for a worktype" }, { "info": { "name": "Add an on-create rule to a worktype", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/taskmanagement/worktypes/:worktypeId/flows/oncreate/rules", "params": [ { "name": "worktypeId", "value": "", "type": "path", "description": "Worktype id" } ] }, "docs": "Add an on-create rule to a worktype" } ] } ], "bundled": true }