Search
K
Case Management

Get case stages

Retrieve the list of available stage for the specified caseId.

get

Path Parameters

caseIdstringrequired

Case instance id

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

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