Create a data gathering action for a dynamic object

Create an action to collect output values. Then, pass the values to a parent action as a dynamic object.

Before you begin

Role required: action_designer or admin

Note: Dynamic outputs are not available in the base system. To use dynamic outputs in Workflow Studio, you must Request an Integration Hub plugin.

About this task

These steps allow you to create a generic data gathering action for a dynamic output. To see working examples of data gathering actions for dynamic outputs, see Get started with dynamic outputs.

Procedure

1. Navigate to All > Process Automation > Workflow Studio.

2. On the homepage, select Actions.

3. Select New > New Action.

4. In the Name field, enter a name for your action, choose the proper Application scope, and then select Submit.

5. In the Action Outline, select the add a new step icon (

Configure your REST step to get data from the proper Base URL and Resource Path with any applicable Query Parameters for the HTTP Method `GET`. For more information on using the REST step in Integration Hub, see [REST step](rest-request-action-designer.md) and [REST in IntegrationHub](https://developer.servicenow.com/app.do#!/training/article/app_store_learnv2_rest_paris_rest_in_integrationhub/app_store_learnv2_rest_paris_rest_in_integrationhub_objectives?v=paris).

1. In the Action Outline, select the add a new step icon (

This script step must transform the response from the REST step's Response Body into a format that defines the schema of a dynamic object output for a parent action. Your script step must:

-   Have a single JSON output variable. The script step can have other output variables, but only one must be of type JSON.
-   Format the JSON output variable so that it contains a property named `data`. For a complex object output, your `data` property must have a format similar to the following example:

    ```
    {
           data: {
               type: "object",              
               //Required

               children: [                  
               //Required - This is a collection of field definitions

                   {
                       name: "Name 1",      
                       //Required - Unique name

                       label: "Label 1",    
                       //Required - Display name

                       type: "string"       
                       //Required - Supported field type (See the Note below)

                   },

                   {
                       name: "Name 2",
                       label: "Label 2",
                       type: "string"
                   }
               ]
           }
       }

    ```

    For a complex object array output, your `data` property must have a format similar to the following example:

    ```
    {
           data: {
               type: "object",                          
               //Required

               attributes: { child_type: "object" }     
               //Required - Indicates that the array's children are of type object

               children: [                              
               //Required - This is a collection of field definitions

                   {
                       name: "Name 1",                  
                       //Required - Unique name

                       label: "Label 1",                
                       //Required - Display name

                       type: "string"                   
                       //Required - Supported field type (See the Note below)
                   },

                   {
                       name: "Name 2",
                       label: "Label 2",
                       type: "string"
                   }
               ]
           }
       }

    ```

    **Note:** Supported [action data types](action-inputs-outputs.md) for the `type` property include:

    -   `string`
    -   `integer`
    -   `datetime`
    -   `choice`
    -   `boolean`
    -   `object`
    -   `array.string`
    -   `array.integer`
    -   `array.datetime`
    -   `array.choice`
    -   `array.boolean`
    -   `array.object`

1. In the Action Outline, select Outputs.

   1. Create an output of type Dynamic Output.

      Note: If you don't see Dynamic Outputs as a data type option, then you're missing an Integration Hub subscription.

   2. In the Dynamic Options, select a data gathering action for the Action option.

      For examples of dynamic output data gathering actions, see Get started with dynamic outputs.

   3. If needed set the Depends On Another input option, and select the input.

   Create an outputs of type Dynamic Object.

2. Select Save and test the action.

   In the execution details, your data gathering action runs successfully if the runtime value for output contains the data property in the proper format.

3. Select Publish to make the action available to other flows or actions within the same application scope.

You can now use your data gathering action to populate the schema values for a dynamic object in a parent action.

Parent Topic:Dynamic outputs

Related topics

Get started with dynamic outputs

Dynamic output configuration options