Work Management API

Endpoint Index

Action	Endpoint
Get Task	GET /work-management/{tenantLocator}/tasks/{locator}
Add Task	POST /work-management/{tenantLocator}/tasks
Update Task	PATCH /work-management/{tenantLocator}/tasks/{locator}
Activate Task	PATCH /work-management/{tenantLocator}/tasks/{locator}/activate
Assign Task	PATCH /work-management/{tenantLocator}/tasks/{locator}/assign/{userLocator}
Unassign Task	PATCH /work-management/{tenantLocator}/tasks/{locator}/unassign
Cancel Task	PATCH /work-management/{tenantLocator}/tasks/{locator}/cancel
Complete Task	PATCH /work-management/{tenantLocator}/tasks/{locator}/complete
Fetch Tasks with Number	GET /work-management/{tenantLocator}/tasks/numbers/{taskNumber}
Generate Task Number	POST /work-management/{tenantLocator}/tasks/{locator}/number/generate
List Tasks	GET /work-management/{tenantLocator}/tasks/list
List All Tasks	GET /work-management/{tenantLocator}/tasks/all/list
List Assigned Tasks	GET /work-management/{tenantLocator}/tasks/user/{userLocator}/list
List Task History	GET /work-management/{tenantLocator}/tasks/{locator}/history/list
Search Tasks	GET /work-management/{tenantLocator}/tasks/{referenceType}/{referenceLocator}/list
Set Task Number	POST /work-management/{tenantLocator}/tasks/{locator}/number/set
Get User Association	GET /work-management/{tenantLocator}/userAssociations/{locator}
Make User Association	POST /work-management/{tenantLocator}/userAssociations
Complete User Association	PATCH /work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/complete
Uncomplete User Association	PATCH /work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/uncomplete
Disassociate User Association	PATCH /work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/disassociate
List User Association History	GET /work-management/{tenantLocator}/userAssociations/{locator}/history/list
List User User Associations History	GET /work-management/{tenantLocator}/userAssociations/user/{userLocator}/history/list
Get Qualifications	GET /work-management/{tenantLocator}/qualifications
Fetch Users for a Qualification	GET /work-management/{tenantLocator}/qualifications/{category}/{level}
Get User Qualifications	GET /work-management/{tenantLocator}/qualifications/{userLocator}
Update User Qualifications	PATCH /work-management/{tenantLocator}/qualifications/{userLocator}
Create Workgroup	POST /work-management/{tenantLocator}/workgroups
Get Workgroup	GET /work-management/{tenantLocator}/workgroups/{workgroupLocator}
List Workgroups	GET /work-management/{tenantLocator}/workgroups/list
Patch Workgroup	PATCH /work-management/{tenantLocator}/workgroups/{workgroupLocator}
Discard Workgroup	PATCH /work-management/{tenantLocator}/workgroups/{workgroupLocator}/discard
Auto Assign	POST /work-management/{tenantLocator}/assignments
Create Workplan	POST /work-management/{tenantLocator}/workplans
Get Workplan	GET /work-management/{tenantLocator}/workplans/{locator}
List Workplans	GET /work-management/{tenantLocator}/workplans/list
Patch Workplan	PATCH /work-management/{tenantLocator}/workplans/{locator}
Discard Workplan	PATCH /work-management/{tenantLocator}/workplans/{locator}/discard

Tasks

Get Task

getTask

GET /work-management/{tenantLocator}/tasks/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Task
Security Group:tasks   Permission:read

Task

required
locator string
taskState Enum active | cancelled | completed | pastDeadline
category string
type string
createdAt datetime
createdBy uuid
references TaskReference[]
underwritingFlagLocators string[]

optional
assignedTo uuid?
completedAt datetime?
completedBy uuid?
deadlineTime datetime?
description string?
taskNumber string?
updatedAt datetime?
updatedBy uuid?

Add Task

addTask

POST /work-management/{tenantLocator}/tasks

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:TaskCreateRequest
Response:Task
Security Group:tasks   Permission:write

TaskCreateRequest

required
type string
references TaskReference[]
underwritingFlagLocators string[]

optional
assignedTo uuid?
deadlineTime datetime?
description string?

TaskCreationResponse

required
taskLocator string
status Enum failed | succeeded

Update Task

updateTask

PATCH /work-management/{tenantLocator}/tasks/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:TaskUpdateRequest
Response:Task
Security Group:tasks   Permission:write

TaskUpdateRequest

required
addReferences TaskReference[]
addUnderwritingFlags string[]
removeReferences TaskReference[]
removeUnderwritingFlags string[]

optional
deadlineTime datetime?
description string?

Activate Task

activateTask

PATCH /work-management/{tenantLocator}/tasks/{locator}/activate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Task
Security Group:tasks   Permission:write

Assign Task

