REST Resource: projects.locations.instances.requestTemplates

Resource: RequestTemplate

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. RequestTemplate resource.

JSON representation 
{
  "name": string,
  "displayName": string,
  "visualFamily": string,
  "environments": [
    string
  ],
  "eventFieldDefinitions": [
    {
      object (RequestEventFieldDefinition)
    }
  ],
  "requestTemplateId": integer,
  "allowDescription": boolean
}
Fields
name

string

Identifier. The resource name of the RequestTemplate. Format: projects/{project}/locations/{location}/instances/{instance}/requests/{requestTemplate}
displayName

string

Required. Request template display name, limited to 4096 characters.
visualFamily

string

Required. Visual family name for the mapping of the request event data
environments[]

string

Required. Request template associated logical environments
eventFieldDefinitions[]

object (RequestEventFieldDefinition)

Required. Request event fields definitions
requestTemplateId

integer

Output only. Request Template Id
allowDescription

boolean

Required. Include description field in the request form

RequestEventFieldDefinition

Event field definition message.

JSON representation 
{
  "name": string,
  "entityTypes": [
    string
  ],
  "watermark": string,
  "type": enum (RequestEventFieldType)
}
Fields
name

string

Required. The name of the event field related to the request template.
entityTypes[]

string

Optional. The entity types of the RequestEventFieldDefinition.
watermark

string

Required. Serves as an example of possible values to set for current field.
type

enum (RequestEventFieldType)

Required. The RequestEventFieldType of the RequestEventFieldDefinition.

RequestEventFieldType

Event field type enum.

Enums
REQUEST_EVENT_FIELD_TYPE_UNSPECIFIED Unspecified type.
STRING String type.
BOOLEAN Boolean type.
NUMBER Number type.
LIST List type.
EMAIL Email type.

Methods

create

 Defines a new manual request form, specifying the input fields analysts must provide and how the data should be visually mapped in cases.

delete

 Permanently removes an obsolete manual request form from the system.

get

 Retrieves the definition of a manual request form, including its display fields, visual mapping, and associated environments.

list

 Lists all available manual request forms configured in the system.

patch

 Modifies a manual request form's structure, such as adding or removing fields, or adjusting environment associations.