Search
K
Case Management

Get case documents

Retrieve the list of available document instances for the specified caseId.

get

Path Parameters

caseIdstringrequired

Case instance id

Response

application/json

documents retrieved

DocumentListInstance

idstring

Example:12345

namestring

Example:Identity_Document.pdf

documentNumberstring

Example:119299808

sourcestring

Example:onbase

urlstring

Example:http://dev.onbase.com/document/12345

updatedAtstring

Example:09-April-2023

fileTypestring

Example:NB Fix

documentUploadDatestring

Example:2024-10-04T13:16:45-05:00

additionalDataobject
eventRefarray[string]

Example:15ea7582-262f-4dfe-8a60-1e8b8e763fd4

get/case/v1/cases/{caseId}/document
 
application/json

Get case exceptions

Retrieve the list of available exception/NIGO instances for the specified caseId.

get

Path Parameters

caseIdstringrequired

Case instance id

Response

application/json

exceptions retrieved

ExceptionListInstance

idstring

Unique Identifier for Exception Instance

statusstring

Status of Exception Instance

Allowed values:NEWRESOLVED

exceptionRefIdstring

The exceptionRefId of the exception.

Example:NB.EM.068

exceptionTypestring

The exceptionType of the exception.

Example:Business Exception

categorystring

Category of Exception

reasonstring

Short description of Exception

detailedReasonstring

Detailed description of Exception

updatedAtstring

Last updated timestamp of Exception

taskIdListarray[string]unique-items

List of Task Identifier associated with Exception Instance

additionalDataobject
exceptionAdditionalDataarray[object]

Additional data related to the Exception.

Show Child Parameters
eventRefarray[string]

List of Events associated with Exception Instance

get/case/v1/cases/{caseId}/exception
 
application/json

Get case events

Retrieve the List of Event over the time applied on the specified caseId.

get

Query Parameters

fromTsinteger(int64)
toTsinteger(int64)
sourcestring

source

Path Parameters

caseIdstringrequired

Case instance id

Response

application/json

case events retrieved

EventTimeLineInstance

idstring

A unique identifier for the event instance.

sourcestring
eventNamestring

The name of the event that occurred.

eventGroupstring

The group to which this event belongs.

eventTsstring(date-time)

The timestamp when the event occurred.

correlationIdstring

An identifier used to correlate related cases.

payloadstring

The payload of the event, typically containing detailed information.

identifiersarray[object]

A list of identifiers associated with the event.

Show Child Parameters
get/case/v1/cases/{caseId}/event
 
application/json

Get event details

Retrieve the Details of an Event for specified eventId.

get

Path Parameters

eventIdstringrequired

Event Id

Response

application/json

event details retrieved

EventDetailInstance

idstring

Example:2ad51ecf-9923-437f-a6f0-70968e464cdb

correlationidstring

Example:20230314-M-101161

sourcestring

Example:ONBASE

specversionstring

Example:V1

typestring

Example:AckNBApplicationValidation

carrierstring

Example:CarrierName_1

datacontenttypestring

Example:application/json

timestring(date-time)
datastring

Example:{"businessKey":"20230314-M-101161","contractNum":"573005409","user":"ECMagent","CheckReceived":"Success","receivedDateTime":"2023-03-14T11:06:34.6979232-05:00","CorrelationID":"f3e98d05-1d9e-433f-b315-3b1eb0d03ed3"}

identifierarray[object]
get/case/v1/event/{eventId}
 
application/json

Create Case

Create or Find a Case for/By specified values

post

Body

application/json

Case details for creation

CaseCreateRequest

carrierstring

The carrier associated with the case.

Example:CarrierName_1

processstring

The process associated with the case.

Example:New Business

correlationIdstring

The correlationId associated with the case.

Example:f3e98d05-1d9e-433f-b315-3b1eb0d03ed3

processSubTypestring

A subtype of the process for the case.

Example:INCOMING_TRANSFER

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/v1/cases

Body

{ "carrier": "CarrierName_1", "process": "Renewal", "processSubType": "some-process-sub-type", "correlationId": "2f59c42a-99d0-42cf-90b4-dfe8bf9cbae9", "identifiers": [ { "identifier": "policyNumber", "value": "AU42046202" } ] }
 
application/json