REST Resource: approvals

Resource: Approval

Metadata for an approval. An approval is a review/approve process for a Drive item.

JSON representation
 { 
 "kind" 
 : 
 string 
 , 
 "approvalId" 
 : 
 string 
 , 
 "targetFileId" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "modifyTime" 
 : 
 string 
 , 
 "completeTime" 
 : 
 string 
 , 
 "dueTime" 
 : 
 string 
 , 
 "status" 
 : 
 enum (  Status 
 
) 
 , 
 "initiator" 
 : 
 { 
 object (  User 
 
) 
 } 
 , 
 "reviewerResponses" 
 : 
 [ 
 { 
 object (  ReviewerResponse 
 
) 
 } 
 ] 
 } 
Fields
kind

string

This is always drive#approval.

approvalId

string

The Approval ID.

targetFileId

string

Target file id of the approval.

createTime

string ( Timestamp format)

Output only. The time the approval was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

modifyTime

string ( Timestamp format)

Output only. The most recent time the approval was modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

completeTime

string ( Timestamp format)

Output only. The time time the approval was completed.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

dueTime

string ( Timestamp format)

The time that the approval is due.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

status

enum ( Status )

Output only. The status of the approval at the time this resource was requested.

initiator

object ( User )

The user that requested the Approval.

reviewerResponses[]

object ( ReviewerResponse )

The responses made on the Approval by reviewers.

Status

Possible statuses of an Approval.

Enums
STATUS_UNSPECIFIED Approval status has not been set or was set to an invalid value.
IN_PROGRESS The approval process has started and not finished.
APPROVED The approval process is finished and the target was approved.
CANCELLED The approval process was cancelled before it finished.
DECLINED The approval process is finished and the target was declined.

ReviewerResponse

A response on an Approval made by a specific Reviewer.

JSON representation
 { 
 "kind" 
 : 
 string 
 , 
 "reviewer" 
 : 
 { 
 object (  User 
 
) 
 } 
 , 
 "response" 
 : 
 enum (  Response 
 
) 
 } 
Fields
kind

string

This is always drive#reviewerResponse.

reviewer

object ( User )

The user that is responsible for this response.

response

enum ( Response )

A Reviewer’s Response for the Approval.

Response

Possible responses for an Approval.

Enums
RESPONSE_UNSPECIFIED Response was set to an unrecognized value.
NO_RESPONSE The reviewer has not yet responded
APPROVED The Reviewer has approved the item.
DECLINED The Reviewer has declined the item.

Methods

get

Gets an Approval by ID.

list

Lists the Approvals on a file.
Design a Mobile Site
View Site in Mobile | Classic
Share by: