Work Management API

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

Get TaskgetTask

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:Task

Security Group:tasks

Permission:

read

Task

Required properties

Property	Type	Description
`locator`	`ulid`
`taskState`	`Enum active \| pastDeadline \| completed \| cancelled`
`category`	`string`
`type`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`
`references`	`TaskReference[]`
`underwritingFlagLocators`	`ulid[]`

Optional properties

Property	Type	Description
`assignedTo`	`uuid?`
`completedAt`	`datetime?`
`completedBy`	`uuid?`
`deadlineTime`	`datetime?`
`description`	`string?`
`source`	`string?`
`tag`	`string?`
`taskNumber`	`string?`
`updatedAt`	`datetime?`
`updatedBy`	`uuid?`

Add Task

Add TaskaddTask

POST/work-management/{tenantLocator}/tasks

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:TaskCreateRequest

Response:Task

Security Group:tasks

Permission:

write

TaskCreateRequest

Required properties

Property	Type	Description
`type`	`string`
`references`	`TaskReference[]`
`underwritingFlagLocators`	`ulid[]`

Optional properties

Property	Type	Description
`assignedTo`	`uuid?`
`deadlineTime`	`datetime?`
`description`	`string?`
`source`	`string?`
`tag`	`string?`

TaskCreationResponse

Required properties

Property	Type	Description
`taskLocator`	`ulid`
`status`	`Enum succeeded \| failed`

Update Task

Update TaskupdateTask

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:TaskUpdateRequest

Response:Task

Security Group:tasks

Permission:

write

TaskUpdateRequest

Required properties

Property	Type	Description
`addReferences`	`TaskReference[]`
`addUnderwritingFlags`	`ulid[]`
`removeReferences`	`TaskReference[]`
`removeUnderwritingFlags`	`ulid[]`

Optional properties

Property	Type	Description
`deadlineTime`	`datetime?`
`description`	`string?`
`source`	`string?`
`tag`	`string?`

Activate Task

Activate TaskactivateTask

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:Task

Security Group:tasks

Permission:

write

Assign Task

Assign TaskassignTask

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`userLocator`	path	`uuid`	Yes

Response:Task

Security Group:tasks

Permission:

write

Unassign Task

Unassign TaskunassignTask

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:Task

Security Group:tasks

Permission:

write

Cancel Task

Cancel TaskcancelTask

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:Task

Security Group:tasks

Permission:

write

Complete Task

Complete TaskcompleteTask

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:Task

Security Group:tasks

Permission:

write

Fetch Tasks With Number

Fetch Tasks With NumberfetchTasksWithNumber

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`taskNumber`	path	`string`	Yes

Response:Task[]

Security Group:tasks

Permissions:

read,list

Generate Task Number

Generate Task NumbergenerateTaskNumber

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:Task

Security Group:tasks

Permission:

write

List Tasks

List TaskslistTasks

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseTask

Security Group:tasks

Permission:

read

List All Tasks

List All TaskslistAllTasks

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseTask

Security Group:tasks

Permission:

read

List Assigned Tasks

List Assigned TaskslistAssignedTasks

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`userLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseTask

Security Group:tasks

Permission:

read

ListPageResponseTask

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`Task[]`

List Task History

List Task HistorylistTaskHistory

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseTask

Security Group:tasks

Permission:

read

Search Tasks

Search TaskssearchTasks

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`referenceType`	path	`Enum account \| quickQuote \| quote \| policy \| transaction \| invoice \| underwritingFlag \| payment \| quoteGroup \| inquiry`	Yes
`referenceLocator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseTask

Security Group:tasks

Permission:

read

Set Task Number

Set Task NumbersetTaskNumber

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`taskNumber`	query	`string`	Yes

Response:Task

Security Group:tasks

Permission:

write

TaskReference

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`referenceType`	`Enum account \| quickQuote \| quote \| policy \| transaction \| invoice \| underwritingFlag \| payment \| quoteGroup \| inquiry`

User Associations

Get User Association

Get User AssociationgetUserAssociation

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:UserAssociation

Security Group:user-associations

Permission:

read

UserAssociation

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceLocator`	`ulid`
`userLocator`	`uuid`
`userAssociationState`	`Enum active \| completed \| disassociated \| discarded`
`referenceType`	`Enum account \| quickQuote \| quote \| policy \| transaction \| invoice \| underwritingFlag \| payment \| quoteGroup \| inquiry`
`userAssociationRole`	`string`
`createdAt`	`datetime`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`updatedAt`	`datetime?`
`updatedBy`	`uuid?`

