Docs »

Automations »

Commands »

record.search

The record.search: command returns record dictionaries from a search query.



start:
  record.search:
    inputs:
      record_type: ticket
      record_query: status:${status}
      record_query_params:
        status: o
    output: results


Syntax

inputs:

Key  
record_type: The record type to search.
record_query: The search query to match. Use limit:1 to return a single dictionary rather than an array of dictionaries.
record_query_params: Query parameters with untrusted user input as keys/values. Reference these as ${param} in queries.

output:

Save the search results as record dictionaries in this placeholder.

on_simulate:

The commands to run during simulation instead of searching records.

If omitted, records are searched during simulation.

on_success:

The commands to run on success.

The output: placeholder is an array of record dictionaries.

on_error:

The commands to run on failure. If omitted, the automation exits in the error state.

The output: placeholder receives a dictionary with these keys:

Key  
error The error message.