Skip to main content
Skip table of contents

Update Linked Case Form Data

LAST UPDATED: FEB 27, 2024

Update the inciden's linked case form data.

Implementation

System

Command Category

System Utility

Tags

INCIDENT CASE

Inputs

N/A

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
Successful
Context Data

The response data from the utility command.

SAMPLE DATA

JSON
[
    {
        "CaseNumber": 11111,
        "UpdatedForm": [
            {
                "ID": 1234,
                "Name": "MyForm"
            },
            {
                "ID": 1235,
                "Name": "MyForm2"
            }
        ]
    },
    {
        "CaseNumber": 11131,
        "UpdatedForm": [
            {
                "ID": 1234,
                "Name": "MyForm"
            }
        ]
    }
]

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

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": {}
}

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.

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {}
}

Response

Response Fields

Field Name

Type

Description

error

Text

The error message if the API request has failed.

returnData

Text

The return data from the API request.

contextData

JSON Array

The context data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": "Successful",
    "contextData": [
        {
            "CaseNumber": 11111,
            "UpdatedForm": [
                {
                    "ID": 1234,
                    "Name": "MyForm"
                },
                {
                    "ID": 1235,
                    "Name": "MyForm2"
                }
            ]
        },
        {
            "CaseNumber": 11131,
            "UpdatedForm": [
                {
                    "ID": 1234,
                    "Name": "MyForm"
                }
            ]
        }
    ]
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.