Make User Association

Make User AssociationmakeUserAssociation

POST/work-management/{tenantLocator}/userAssociations

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:UserAssociationCreateRequest

Response:UserAssociation

Security Group:user-associations

Permission:

write

UserAssociationCreateRequest

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`userLocator`	`uuid`
`referenceType`	`Enum account \| quickQuote \| quote \| policy \| transaction \| invoice \| underwritingFlag \| payment \| quoteGroup \| inquiry`
`userAssociationRole`	`string`

Complete User Association

Complete User AssociationcompleteUserAssociation

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`userAssociationLocator`	path	`ulid`	Yes

Response:UserAssociation

Security Group:user-associations

Permission:

write

Uncomplete User Association

Uncomplete User AssociationuncompleteUserAssociation

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`userAssociationLocator`	path	`ulid`	Yes

Response:UserAssociation

Security Group:user-associations

Permission:

write

Disassociate User Association

Disassociate User AssociationdisassociateUserAssociation

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`userAssociationLocator`	path	`ulid`	Yes

Response:UserAssociation

Security Group:user-associations

Permission:

write

List User Association History

List User Association HistorylistUserAssociationHistory

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseUserAssociation

Security Group:user-associations

Permission:

read

ListPageResponseUserAssociation

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`UserAssociation[]`

List User User Associations History

List User User Associations HistorylistUserUserAssociationsHistory

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`userLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseUserAssociation

Security Group:user-associations

Permission:

read

User Qualifications

Get Qualifications

Get QualificationsgetQualifications

GET/work-management/{tenantLocator}/qualifications

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Response:map<string, string[]>

Security Group:qualifications

Permission:

read

Fetch Users for a Qualification

Fetch Users for a QualificationfetchUsersQualifications

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`category`	path	`string`	Yes
`level`	path	`string`	Yes

Response:UserQualification[]

Security Group:qualifications

Permission:

read

UserQualification

Required properties

Property	Type	Description
`userLocator`	`uuid`
`category`	`string`
`level`	`string`

Get User Qualifications

Get User QualificationsgetUserQualifications

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`userLocator`	path	`uuid`	Yes

Response:map<string, string>

Security Group:qualifications

Permission:

read

Update User Qualifications

Update User QualificationsupdateUserQualifications

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`userLocator`	path	`uuid`	Yes

Request:QualificationsUpdateRequest

Response:map<string, string>

Security Group:qualifications

Permission:

write

QualificationsUpdateRequest

Required properties

Property	Type	Description
`addQualifications`	`map<string, string>`
`removeQualifications`	`map<string, string>`

Workgroups

Create Workgroup

Create WorkgroupcreateWorkgroup

POST/work-management/{tenantLocator}/workgroups

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:WorkgroupCreateRequest

Response:WorkgroupResponse

Security Group:workgroups

Permission:

write

Get Workgroup

Get WorkgroupgetWorkgroup

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`workgroupLocator`	path	`ulid`	Yes

Response:WorkgroupResponse

Security Group:workgroups

Permission:

read

List Workgroups

List WorkgroupslistWorkgroups

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`user`	query	`uuid?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseWorkgroupResponse

Security Group:workgroups

Permissions:

read,list

Patch Workgroup

Patch WorkgrouppatchWorkgroup

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`workgroupLocator`	path	`ulid`	Yes

Request:WorkgroupPatchRequest

Response:WorkgroupResponse

Security Group:workgroups

Permission:

write

Discard Workgroup

Discard WorkgroupdiscardWorkgroup

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`workgroupLocator`	path	`ulid`	Yes

Response:WorkgroupResponse

Security Group:workgroups

Permission:

write

Auto-Assign

Auto-AssignautoAssign

POST/work-management/{tenantLocator}/assignments

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:AutoAssignmentCreateRequest

Response:AutoAssignmentResponse

Security Group:assignments

Permission:

write

WorkgroupCreateRequest

Required properties

Property	Type	Description
`name`	`string`
`subgroups`	`ulid[]`
`users`	`uuid[]`

Optional properties

