Get Incident Static Field | docs.d3security

Last updated: Sept 09, 2024

Retrieves the static field values of an incident.

Implementation	System
Command Category	System Utility
Tags	Incident Incident Fields

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Incident Number	Optional	The incident number corresponding to an incident for which the static field values will be retrieved. If left empty, the runtime incident will be used.	082324-15966
Site Name	Optional	The site containing the incident. If left empty, the runtime site will be used.	Security Operations
Username	Optional	The username corresponding to the member of the site who is accessing the incident. This parameter will only be used when the incident playbook task auto-runs. If left empty, it 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": "082324-15966",
        "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

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	The incident number corresponding to an incident for which the static field values will be retrieved. If left empty, the runtime incident will be used.
Site Name	`string`	Optional	The site containing the incident. If left empty, the runtime site will be used.
Username	`string`	Optional	The username corresponding to the member of the site who is accessing the incident. This parameter will only be used when the incident playbook task auto-runs. If left empty, it will default to the system user.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "082324-15966",
    "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": "082324-15966",
          "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": []
      }
    }
}