ServerErrorResponse
objectExample:500
Example:1681395423438
Example:0286d47a-7ad9-499c-8ca0-8f6634d236a3
Example:Failed to process request
CaseModuleErrorResponse
objectCanonical error envelope for Case module.
High-level error message.
Example:Invalid link type
Trace/correlation id for debugging (derived from requestId or X-Correlation-Id).
Example:0286d47a-7ad9-499c-8ca0-8f6634d236a3
Detailed message including error code context.
Example:[INVALID_LINK_TYPE] Invalid linkType: foo. Valid values are: CHILD, DUPLICATE, RELATED
Epoch timestamp in milliseconds.
Example:1681395423438
CaseLinkDetailsResponse
objectResponse containing a list of linked cases for a given case
Represents a link between two cases
Default:[]
Show Child Parameters
LinkedCaseRecord
objectRepresents a link between two cases
Summary information about a case in a link relationship
Show Child Parameters
Summary information about a case in a link relationship
Show Child Parameters
The type of relationship between the cases
Allowed values:CHILDRELATEDDUPLICATE
Example:CHILD
The reason for linking the cases
Example:Child case created for policy amendment
Represents a link between two cases
Default:[]
Show Child Parameters
CaseSummary
objectSummary information about a case in a link relationship
The unique case identifier
Example:CA0000425395
The current status of the case
Allowed values:IN_PROGRESSEXCEPTIONCOMPLETEDCANCELED
Example:IN_PROGRESS
The case group category
Example:NEW_BUSINESS
The business process associated with the case
Example:New Business
The sub-type of the business process
Example:Incoming Transfer
The timestamp when the case was created
Example:2025-01-05T10:30:00.000Z
The timestamp when the case was last updated
Example:2025-01-05T14:45:30.000Z