Property	Type	Description
`parentLocator`	`ulid?`
`region`	`string?`
`tag`	`string?`

WorkgroupResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`name`	`string`
`workgroupState`	`Enum active \| discarded`
`createdAt`	`datetime`
`createdBy`	`uuid`
`entities`	`ulid[]`
`subgroups`	`WorkgroupResponse[]`
`tasks`	`ulid[]`
`users`	`uuid[]`

Optional properties

Property	Type	Description
`region`	`string?`
`parent`	`ulid?`
`tag`	`string?`

ListPageResponseWorkgroupResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`WorkgroupResponse[]`

WorkgroupPatchRequest

Required properties

Property	Type	Description
`empty`	`boolean`
`removeSubgroups`	`ulid[]`
`removeUsers`	`uuid[]`
`setSubgroups`	`ulid[]`
`setUsers`	`uuid[]`

Optional properties

Property	Type	Description
`parentLocator`	`ulid?`
`region`	`string?`
`name`	`string?`
`tag`	`string?`

AutoAssignmentCreateRequest

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`referenceType`	`Enum account \| quickQuote \| quote \| policy \| transaction \| invoice \| underwritingFlag \| payment \| quoteGroup \| inquiry`

Optional properties

Property	Type	Description
`taskLocator`	`ulid?`
`workgroupLocator`	`ulid?`
`assignToGroup`	`Enum? never \| ifNotAssigned \| always`
`associationRole`	`string?`
`task`	`TaskCreateRequest?`
`traversal`	`Enum? depthFirst \| breadthFirst \| none`

AutoAssignmentResponse

Required properties

Property	Type	Description
`assignedUserLocator`	`uuid`
`assignedWorkgroupLocator`	`ulid`
`associationLocator`	`ulid`
`taskLocator`	`ulid`

Workplans

Create Workplan

Create WorkplancreateWorkplan

POST/work-management/{tenantLocator}/workplans

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes

Request:WorkplanCreateRequest

Response:Workplan

Security Group:workplans

Permission:

write

Get Workplan

Get WorkplangetWorkplan

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:Workplan

Security Group:workplans

Permission:

read

List Workplans

List WorkplanslistWorkplans

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseWorkplan

Security Group:workplans

Permission:

read

Patch Workplan

Patch WorkplanpatchWorkplan

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:WorkplanPatchRequest

Response:Workplan

Security Group:workplans

Permission:

write

Discard Workplan

Discard WorkplandiscardWorkplan

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:Workplan

Security Group:workplans

Permission:

write

WorkplanCreateRequest

Required properties

Property	Type	Description
`name`	`string`
`items`	`WorkplanItemRequest[]`

Optional properties

Property	Type	Description
`defaultGroup`	`string?`

Workplan

Required properties

Property	Type	Description
`locator`	`ulid`
`name`	`string`
`workplanState`	`Enum active \| discarded`
`createdAt`	`datetime`
`createdBy`	`uuid`
`items`	`WorkplanItem[]`

Optional properties

Property	Type	Description
`defaultGroup`	`string?`

WorkplanItem

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceLocator`	`ulid`
`assignToGroup`	`Enum never \| ifNotAssigned \| always`
`referenceType`	`Enum account \| quickQuote \| quote \| policy \| transaction \| invoice \| underwritingFlag \| payment \| quoteGroup \| inquiry`
`traversal`	`Enum depthFirst \| breadthFirst \| none`

Optional properties

Property	Type	Description
`associationRole`	`string?`
`defaultGroup`	`string?`
`task`	`TaskCreateRequest?`

ListPageResponseWorkplan

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`Workplan[]`

WorkplanPatchRequest

Required properties

Property	Type	Description
`addItems`	`WorkplanItemRequest[]`
`removeItems`	`ulid[]`

Optional properties

Property	Type	Description
`name`	`string?`
`defaultGroup`	`string?`

WorkplanItemRequest

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`assignToGroup`	`Enum never \| ifNotAssigned \| always`
`associationRole`	`string`
`defaultGroup`	`string`
`referenceType`	`Enum account \| quickQuote \| quote \| policy \| transaction \| invoice \| underwritingFlag \| payment \| quoteGroup \| inquiry`
`traversal`	`Enum depthFirst \| breadthFirst \| none`

Optional properties

Property	Type	Description
`task`	`TaskCreateRequest?`

Work Management API

On this page