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 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

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?
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 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