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
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():
Promise<CaseInstanceExecutionHistoryResponse>
Gets execution history for this case instance
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
pause()¶
pause(
options?:CaseInstanceOperationOptions):Promise<OperationResponse<CaseInstanceOperationResponse>>
Pauses this case instance
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
Parameters¶
| Parameter | Type | Description |
|---|---|---|
options? |
CaseInstanceOperationOptions |
Optional resume options with comment |
Returns¶
Promise<OperationResponse<CaseInstanceOperationResponse>>
Promise resolving to operation result