Search
K
Case Management

Get task links

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

get

Path Parameters

caseIdstringrequired

Case instance id

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
 
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

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
 
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

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