Get Global List Values by JSON Paths

Last updated: aug 08, 2024

Retrieves values from a global list according to the specified JSON path(s).

Implementation	System
Command Category	System Utility
Tags	Global List

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Global List Name	Required	The name of the global list to extract from.	demoGlobalList
JSON Paths	Required	The JSON paths used to retrieve data from the specified global list.	`[ "$.demoJSONpath", "$.demoJSONpath2" ]`

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

Sample Data

JSON

[
  {
    "demoKeyA": "demoValueA",
    "demoKeyB": "demoValueB"
  },
  {
    "demoKeyC": "demoValueC",
    "demoKeyD": "demoValueD"
  }
]

Context Data

The response data from the utility command.

Sample Data

JSON

[
  {
    "demoKeyA": "demoValueA",
    "demoKeyB": "demoValueB"
  },
  {
    "demoKeyC": "demoValueC",
    "demoKeyD": "demoValueD"
  }
]

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

https:/{base_url}/{api_namespace}/api/Command/GetListValues

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": "<Username here>",
  "Site": "<Site here>",
  "CommandParams": {
    "Global List Name": "<Global List Name here>",
    "JSON Paths": "<JSON Paths here>"
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
Global List Name	`string`	Required	The name of the global list to extract from.
JSON Paths	`array<string>`	Required	The JSON paths used to retrieve data from the specified global list.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Global List Name": "demoGlobalList",
    "JSON Paths": [
      "$.demoJSONpath",
      "$.demoJSONpath2"
    ]
  }
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`array<JSON Object>`	The return data from the API request.
contextData	`array<JSON Object>`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": [
        {
            "demoKey": "demoValue",
            "demoKey2": "demoValue2"
        },
        {
            "demoKey3": "demoValue3",
            "demoKey4": "demoValue4"
        }
    ],
    "contextData": [
        {
            "demoKey": "demoValue",
            "demoKey2": "demoValue2"
        },
        {
            "demoKey3": "demoValue3",
            "demoKey4": "demoValue4"
        }
    ]
}