List.[Table] data type

  • Release version: Zurich
  • Updated July 31, 2025
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of List.[Table] data type

    The List.[Table] data type in ServiceNow stores a list of record Sys IDs associated with a specific table. It supports ServiceNow AI Platform List field options, including default records and reference qualifiers, enabling precise control over the records included in workflows and actions.

    Show full answer Show less

    Basic Features

    • Label: Identifies the data variable in Workflow Studio with any text.
    • Name: Used in script calls, automatically generated from the label with only alphanumeric and underscore characters.
    • Type: Specifies that the variable stores a list of record references.
    • Mandatory: Defines whether the variable requires a value when configured in an action.

    Advanced Options

    • Hint: Provides configuration guidance to flow or action designers.
    • Default value: Sets the value used if no input is provided by the flow or action designer.
    • Add [Record Label]: Allows selection of one or more default records for the list, filtered by any applied reference qualifier.
    • Reference qualifier conditions: Filters the list to display only records matching specified conditions.

    Practical Guidelines for Use

    • Reference qualifier filtering: Use reference qualifiers to restrict the list variable’s valid options to records that meet specific criteria (e.g., only active incident records).
    • Default records caution: Avoid setting default records for actions intended for ServiceNow Store use, as spoke developers may lack access to customer data. For Store publishing, provide demo data as default records if needed.
    • For Each flow logic compatibility: List variables can specify records for iteration in For Each logic, which ignores any non-record sysid values (e.g., email addresses).

    Stores a list of record Sys IDs associated to a specific table. This variable supports ServiceNow AI Platform List field options such as default records and reference qualifiers.

    Basic options

    Option Description
    Label Displays the label used to identify the data variable in the Workflow Studio interface. The label can consist of any text.
    Name Displays the name used to identify the data variable in script calls. The name can only consist of alphanumeric and underscore characters. The system automatically converts the label into a valid name by removing or replacing any special characters.
    Type Indicates the type of data stored by the data variable.
    Mandatory Indicates whether the data variable must contain a value when configured in an action.

    Advanced options for List variables

    Option Description
    Hint Provides guidance to flow or action designers on how to configure the data.
    Default value Specifies the value used when a flow or action designer does not provide a value.
    Add [Record Label] Select one or more records to include as default values for the list. If you filter the list with a reference qualifier, you can only select records that match the reference qualifier conditions.
    Reference qualifier conditions Select the filter conditions applied to the list of records. Flow designers can only select records that match the reference qualifier conditions.

    General guidelines

    Add a reference qualifier to filter list records
    Filter the records the list variable displays as valid options by adding a reference qualifier. The reference qualifier acts as a required list filter and causes the list variable to display only records that match the reference qualifier conditions. For example, to only displays active incident records add the reference qualifier condition [Active][is][true].
    Avoid selecting default records for actions intended for ServiceNow Store
    Avoid selecting default records for a list unless you know that all instances have access to the selected records. Spoke developers typically do not have access to the data of the customers who install their custom action. If you want to publish a custom action on the ServiceNow Store, you may need to provide default records as demo data.
    Use List variables in For Each flow logic
    You can use a List variable to specify the records to process within For Each flow logic. The For Each flow logic ignores any non-record sys_id present in the data. For example, if the List variable contains an email address, the flow logic ignores it.