Docs »

Automations »

Commands »

data.query

The data.query: command executes a data query and returns the response.



start:
  data.query:
    output: results
    inputs:
      query@text:
        type:worklist.records
        of:ticket
        format:dictionaries
    on_success:
      return:
        records@key: results:data


Syntax

inputs:

Key  
query@text: A data query to run.
query_params Query parameters with untrusted user input as keys/values. Reference these as ${param} in queries.

output:

Save the results in this placeholder.

on_simulate:

The commands to run during simulation instead of the data query.

If omitted, the data query is executed during simulation.

on_success:

The commands to run on success.

The output: placeholder receives a dictionary with these keys:

Key  
data The response from the query.
_ The metadata from the query.

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.