caseIdstringrequired
The ID of the case to fetch linked cases for
Example:CA0000356493
Fetch linked cases by case ID
get
Path Parameters
Response
application/json
Response
application/json
A set of linked cases
Represents a linked case with its associated details
caseIdstring
The unique identifier of the case.
processstring
The process associated with the case.
processSubTypestring
A subtype of the process for the case.
primaryboolean
Indicates if this is the primary case instance.
linkedReasonstring
Reason for linking the cases.
caseStatusstring
Current status of the case instance.
Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDCANCELED
get/case/v1/cases/{caseId}/linkedCases
Authentication
Path Parameters
application/json
Task Instance (Legacy)
Legacy - Manages tasks based on cases. Used for Withdrawal/Renewal. No further changes accepted.
Create Task for case
DEPRECATEDCreate task and associate with a case
post
Path Parameters
caseIdstringrequired
Case instance id
Body
application/json
Body
application/json
TaskCreateRequest
taskTypestring
Example:RenewalTask
carrierstring
Example:CarrierName_1
data
One OfRenewalTaskDataobject
Show Child Parameters
Response
application/json
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
post/case/v1/cases/{caseId}/tasks
Authentication
Path Parameters
Body
{
"taskType": "RenewalTask",
"carrier": "CarrierName_1"
}
application/json
Get Tasks
DEPRECATEDGet list of tasks for a case id
get
Path Parameters
caseIdstringrequired
Case instance id
Response
application/json
Response
application/json
task instance retrieved
TaskSummaryList
dataarray[object]
Show Child Parameters
get/case/v1/cases/{caseId}/tasks
Authentication
Path Parameters
application/json
Update Task
DEPRECATEDUpdates task for a given case
put
Path Parameters
caseIdstringrequired
Case instance id
taskIdstringrequired
Task instance id
Body
application/json
Body
application/json
TaskUpdateRequest
taskTypestring
Example:WithdrawalTask
carrierstring
Example:CarrierName_2
statusstring
Example:DRAFT
data
One OfWithdrawalTaskDataobject
Show Child Parameters
Response
application/json
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}
Authentication
Path Parameters
Body
{}
application/json