Get Incident Static Field

LAST UPDATED: AUG 02, 2024

Get Incident Static Field Values.

Implementation	System
Command Category	System Utility
Tags	INCIDENT INCIDENT FIELDS

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Incident Number	Optional	Incident Number to retrieve the static field values from.	`TEST-INCIDENT-73`
Site Name	Optional	The site containing the incident, if left empty will use the runtime site.	`Security Operations`
Username	Optional	The username of user who accesses the incident. This username will only be used when the task auto-runs. If left empty, will default to the system user.	`admin user`

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

{
    "Status": "Successful",
    "Data": {
        "CaseNumber": "TEST-INCIDENT-75",
        "CreatorFullName": "D3 admin",
        "Title": "Test title",
        "Site": "Security Operations",
        "TimeZone": "PST",
        "Severity": "Low",
        "Owner": "D3 admin",
        "AssigneeName": "D3 admin",
        "Status": "Open",
        "IRTypeName": "Active Shooter",
        "Disposition": "False Positive",
        "ChangedDate": "2022-01-24 16:57:32",
        "DateCreated": "2022-01-24 16:57:32",
        "DateModified": "2022-01-27 10:52:59",
        "ClosedBy": "D3 admin",
        "DateClosed": "2022-01-28 12:19:33",
        "PlayBook Name": [
            {
                "PlaybookName": "Test Playbook"
            }
        ],
        "Descriptions": "Test Descriptions",
        "Conclusion": "",
        "Note": [],
        "Linked Incident": [],
        "Investigation Team": [],
        "Tag": []
    }
}

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

CODE

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

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": {
    "Incident Number": "<Incident Number here>",
    "Site Name": "<Incident Number here>",
    "Username": "<Incident Number 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.
Incident Number	`string`	Optional	Incident Number to retrieve the static field values from.
Site Name	`string`	Optional	The site containing the incident, if left empty will use the runtime site.
Username	`string`	Optional	The username of user who accesses the incident. This username will only be used when the task auto-runs. If left empty, will default to the system user.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "TEST-INCIDENT-73",
    "Site Name": "Security Operations",
    "Username": "admin user"
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": {
      "Status": "Successful",
      "Data": {
          "CaseNumber": "TEST-INCIDENT-75",
          "CreatorFullName": "D3 admin",
          "Title": "Test title",
          "Site": "Security Operations",
          "TimeZone": "PST",
          "Severity": "Low",
          "Owner": "D3 admin",
          "AssigneeName": "D3 admin",
          "Status": "Open",
          "IRTypeName": "Active Shooter",
          "Disposition": "False Positive",
          "ChangedDate": "2022-01-24 16:57:32",
          "DateCreated": "2022-01-24 16:57:32",
          "DateModified": "2022-01-27 10:52:59",
          "ClosedBy": "D3 admin",
          "DateClosed": "2022-01-28 12:19:33",
          "PlayBook Name": [
              {
                  "PlaybookName": "Test Playbook"
              }
          ],
          "Descriptions": "Test Descriptions",
          "Conclusion": "",
          "Note": [],
          "Linked Incident": [],
          "Investigation Team": [],
          "Tag": []
      }
    }
}