caseIdstringrequired
Case instance id
Example:CA0000360227
Get Case Detail
Retrieve the case instance details using the system identifier (caseId).
get
Path Parameters
Response
application/json
Response
application/json
Case details retrieved
CaseInstance
_idstring
Unique identifier for the case instance.
templateIdstring
Identifier for the template associated with the case instance.
carrierstring
Name of the carrier associated with transaction/case.
processstring
Name of the process/transaction type for case.
caseGroupstring
Name of the caseGroup type for case.
parentInstanceIdstring
Identifier for the parent case instance, if applicable.
correlationIdstring
Identifier used for correlating events as they received.
caseStatusstring
Current status of the case instance.
Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDCANCELED
caseResultstring
Contextual information regarding the caseStatus especially when case is marked as canceled
caseResultDetailstring
Detailed contextual information regarding the caseStatus
primaryboolean
Indicates if this is the primary case instance.
escalatedboolean
Indicates if the case instance has been escalated.
caseProcessingDetailsarray[object]
List of detail sections for case processing.
Show Child Parameters
linkDetailsobject
Details about linked case instances.
Show Child Parameters
processSubTypestring
Subtype of the process/transaction associated with the case.
policyNumberstring
Policy number/Contract No associated to the case instance.
planCodestring
PlanCode associated to the case instance.
productNamestring
Name of the product associated with Contract/Policy.
documentsarray[object]DEPRECATED
List of document associated to the case. (DEPRECATED)
Show Child Parameters
exceptionsarray[object]
List of all exceptions/NIGOs associated related to the case.
Show Child Parameters
notesarray[object]
List of all note associated to the case.
Show Child Parameters
tasksarray[object]
List of all tasks associated to the case irrespective of different stage/steps.
Show Child Parameters
mappedTasksarray[string]
List of Task Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
mappedExceptionsarray[string]
List of Exception/NIGO Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
mappedNotesarray[string]
List of Notes Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
mappedDocumentsarray[string]
List of Exception/NIGO Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
partiesarray[object]
List of individuals/parties associated with the contract/policy related to the case
Show Child Parameters
identifiersarray[object]
An object representing an identifier and its corresponding value.
Show Child Parameters
additionalData
One OfDEPRECATED
Additional data related to the case. (DEPRECATED)
CaseAdditionalDataNBobject
Show Child Parameters
stagesarray[object]
List of stages representing milestone in the journey of a case/transaction.
Show Child Parameters
createdAtstring(date-time)
Timestamp when the case instance was created, derived from the time of the initial event.
updatedAtstring(date-time)
Timestamp when the case instance was last updated, derived from the time of the latest event.
systemUpdatedDtstring(date)
The date when the system was last updated.
deletedboolean
Indicates if the case instance has been deleted.
get/case/v2/cases/{caseId}
Authentication
Path Parameters
application/json
Escalate Case
Escalate a case to a higher priority level or management tier for urgent attention.
patch
Path Parameters
caseIdstringrequired
Case instance id
Example:CA0000360227
Body
application/json
Body
application/json
CaseEscalationRequest
escalatedbooleanrequired
Whether the case should be escalated or de-escalated
Example:true
Response
application/json
Response
application/json
Case escalated successfully
CaseInstance
_idstring
Unique identifier for the case instance.
templateIdstring
Identifier for the template associated with the case instance.
carrierstring
Name of the carrier associated with transaction/case.
processstring
Name of the process/transaction type for case.
caseGroupstring
Name of the caseGroup type for case.
parentInstanceIdstring
Identifier for the parent case instance, if applicable.
correlationIdstring
Identifier used for correlating events as they received.
caseStatusstring
Current status of the case instance.
Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDCANCELED
caseResultstring
Contextual information regarding the caseStatus especially when case is marked as canceled
caseResultDetailstring
Detailed contextual information regarding the caseStatus
primaryboolean
Indicates if this is the primary case instance.
escalatedboolean
Indicates if the case instance has been escalated.
caseProcessingDetailsarray[object]
List of detail sections for case processing.
Show Child Parameters
linkDetailsobject
Details about linked case instances.
Show Child Parameters
processSubTypestring
Subtype of the process/transaction associated with the case.
policyNumberstring
Policy number/Contract No associated to the case instance.
planCodestring
PlanCode associated to the case instance.
productNamestring
Name of the product associated with Contract/Policy.
documentsarray[object]DEPRECATED
List of document associated to the case. (DEPRECATED)
Show Child Parameters
exceptionsarray[object]
List of all exceptions/NIGOs associated related to the case.
Show Child Parameters
notesarray[object]
List of all note associated to the case.
Show Child Parameters
tasksarray[object]
List of all tasks associated to the case irrespective of different stage/steps.
Show Child Parameters
mappedTasksarray[string]
List of Task Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
mappedExceptionsarray[string]
List of Exception/NIGO Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
mappedNotesarray[string]
List of Notes Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
mappedDocumentsarray[string]
List of Exception/NIGO Identifiers which directly linked to Case (RESERVED FOR FUTURE SCOPE)
partiesarray[object]
List of individuals/parties associated with the contract/policy related to the case
Show Child Parameters
identifiersarray[object]
An object representing an identifier and its corresponding value.
Show Child Parameters
additionalData
One OfDEPRECATED
Additional data related to the case. (DEPRECATED)
CaseAdditionalDataNBobject
Show Child Parameters
stagesarray[object]
List of stages representing milestone in the journey of a case/transaction.
Show Child Parameters
createdAtstring(date-time)
Timestamp when the case instance was created, derived from the time of the initial event.
updatedAtstring(date-time)
Timestamp when the case instance was last updated, derived from the time of the latest event.
systemUpdatedDtstring(date)
The date when the system was last updated.
deletedboolean
Indicates if the case instance has been deleted.
patch/case/v2/cases/{caseId}/escalate
Authentication
Path Parameters
Body
{
"escalated": true
}
application/json
Get task links
Retrieve the list of available task instances for the specified caseId.
get
Path Parameters
caseIdstringrequired
Case instance id
Response
application/json
Response
application/json
task link retrieved
TaskLinkInstanceList
idstring
A Unique identifier of Task in Task Management
taskTypestring
Business friendly type for Task
labelstring
Business friendly Label for Task
assigneestring
User currently assigned to the task
statusstring
Status of Task (STATUS DISCUSSION IN PROGRESS)
Allowed values:OPENCLOSEDNEWCOMPLETEDCOMPLETE
taskNamestring
task name of the task
queuestring
Queue to which the task is assigned
createdAtstring
Timestamp when the Task was created
updatedAtstring
Timestamp when the Task was last updated
eventRefarray[string]
List of Events associated with Note Instance
externalTaskIdstring
The identifier how an external system understand it for example used to map onbase taskId
notesIdListarray[string]
List of Note identifiers associated to Task
get/case/v1/cases/{caseId}/taskLink
Authentication
Path Parameters
application/json
Get notes
Retrieve the list of available note instances for the specified caseId.
get
Path Parameters
caseIdstringrequired
Case instance id
Response
application/json
Response
application/json
notes retrieved
NoteListInstance
idstring
A unique identifier of Note
notestring
The Text content of Note
authorstring
Author of note
internalboolean
Indicates whether the item is internal or not.
createdAtstring
The timestamp of Note been created
updatedAtstring
The timestamp of Note been updated
Example:09-April-2023
descstring
Description of note
additionalDataobject
eventRefarray[string]
List of Events associated with Note Instance
get/case/v1/cases/{caseId}/note
Authentication
Path Parameters
application/json
Get case stages
Retrieve the list of available stage for the specified caseId.
get
Path Parameters
caseIdstringrequired
Case instance id
Response
application/json
Response
application/json
stages retrieved
StageListInstance
idstring
Unique identifier for the stage instance.
labelstring
Business Friendly label for the stage instance.
stageStatusstring
Current status of the stage instance.
Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDNOT_STARTED
mappedTasksarray[string]
List of identifiers for tasks mapped to this stage (RESERVED FOR FUTURE SCOPE).
mappedNotesarray[string]
List of identifiers for notes mapped to this stage (RESERVED FOR FUTURE SCOPE).
stepsarray[object]
List of step instances that make up this stage.
Show Child Parameters
createdAtstring(date-time)
Timestamp when the stage instance was created.
get/case/v1/cases/{caseId}/stage
Authentication
Path Parameters
application/json