Search
K
Case Management

Update Task

DEPRECATED

Updates task for a given case

put

Path Parameters

caseIdstringrequired

Case instance id

taskIdstringrequired

Task instance id

Body

application/json

TaskUpdateRequest

taskTypestring

Example:WithdrawalTask

carrierstring

Example:CarrierName_2

statusstring

Example:DRAFT

dataOne Of
WithdrawalTaskDataobject
Show Child Parameters

Response

application/json

Renewal task created

TaskSummary

taskIdstring(23432-234234-324234-5345434)
caseIdstring(34545-543453-323223-534522)
taskTypestring

Example:RenewalTask

statusstring

Example:Pending

sourcestring

Example:SupportTool

carrierstring

Example:CarrierName_1

assignedTostring

Example:operator-3

createdDatestring(date-time)
createdBystring

Example:operator-1

updatedDatestring(date-time)
updatedBystring

Example:operator-2

put/case/v1/cases/{caseId}/tasks/{taskId}

Body

{}
 
application/json

Get Task details

DEPRECATED

Get Task details from a case with task id

get

Path Parameters

caseIdstringrequired

Case instance id

taskIdstringrequired

Task instance id

Response

application/json

task details retrieved

TaskInstance

taskIdstring(23432-234234-324234-5345434)
caseIdstring(34545-543453-323223-534522)
taskTypestring

Example:RenewalTask

statusstring

Example:Pending

sourcestring

Example:SupportTool

carrierstring

Example:CarrierName_1

assignedTostring

Example:operator-3

createdDatestring(date-time)
createdBystring

Example:operator-1

updatedDatestring(date-time)
updatedBystring

Example:operator-2

dataOne Of
RenewalTaskDataobject
Show Child Parameters
get/case/v1/cases/{caseId}/tasks/{taskId}
 
application/json

Get Task

DEPRECATED

Get Task

get

Path Parameters

taskIdstringrequired

Task instance id

Response

application/json

task instance retrieved

TaskInstance

taskIdstring(23432-234234-324234-5345434)
caseIdstring(34545-543453-323223-534522)
taskTypestring

Example:RenewalTask

statusstring

Example:Pending

sourcestring

Example:SupportTool

carrierstring

Example:CarrierName_1

assignedTostring

Example:operator-3

createdDatestring(date-time)
createdBystring

Example:operator-1

updatedDatestring(date-time)
updatedBystring

Example:operator-2

dataOne Of
RenewalTaskDataobject
Show Child Parameters
get/case/v1/tasks/{taskId}
 
application/json

Task Instance (Task Management)

Manages tasks based on cases. Implemented using Zinnia Live Task management framework.

Task Management - Search tasks

Search tasks by case id for provided criteria

post

Body

application/json
caseIdstring
taskTypestring
sortBystring

Allowed values:updatedAtcreatedAt

sortDirectionstring

Allowed values:ascdesc

offsetinteger(int32)
limitinteger(int32)

Response

application/json

tasks retrieved for provided search criterias

dataarray[object]

Represents the details of the task, including exceptions, data, and schema.

Show Child Parameters
countinteger(int32)

Example:1

offsetinteger(int32)

Example:0

limitinteger(int32)

Example:10

totalinteger(int32)

Example:1

statusinteger(int32)

Example:200

messagestring

Example:Successfully retrieved data!

post/case/v1/tasks/search

Body

{ "caseId": "CA0000005579", "taskType": "Suitability", "sortBy": "createdAt", "sortDirection": "asc", "offset": 0, "limit": 20 }
 
application/json