Remove Field from Local Shared Data

This command can only be executed within an event/incident playbook. Removes a field with the specified JSON Path from the Local Shared Data in the playbook.

Reader Note

Please note that this command is only applicable within an event Playbook.

Implementation	System
Command Category	System Utility
Tags	LOCAL SHARED DATA CONTEXT DATA

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Task ID	Required	The Task ID of the Local Shared Data	`11360`
JSON Path	Required	The JSON Path to specify the location to delete from the Local Shared Data	`$.incidentNumber`

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

Succeed

Context Data

The response data from the utility command.

SAMPLE DATA

CODE

{
    "jsonPath": "$.11360.incidentNumber",
    "deleted": "true"
}

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

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": {
    "Task ID": <Task ID here>,
    "JSON Path": <JSON Path here>
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`Text`	Required	The username of your D3 SOAR account.
Site	`Text`	Required	The D3 SOAR site to run the remote command.
Task Id	`Text`	Required	The Task ID of the Local Shared Data
JSON Path	`Text`	Required	The JSON Path to specify the location to delete from the Local Shared Data

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Task ID": 11360,
    "JSON Path": "$.incidentNumber"
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": "Succeed",
    "Context Data": {
        "jsonPath": "$.11360.incidentNumber",
        "deleted": "true"
    }
}