Method: customFieldValues.patch

Full name: projects.locations.instances.cases.customFieldValues.patch

Updates (or creates if not present) the value of a custom field. Use this method to record or refine investigation data. The system validates the input against the field's defined rules (e.g., list options).

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{customFieldValue.name}

Path parameters

Parameters
customFieldValue.name

string

Identifier. Unique identifier of the resource.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of CustomFieldValue.

Response body

If successful, the response body contains an instance of CustomFieldValue.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/chronicle
  • https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.customFieldValues.update

For more information, see the IAM documentation.