REST Resource: projects.locations.instances.cases.alerts.customFieldValues

Resource: CustomFieldValue

This service is available for customers who migrated SOAR to a customer managed project and have the Chronicle API enabled. Custom Fields are fields defined on a global level for alert and/or case scope. Custom fields are values set for a specific identifier and scope

JSON representation
{
  "name": string,
  "customFieldId": string,
  "scope": enum (CustomFieldScope),
  "scopeId": string,
  "values": [
    string
  ]
}
Fields
name

string

Identifier. Unique identifier of the resource.

customFieldId

string

Required. The id of the parent CustomField that owns this CustomFieldValue

scope

enum (CustomFieldScope)

Output only. Scope of the value.

scopeId

string

Required. Identifier of the value referencing case or alert.

values[]

string

Required. The custom field value.

CustomFieldScope

Whether the custom field is associated with an alert or a case.

Enums
CUSTOM_FIELD_SCOPE_UNSPECIFIED Unspecified scope.
ALERT Belnogs to Alert scope.
CASE Belongs to Case scope.

Methods

batchUpdate

Batch update CustomFieldValues.

get

Get a CustomFieldValue.

list

Lists CustomFieldValues.

patch

Update a CustomFieldValue.