Method: projects.locations.orders.comments.recordAction

Record Action on a Comment. If the Action specified in the request is READ, the viewed time in the comment is set to the time the request was received. If the comment is already marked as read, subsequent calls will be ignored. If the Action is UNREAD, the viewed time is cleared from the comment.

HTTP request

POST https://gdchardwaremanagement.googleapis.com/v1alpha/{name=projects/*/locations/*/orders/*/comments/*}:recordAction

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the comment. Format: projects/{project}/locations/{location}/orders/{order}/comments/{comment}

Request body

The request body contains data with the following structure:

JSON representation
{
  "actionType": enum (ActionType)
}
Fields
actionType

enum (ActionType)

Required. The action type of the recorded action.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

ActionType

Valid action types of Comment.

Enums
ACTION_TYPE_UNSPECIFIED Action is unspecified.
READ Mark comment as read.
UNREAD Mark comment as unread.