Search
K
Case Management

CaseCreateRequest

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

FormMetadataRequest

object
carrierstring

Carrier for the metadata.

Example:CarrierName_1

processstring

Process for the metadata

Example:New Business

taskTypestring

Task type for the metadata

Example:SUITABILITY_REVIEW

formSchemaobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
uiSchemaobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
schemaContentobject

Additional data related to the task

Example:{}

* Additional properties are allowed.
Example

CaseCreateRequestV2

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

CaseEscalationRequest

object
escalatedbooleanrequired

Whether the case should be escalated or de-escalated

Example:true

Example

RenewalTaskData

object
documentNumberstring

Example:20230405-M-350385

sourcestring

Example:SupportTool

contractNumstring

Example:571016565

userIdstring

Example:abc121243

onbaseCaseIdstring

Example:9280926

productNamestring

Example:CarrierName_1MUTUAL STABLE VOYAGE

clientCodestring

Example:CarrierName_1

taskTypestring

Example:RenewalTransfer

subsequentGuaranteePeriodstring

Example:3Year

goodOrderDatestring(date-time)
renewalRequestSignDatestring(date-time)
ownerInformationarray[object]
Show Child Parameters
documentReceivedDatestring(date-time)
Example