Method: projects.locations.corpora.assets.annotations.list

Lists a list of annotations inside asset.

HTTP request

GET https://visionai.googleapis.com/v1/{parent=projects/*/locations/*/corpora/*/assets/*}/annotations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The parent, which owns this collection of annotations. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/assets/{asset}

Query parameters

Parameters
pageSize

integer

The maximum number of annotations to return. The service may return fewer than this value. If unspecified, at most 50 annotations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

A page token, received from a previous annotations.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to annotations.list must match the call that provided the page token.
filter

string

The filter applied to the returned list. We only support filtering for the following fields: partition.temporal_partition.start_time, partition.temporal_partition.end_time, and key. For corpus of IMAGE type, only key is supported. Timestamps are specified in the RFC-3339 format, and only one restriction may be applied per field, joined by conjunctions. Format: "partition.temporal_partition.start_time > "2012-04-21T11:30:00-04:00" AND partition.temporal_partition.end_time < "2012-04-22T11:30:00-04:00" AND key = "example_key""

Request body

The request body must be empty.

Response body

Request message for annotations.list API.

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

JSON representation 
{
  "annotations": [
    {
      object (Annotation)
    }
  ],
  "nextPageToken": string
}
Fields
annotations[]

object (Annotation)

The annotations from the specified asset.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • visionai.annotations.list

For more information, see the IAM documentation.