Method: caseWallRecords.favorite

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

Set a wall item as a favorite one.

HTTP request


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 the following OAuth scope:

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

For more information, see the Authentication Overview.

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.