Filter Text Array by Global List Value

Last updated: aug 08, 2024

Filters user-specified string value(s) from a particular global list.

READER NOTE

Multiple matches across various levels of the JSON structure are not supported. Users are required to restrict their JSON path queries to a single, specific level.

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.	demoGlobalList
JSON Path	Optional	The JSON path to the target global list field.	$.*
Target Values	Optional	The target values to be filtered.	`[ "demoTargetValue", "demoTargetValue2", ]`

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

[
    "demoTargetValue",
    "demoTargetValue",
    "demoTargetValue",
    "demoTargetValue",
    "demoTargetValue2",
    "demoTargetValue2"
]

Context Data

The response data from the utility command.

Sample Data

JSON

[
    "demoTargetValue",
    "demoTargetValue",
    "demoTargetValue",
    "demoTargetValue",
    "demoTargetValue2",
    "demoTargetValue2"
]

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/QueryList

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 Path": "<JSON Path here>",
    "Target Values": "<Target Values 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.
JSON Path	`string`	Required	The JSON path to the target global list field.
Target Values	`array<string>`	Required	The target values to be filtered.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Global List Name": "demoGlobalList",
    "JSON Path": "$.*",
    "Target Values": [
      "demoTargetValue",
      "demoTargetValue2"
    ]
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": [
        "demoTargetValue",
        "demoTargetValue",
        "demoTargetValue",
        "demoTargetValue",
        "demoTargetValue2",
        "demoTargetValue2"
    ],
    "contextData": [
        "demoTargetValue",
        "demoTargetValue",
        "demoTargetValue",
        "demoTargetValue",
        "demoTargetValue2",
        "demoTargetValue2"
    ]
}