GetCase

typed block

Searches all existing cases with the provided customer ID. Add request fields to filter by case fields. Specify the case fields to be returned in the response to persist in the context.

Factories

`GetCase`

GetCase() -> GetCaseHandle

Construct a fresh GetCase block with an auto-generated id.

Use this when authoring from scratch, the runtime picks a UUID automatically.

`GetCase`

GetCase(id: String) -> GetCaseHandle

Construct a GetCase block with an operator-supplied id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier, typically a Connect UUID restored by `decompile` so round-trips stay byte-stable.

Methods

`link_contact_to_case`

link_contact_to_case(value: String) -> GetCaseHandle

Set the LinkContactToCase parameter. "true" or "false", If set to true, cases will open automatically when the agent accepts the contact.

Parameter	Type	Required	Description
`value`	`String`	yes	"true" or "false", If set to true, cases will open automatically when the agent accepts the contact.

`get_last_updated_case`

get_last_updated_case(value?: String) -> GetCaseHandle

Set the GetLastUpdatedCase parameter. "true" or "false", You can specify to get only the last updated case for any search criteria.

Parameter	Type	Required	Description
`value`	`String`	no	"true" or "false", You can specify to get only the last updated case for any search criteria.

`customer_id`

customer_id(value?: String) -> GetCaseHandle

Set the CustomerId parameter. "Customer's Id", Search all cases for this customer Id.

Parameter	Type	Required	Description
`value`	`String`	no	"Customer's Id", Search all cases for this customer Id.

`case_request_fields`

case_request_fields(value?: String) -> GetCaseHandle

Set the CaseRequestFields parameter. An optional map of cases request fields. Keys should be fields from Cases domain. Values can be static or dynamic.

Parameter	Type	Required	Description
`value`	`String`	no	An optional map of cases request fields. Keys should be fields from Cases domain. Values can be static or dynamic.

`case_response_fields`

case_response_fields(value?: String) -> GetCaseHandle

Set the CaseResponseFields parameter. An optional list of field names that should be persisted in the case namespace.

Parameter	Type	Required	Description
`value`	`String`	no	An optional list of field names that should be persisted in the case namespace.

`next`

next(target: Handle) -> GetCaseHandle

Wire the success-path transition. Substitutes the target's auto-generated UUID into the wire Transitions.NextAction slot.

Parameter	Type	Required	Description
`target`	`Handle`	yes	The block to route to once this block completes successfully.

`on_no_matching`

on_no_matching(target: Handle) -> GetCaseHandle

Wire an error transition for NoMatchingError: An error was encountered while trying to find the case. This may be due to a system error or how Get case is configured.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoMatchingError`. An error was encountered while trying to find the case. This may be due to a system error or how Get case is configured.

`on_contact_not_linked`

on_contact_not_linked(target: Handle) -> GetCaseHandle

Wire an error transition for ContactNotLinked: If you specify to link the contact to case, then this error branch will appear. It might be that the contact was not linked after the case is retrieved (partial success/partial failure). If this happens, then the flow will follow this branch.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `ContactNotLinked`. If you specify to link the contact to case, then this error branch will appear. It might be that the contact was not linked after the case is retrieved (partial success/partial failure). If this happens, then the flow will follow this branch.

`on_multiple_found`

on_multiple_found(target: Handle) -> GetCaseHandle

Wire an error transition for MultipleFound: Multiple cases are found with the search criteria.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `MultipleFound`. Multiple cases are found with the search criteria.

`on_none_found`

on_none_found(target: Handle) -> GetCaseHandle

Wire an error transition for NoneFound: No cases are found with the search criteria.

Parameter	Type	Required	Description
`target`	`Handle`	yes	Block to route to on `NoneFound`. No cases are found with the search criteria.

`set_id`

set_id(id: String) -> GetCaseHandle

Override the auto-generated identifier with a specific wire id.

Parameter	Type	Required	Description
`id`	`String`	yes	Wire identifier override. Decompile threads this through to round-trip Connect-side UUIDs.

`meta_position`

meta_position(x: i64, y: i64) -> GetCaseHandle

Set the block's canvas position. Mostly auto-emitted by decompile; authored scripts call Flow.auto_layout() instead and let the layout pass fill positions in.

Parameter	Type	Required	Description
`x`	`i64`	yes	Canvas X coordinate.
`y`	`i64`	yes	Canvas Y coordinate.

`set_meta`

set_meta(key: String, value: Dynamic) -> GetCaseHandle

Single-key escape hatch, set one ActionMetadata key by name when the typed meta_* setters don't cover it.

Parameter	Type	Required	Description
`key`	`String`	yes	Wire key name (under `Metadata.ActionMetadata[<id>]`).
`value`	`Dynamic`	yes	Any JSON-serializable Rhai value.

`overwrite_meta`

overwrite_meta(value: Map) -> GetCaseHandle

Full-replace escape hatch, overwrite the entire ActionMetadata blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement map for the entire ActionMetadata sub-object.

`set_meta_param`

set_meta_param(param: String, flag: String, value: Dynamic) -> GetCaseHandle

Set a single per-parameter ActionMetadata flag.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name (e.g. `"Text"`).
`flag`	`String`	yes	Flag name (`"useDynamic"`, `"MFLAG_*"`, etc.).
`value`	`Dynamic`	yes	Flag value.

`overwrite_meta_param`

overwrite_meta_param(param: String, value: Map) -> GetCaseHandle

Replace the entire flag map for one parameter.

Parameter	Type	Required	Description
`param`	`String`	yes	Parameter name.
`value`	`Map`	yes	Replacement flag map for the parameter.

`overwrite_parameters`

overwrite_parameters(value: Map) -> GetCaseHandle

Wire-shape escape hatch, overwrite the entire Parameters blob.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement parameter map for the block.

`raw_transitions`

raw_transitions(value: Map) -> GetCaseHandle

Wire-shape escape hatch for non-canonical transition objects.

Parameter	Type	Required	Description
`value`	`Map`	yes	Replacement transitions map (raw JSON shape).