Method: projects.histories.list

Lists Histories for a given Project.

The histories are sorted by modification time in descending order. The historyId key will be used to order the history with the same modification time.

May return any of the following canonical error codes:

  • PERMISSION_DENIED - if the user is not authorized to read project
  • INVALID_ARGUMENT - if the request is malformed
  • NOT_FOUND - if the History does not exist

HTTP request

GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

A Project id.

Required.

Query parameters

Parameters
pageToken

string

A continuation token to resume the query at the next item.

Optional.
pageSize

integer

The maximum number of Histories to fetch.

Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100.

Optional.
filterByName

string

If set, only return histories with the given name.

Optional.

Request body

The request body must be empty.

Response body

Response message for HistoryService.List

If successful, the response body contains data with the following structure:

JSON representation 
{
  "histories": [
    {
      object (History)
    }
  ],
  "nextPageToken": string
}
Fields
histories[]

object (History)

Histories.
nextPageToken

string

A continuation token to resume the query at the next item.

Will only be set if there are more histories to fetch.

Tokens are valid for up to one hour from the time of the first list request. For instance, if you make a list request at 1PM and use the token from this first request 10 minutes later, the token from this second response will only be valid for 50 minutes.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.