Sync Incident Form

This utility command enables the synchronization of incident form from the master to the tenant instance.

Implementation	System
Command Category	System Utility
Tags	INCIDENT DYNAMIC FORM MULTITENANCY

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Sync All Shared	Optional	Option to share all tagged incident types just ones provided in incident type info	`False`
Incident Type Info	Optional	Incident Type Info	CODE `[ { "Incident Type": "" }, { "Incident Type": "" } ]`
Tenant Region	Optional	Region of the tenant	`AMER`
Tenant Name	Optional	Name of the tenant	`TestTenant`

Output

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

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": {
    "Sync All Shared": <Sync All Shared here>,
    "Incident Type Info": <Incident Type Info here>,
    "Tenant Region": <Tenant Region here>,
    "Tenant Name": <Tenant Name here>
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`Text`	Optional	Option to share all tagged connection or just ones provided in connection info
Site	`Text`	Optional	Information about the automation rule to sync
Sync All Shared	`Boolean`	Optional	Option to share all tagged incident types just ones provided in incident type info
Incident Type Info	`JSON Array`	Optional	Incident Type Info
Tenant Region	`Text`	Optional	Region of the tenant
Tenant Name	`Text`	Optional	Name of the tenant

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Sync All Shared": "False",
    "Incident Type Info": [
      {
        "Incident Type": ""
      },
      {
        "Incident Type": ""
      }
    ],
    "Tenant Region": "AMER",
    "Tenant Name": "TestTenant"
  }
}

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.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful"
}