Object Type Variables

You can create an object type in cases where you want to group together various data types into an object variable. You define the structure of the object and create a variable using this type with values that fit the configured schema.

The maximum number of custom variable types (array, object, and table) allowed is 200 total per organization.

  1. Choose Automate > Variables in the navigation menu

  2. Click the Variable Types tab and then click New Variable Type.

  3. In the Data Type drop-down list, choose Object Type.

  4. Enter a meaningful Display Name and optional Description.

  5. Define the structure of this object by adding a key-value pair for each of the elements you want in your variable:

    • Key Name - A human-readable name of the element.
    • Value Data Type - The data type of the field.

  6. Click Add another key/value pair to add another element.

    Here is an example of an object called PropertiesObjectType that contains a list of elements with a mix of basic data types:

    Example Table

  7. Click Submit.

Using an object type variable is similar to any other variable type. You select your object type as the Data Type or enter its name.

  1. Choose Automate > Variables in the navigation menu

  2. Click the Global Variables tab and then click New Variable.

  3. In the Data Type drop-down list, choose your object type or enter its name.

  4. Enter a meaningful Display Name, Description, and Scope.

  5. In this example, we chose the PropertiesObjectType data type (from above). In the Value field, hover over the informational tooltip to see the expected format of the object schema.

    Tooltip Schema

  6. In this example, you would enter the values and click Format:

    Value Schema

  7. Click Submit.