Search
K
Case Management

Create Case

Create or Find a Case for/By specified values

post

Body

application/json

Case details for creation

CaseCreateRequestV2

correlationidstring

The correlationId associated with the case.

Example:218d8992-3783-42ac-b59a-66cbc36adaab

sourcestring

The source associated with the case.

Example:Zinnia.OnBase

carrierstring

The carrier associated with the case.

Example:CarrierName_1

specversionstring

The specversion associated with the case.

Example:V1

typestring

The type associated with the case.

Example:CaseCreated

datacontenttypestring

The datacontenttype associated with the case.

Example:application/json

dataschemastring

The dataschema associated with the case.

Example:jsondata

subjectstring

The subject associated with the case.

Example:subject

sourcelocatorstring

The sourcelocator associated with the case.

Example:sourcelocator

datastring

The data associated with the case.

Example:[{"clientCode":"CarrierName_1","documentHandle":"206426781","documentType":"Incoming Transfer","documentNumber":"20240801-EM-426781","caseId":"156779803","caseStatus":"CP - New","contractNumber":"","caseCreatedOn":"2024-08-01T15:57:18-05:00","caseUpdatedOn":"2024-08-01T15:57:18-05:00","transactionType":"INCOMING TRANSFER","processType":"New Business","batchID":"13326094","productName":"CarrierName_1MUTUAL STABLE VOYAGE","correlationId":"e18d8992-3783-42ac-b59a-66cbc36adaab"}]

dataBase64string

The dataBase64 associated with the case.

Example:jsondata

identifiersarray[object]

An object representing an identifier and its corresponding value.

Show Child Parameters

Response

application/json

Case Created

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
additionalDataOne Of
DEPRECATED

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.

post/case/v2/cases

Body

{ "correlationid": "218d8992-3783-42ac-b59a-66cbc36adaab", "source": "Zinnia.OnBase", "carrier": "CarrierName_1", "type": "CaseCreated", "datacontenttype": "application/json", "data": "[{\"clientCode\":\"CarrierName_1\",\"documentHandle\":\"206426781\",\"documentType\":\"Incoming Transfer\",\"documentNumber\":\"20240801-EM-426781\",\"caseId\":\"156779803\",\"caseStatus\":\"CP - New\",\"contractNumber\":\"\",\"caseCreatedOn\":\"2024-08-01T15:57:18-05:00\",\"caseUpdatedOn\":\"2024-08-01T15:57:18-05:00\",\"transactionType\":\"INCOMING TRANSFER\",\"processType\":\"New Business\",\"batchID\":\"13326094\",\"productName\":\"CarrierName_1MUTUAL STABLE VOYAGE\",\"correlationId\":\"e18d8992-3783-42ac-b59a-66cbc36adaab\"}]", "identifiers": [ { "identifier": "caseID", "value": "156779801" }, { "identifier": "documentNumber", "value": "20240801-EM-426782" } ] }
 
application/json

Get case metadata

Get metadata from the template for the provided caseid

get

Path Parameters

caseIdstringrequired

Case Id

Response

application/json

case metadata retrieved

TemplateMetadataModel

TemplateMetadataModelobject
get/case/v1/cases/{caseId}/metadata
 
application/json

Fetch linked cases by case ID

get

Path Parameters

caseIdstringrequired

The ID of the case to fetch linked cases for

Example:CA0000356493

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
 
application/json

Task Instance (Legacy)

Legacy - Manages tasks based on cases. Used for Withdrawal/Renewal. No further changes accepted.

Create Task for case

DEPRECATED

Create task and associate with a case

post

Path Parameters

caseIdstringrequired

Case instance id

Body

application/json

TaskCreateRequest

taskTypestring

Example:RenewalTask

carrierstring

Example:CarrierName_1

dataOne Of
RenewalTaskDataobject
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

post/case/v1/cases/{caseId}/tasks

Body

{ "taskType": "RenewalTask", "carrier": "CarrierName_1" }
 
application/json