Get JSON Objects from Global List by Values‎

POST /Command/GetObjectsFromList

Gets JSON objects from global list by specified values at the specified key.

Request

Authentication: API keys or JSON web tokens (JWT)

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`	Optional	The name of the global list.
Key	`string`	Optional	The key in the specified global list to query.
Values	`array<string>`	Optional	Values used to compare with the global list values at the specified key.

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Global List Name": "MacToSysNameMappingList",
    "Key": "SystemName",
    "Values": [
      "D3Lab-AD",
      "D3LAB02",
      "D3CYBER-PC1"
    ]
  }
}

Response

200 OK

application/json

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 Data

JSON

{
    "error": "",
    "returnData": [
      {
          "GroupID": 2,
          "SystemName": "D3Lab-AD",
          "MACAddress": "020806A536xx"
      },
      {
          "GroupID": 2,
          "SystemName": "D3LAB02",
          "MACAddress": "090706B536xx"
      },
      {
          "GroupID": 7,
          "SystemName": "D3CYBER-PC1",
          "MACAddress": "000C29D576xx"
      }
    ],
    "rawData": [
      {
          "GroupID": 2,
          "SystemName": "D3Lab-AD",
          "MACAddress": "020806A536xx"
      },
      {
          "GroupID": 2,
          "SystemName": "D3LAB02",
          "MACAddress": "090706B536xx"
      },
      {
          "GroupID": 7,
          "SystemName": "D3CYBER-PC1",
          "MACAddress": "000C29D576xx"
      }
    ]
}

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}