CaseInstanceMethods
Methods¶
close()¶
close(
options?:CaseInstanceOperationOptions):Promise<OperationResponse<CaseInstanceOperationResponse>>
Closes/cancels this case instance
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
CaseInstanceOperationOptions |
Optional close options with comment |
Returns¶
Promise<OperationResponse<CaseInstanceOperationResponse>>
Promise resolving to operation result. With Case App routes, a case that has already
completed is rejected, and the result reports isCompleted.
getActionTasks()¶
getActionTasks<
T>(options?:T):Promise<TextendsHasPaginationOptions<T> ?PaginatedResponse<TaskGetResponse> :NonPaginatedResponse<TaskGetResponse>>
Gets human in the loop tasks associated with this case instance
Type Parameters¶
| Type Parameter | Default type |
|---|---|
T extends TaskGetAllOptions |
TaskGetAllOptions |
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
T |
Optional filtering and pagination options |
Returns¶
Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<TaskGetResponse> : NonPaginatedResponse<TaskGetResponse>>
Promise resolving to human in the loop tasks associated with the case instance
getExecutionHistory()¶
getExecutionHistory(
options?:CaseInstanceGetExecutionHistoryOptions):Promise<CaseInstanceExecutionHistoryResponse>
Gets execution history for this case instance
With Case App routes the response also carries the case id, the case summary and the details sections configured on the case app.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
CaseInstanceGetExecutionHistoryOptions |
Optional element-type filter |
Returns¶
Promise<CaseInstanceExecutionHistoryResponse>
Promise resolving to instance execution history
getSlaSummary()¶
getSlaSummary<
T>(options?:T):Promise<TextendsHasPaginationOptions<T> ?PaginatedResponse<SlaSummaryResponse> :NonPaginatedResponse<SlaSummaryResponse>>
Gets the SLA summary for this case instance. The default page size is 50, so only the top 50 items are returned when no pagination options are provided.
Type Parameters¶
| Type Parameter | Default type |
|---|---|
T extends Omit<CaseInstanceSlaSummaryOptions, "caseInstanceId"> |
Omit<CaseInstanceSlaSummaryOptions, "caseInstanceId"> |
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
T |
Optional time range filtering and pagination options |
Returns¶
Promise<T extends HasPaginationOptions<T> ? PaginatedResponse<SlaSummaryResponse> : NonPaginatedResponse<SlaSummaryResponse>>
Promise resolving to SLA summary items for this case instance
getStages()¶
getStages():
Promise<CaseGetStageResponse[]>
Gets stages and their associated tasks for this case instance
Returns¶
Promise<CaseGetStageResponse[]>
Promise resolving to an array of case stages with their tasks and status
getStagesSlaSummary()¶
getStagesSlaSummary():
Promise<CaseInstanceStageSLAResponse[]>
Gets the stages SLA summary for this case instance.
Returns¶
Promise<CaseInstanceStageSLAResponse[]>
Promise resolving to an array of stage SLA summary items for this case instance
getVariables()¶
getVariables(
options?:CaseInstanceGetVariablesOptions):Promise<CaseInstanceGetVariablesResponse>
Gets global variables for this case instance
Throws a ValidationError on an instance from Case App routes, which have no route for this
operation.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
CaseInstanceGetVariablesOptions |
Optional options including parentElementId to filter by parent element |
Returns¶
Promise<CaseInstanceGetVariablesResponse>
Promise resolving to variables response with elements and enriched global variables
pause()¶
pause(
options?:CaseInstanceOperationOptions):Promise<OperationResponse<CaseInstanceOperationResponse>>
Pauses this case instance
Throws a ValidationError on an instance from Case App routes, which have no route for this
operation.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
CaseInstanceOperationOptions |
Optional pause options with comment |
Returns¶
Promise<OperationResponse<CaseInstanceOperationResponse>>
Promise resolving to operation result
reopen()¶
reopen(
options:CaseInstanceReopenOptions):Promise<OperationResponse<CaseInstanceOperationResponse>>
Reopens this case instance from a specified element
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options |
CaseInstanceReopenOptions |
Reopen options containing stageId (the stage ID to resume from) and an optional comment |
Returns¶
Promise<OperationResponse<CaseInstanceOperationResponse>>
Promise resolving to operation result
resume()¶
resume(
options?:CaseInstanceOperationOptions):Promise<OperationResponse<CaseInstanceOperationResponse>>
Resumes this case instance
Throws a ValidationError on an instance from Case App routes, which have no route for this
operation.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
CaseInstanceOperationOptions |
Optional resume options with comment |
Returns¶
Promise<OperationResponse<CaseInstanceOperationResponse>>
Promise resolving to operation result
sendMessage()¶
sendMessage(
name:string,options?:CaseInstanceSendMessageOptions):Promise<void>
Sends a message to this case instance
Parameters¶
| Parameter | Type | Description |
|---|---|---|
name |
string |
The message name — a well-known CaseInstanceMessageName or a custom message name defined in the case model |
options? |
CaseInstanceSendMessageOptions |
Optional message options with itemData payload and reference override |
Returns¶
Promise<void>
Promise that resolves when the message is accepted