assignTask

PATCH /work-management/{tenantLocator}/tasks/{locator}/assign/{userLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
userLocator	path	uuid	required

Response:Task
Security Group:tasks   Permission:write

Unassign Task

unassignTask

PATCH /work-management/{tenantLocator}/tasks/{locator}/unassign

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Task
Security Group:tasks   Permission:write

Cancel Task

cancelTask

PATCH /work-management/{tenantLocator}/tasks/{locator}/cancel

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Task
Security Group:tasks   Permission:write

Complete Task

completeTask

PATCH /work-management/{tenantLocator}/tasks/{locator}/complete

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Task
Security Group:tasks   Permission:write

Fetch Tasks with Number

fetchTasksWithNumber

GET /work-management/{tenantLocator}/tasks/numbers/{taskNumber}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
taskNumber	path	string	required

Response:Task[]
Security Group:tasks   Permissions:read,list

Generate Task Number

generateTaskNumber

POST /work-management/{tenantLocator}/tasks/{locator}/number/generate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Task
Security Group:tasks   Permission:write

List Tasks

listTasks

GET /work-management/{tenantLocator}/tasks/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseTask
Security Group:tasks   Permission:read

List All Tasks

listAllTasks

GET /work-management/{tenantLocator}/tasks/all/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseTask
Security Group:tasks   Permission:read

List Assigned Tasks

listAssignedTasks

GET /work-management/{tenantLocator}/tasks/user/{userLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
userLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseTask
Security Group:tasks   Permission:read

ListPageResponseTask

required
listCompleted boolean
items Task[]

List Task History

listTaskHistory

GET /work-management/{tenantLocator}/tasks/{locator}/history/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseTask
Security Group:tasks   Permission:read

Search Tasks

searchTasks

GET /work-management/{tenantLocator}/tasks/{referenceType}/{referenceLocator}/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
referenceType	path	Enum account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment	required
referenceLocator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseTask
Security Group:tasks   Permission:read

Set Task Number

setTaskNumber

POST /work-management/{tenantLocator}/tasks/{locator}/number/set

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
taskNumber	query	string	required

Response:Task
Security Group:tasks   Permission:write

TaskReference

required
referenceLocator string
referenceType Enum account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment

User Associations

Get User Association

getUserAssociation

GET /work-management/{tenantLocator}/userAssociations/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:UserAssociation
Security Group:user-associations   Permission:read

UserAssociation

required
locator string
referenceLocator string
userLocator uuid
userAssociationState Enum active | completed | disassociated | discarded
referenceType Enum account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment
userAssociationRole string
createdAt datetime
createdBy uuid

optional
updatedAt datetime?
updatedBy uuid?

Make User Association

makeUserAssociation

POST /work-management/{tenantLocator}/userAssociations

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:UserAssociationCreateRequest
Response:UserAssociation
Security Group:user-associations   Permission:write

UserAssociationCreateRequest

required
referenceLocator string
userLocator uuid
referenceType Enum account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment
userAssociationRole string

Complete User Association

completeUserAssociation

PATCH /work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/complete

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
userAssociationLocator	path	string	required

Response:UserAssociation
Security Group:user-associations   Permission:write

Uncomplete User Association

uncompleteUserAssociation

PATCH /work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/uncomplete

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
userAssociationLocator	path	string	required

Response:UserAssociation
Security Group:user-associations   Permission:write

Disassociate User Association

disassociateUserAssociation

PATCH /work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/disassociate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
userAssociationLocator	path	string	required

Response:UserAssociation
Security Group:user-associations   Permission:write

List User Association History

listUserAssociationHistory

GET /work-management/{tenantLocator}/userAssociations/{locator}/history/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseUserAssociation
Security Group:user-associations   Permission:read

ListPageResponseUserAssociation

required
listCompleted boolean
items UserAssociation[]

List User User Associations History

listUserUserAssociationsHistory

GET /work-management/{tenantLocator}/userAssociations/user/{userLocator}/history/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
userLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseUserAssociation
Security Group:user-associations   Permission:read

User Qualifications

Get Qualifications

getQualifications

GET /work-management/{tenantLocator}/qualifications

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Response:map<string,string[]>
Security Group:qualifications   Permission:read

Fetch Users for a Qualification

fetchUsersQualifications

GET /work-management/{tenantLocator}/qualifications/{category}/{level}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
category	path	string	required
level	path	string	required

Response:UserQualification[]
Security Group:qualifications   Permission:read

UserQualification

required
userLocator uuid
category string
level string

Get User Qualifications

getUserQualifications

GET /work-management/{tenantLocator}/qualifications/{userLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
userLocator	path	uuid	required

Response:map<string,string>
Security Group:qualifications   Permission:read

Update User Qualifications

updateUserQualifications

PATCH /work-management/{tenantLocator}/qualifications/{userLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
userLocator	path	uuid	required

Request:QualificationsUpdateRequest
Response:map<string,string>
Security Group:qualifications   Permission:write

QualificationsUpdateRequest

required
addQualifications map<string,string>
removeQualifications map<string,string>

Workgroups

Create Workgroup

createWorkgroup

POST /work-management/{tenantLocator}/workgroups

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:WorkgroupCreateRequest
Response:WorkgroupResponse
Security Group:workgroups   Permission:write

Get Workgroup

getWorkgroup

GET /work-management/{tenantLocator}/workgroups/{workgroupLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
workgroupLocator	path	string	required

Response:WorkgroupResponse
Security Group:workgroups   Permission:read

List Workgroups

listWorkgroups

GET /work-management/{tenantLocator}/workgroups/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
user	query	uuid?	optional
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseWorkgroupResponse
Security Group:workgroups   Permissions:read,list

Patch Workgroup

patchWorkgroup

PATCH /work-management/{tenantLocator}/workgroups/{workgroupLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
workgroupLocator	path	string	required

Request:WorkgroupPatchRequest
Response:WorkgroupResponse
Security Group:workgroups   Permission:write

Discard Workgroup

discardWorkgroup

PATCH /work-management/{tenantLocator}/workgroups/{workgroupLocator}/discard

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
workgroupLocator	path	string	required

Response:WorkgroupResponse
Security Group:workgroups   Permission:write

Auto Assign

autoAssign

POST /work-management/{tenantLocator}/assignments

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:AutoAssignmentCreateRequest
Response:AutoAssignmentResponse
Security Group:assignments   Permission:write

WorkgroupCreateRequest

required
name string
subgroups string[]
users uuid[]

optional
parentLocator string?
region string?
tag string?

WorkgroupResponse

required
locator string
name string
workgroupState Enum active | discarded
createdAt datetime
createdBy uuid
entities string[]
subgroups WorkgroupResponse[]
tasks string[]
users uuid[]

optional
region string?
parent string?
tag string?

ListPageResponseWorkgroupResponse

required
listCompleted boolean
items WorkgroupResponse[]

WorkgroupPatchRequest

required
empty boolean
removeSubgroups string[]
removeUsers uuid[]
setSubgroups string[]
setUsers uuid[]

optional
parentLocator string?
region string?
name string?
tag string?

AutoAssignmentCreateRequest

required
referenceLocator string
referenceType Enum account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment

optional
taskLocator string?
workgroupLocator string?
assignToGroup Enum? never | ifNotAssigned | always
associationRole string?
task TaskCreateRequest?
traversal Enum? depthFirst | breadthFirst | none

AutoAssignmentResponse

required
assignedUserLocator uuid
assignedWorkgroupLocator string
associationLocator string
taskLocator string

Workplans

Create Workplan

createWorkplan

POST /work-management/{tenantLocator}/workplans

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:WorkplanCreateRequest
Response:Workplan
Security Group:workplans   Permission:write

Get Workplan

getWorkplan

GET /work-management/{tenantLocator}/workplans/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Workplan
Security Group:workplans   Permission:read

List Workplans

listWorkplans

GET /work-management/{tenantLocator}/workplans/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional

Response:ListPageResponseWorkplan
Security Group:workplans   Permission:read

Patch Workplan

patchWorkplan

PATCH /work-management/{tenantLocator}/workplans/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:WorkplanPatchRequest
Response:Workplan
Security Group:workplans   Permission:write

Discard Workplan

discardWorkplan

PATCH /work-management/{tenantLocator}/workplans/{locator}/discard

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:Workplan
Security Group:workplans   Permission:write

WorkplanCreateRequest

required
name string
items WorkplanItemRequest[]

optional
defaultGroup string?

Workplan

required
locator string
name string
workplanState Enum active | discarded
createdAt datetime
createdBy uuid
items WorkplanItem[]

optional
defaultGroup string?

WorkplanItem

required
locator string
referenceLocator string
assignToGroup Enum never | ifNotAssigned | always
referenceType Enum account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment
traversal Enum depthFirst | breadthFirst | none

optional
associationRole string?
defaultGroup string?
task TaskCreateRequest?

ListPageResponseWorkplan

required
listCompleted boolean
items Workplan[]

WorkplanPatchRequest

required
addItems WorkplanItemRequest[]
removeItems string[]

optional
name string?
defaultGroup string?

WorkplanItemRequest

required
referenceLocator string
assignToGroup Enum never | ifNotAssigned | always
associationRole string
defaultGroup string
referenceType Enum account | quickQuote | quote | policy | transaction | invoice | underwritingFlag | payment
traversal Enum depthFirst | breadthFirst | none

optional
task TaskCreateRequest?