Search
K
Case Management

CaseSummary

object

Summary information about a case in a link relationship

idstring

The unique case identifier

Example:CA0000425395

statusstring

The current status of the case

Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDCANCELED

Example:IN_PROGRESS

caseGroupstring

The case group category

Example:NEW_BUSINESS

processstring

The business process associated with the case

Example:New Business

processSubTypestring

The sub-type of the business process

Example:Incoming Transfer

createdAtstring(date-time)

The timestamp when the case was created

Example:2025-01-05T10:30:00.000Z

updatedAtstring(date-time)

The timestamp when the case was last updated

Example:2025-01-05T14:45:30.000Z

Example

InvalidCaseResponse

object
statusCodeinteger(int32)

Example:404

timestampnumber
errorIdstring

Example:33c88eca-ad13-46cc-b14e-b7f82b4af541

messagestring

Example:Invalid case id - <caseId>

errorstring
Example

BadRequestResponse

object
statusCodeinteger(int32)

Example:400

timestampinteger(int64)

Example:1681395423438

errorIdstring

Example:0286d47a-7ad9-499c-8ca0-8f6634d236a3

messagestring

Example:status not found in the request

Example

TemplateMetadataModel

object

TaskRequest

object
idstring

Example:36be3d51-2246-4158-9feb-a29fe5bd0183

sourcestring

Example:Zinnia.OnBase

taskTypestring

Example:Suitability

statusstring

Example:NEW

scheduledReasonstring

Example:DOCUMENT_MISSING

scheduledDatestring(date-time)
cancellationReasonstring

Example:CASE_CANCELATION

mappedExceptionsarray[string]

Exceptions to be linked the task

Example:EX000000000188

mappedDocumentsarray[object]

Metadata for a document mapped to a specific task in the system.

Show Child Parameters
dataobject

Example:{}

linkedTasksarray[object]

Metadata for a linked tasks to a specific task in the system.

Show Child Parameters
Example