Method: caseWallRecords.favorite

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions
• FavoriteRequest
  • JSON representation

Full name: projects.locations.instances.cases.caseWallRecords.favorite

Sets or unsets (toggles) the favorite status of a wall record. Use this method to highlight or unhighlight key pieces of evidence or critical observations on the case wall.

HTTP request

Choose a location:

africa-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-central2 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu

PATCH https://chronicle.africa-south1.rep.googleapis.com/v1beta/{favoriteRequest.name}:favorite

Path parameters

Parameters
favoriteRequest.name	string Required. The resource name of the CaseWallRecords to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}/caseWallRecords/{caseActivity}

Query parameters

Parameters
updateMask	string (FieldMask format) Optional. The list of fields to update. If not included, all fields with default/non-default values will be overwritten. 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 FavoriteRequest.

Response body

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

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.caseWallRecords.update

For more information, see the IAM documentation.

FavoriteRequest

Request message for caseWallRecords.favorite request.

JSON representation
{ "name": string, "recordId": string, "activityType": enum (WallActivityType), "activityKind": enum (ActivityKind), "favorite": boolean }

Fields
name	string Required. The resource name of the CaseWallRecords to retrieve. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}/caseWallRecords/{caseActivity}
recordId	string (int64 format) Required. The ID of the wall record to set as a favorite.
activityType	enum (WallActivityType) Required. The type of the activity.
activityKind	enum (ActivityKind) Optional. The kind of the activity.
favorite	boolean Required. Whether the activity is was marked as favorite.