Method: annotations.list

Full name: projects.locations.datasets.annotationStores.annotations.list

Lists the Annotations in the given Annotation store for a source resource.

HTTP request

GET https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/annotationStores/*}/annotations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Name of the Annotation store to retrieve Annotations from.

Authorization requires the following IAM permission on the specified resource parent:

  • healthcare.annotations.list

Query parameters

Parameters
pageSize

integer

Limit on the number of Annotations to return in a single response. If zero the default page size of 100 is used.

pageToken

string

The nextPageToken value returned from the previous List request, if any.

filter

string

Restricts Annotations returned to those matching a filter. Functions available for filtering are:

  • matches("annotationSource.cloud_healthcare_source.name", substring). Filter on cloudHealthcareSource.name. For example: matches("annotationSource.cloud_healthcare_source.name", "some source").

  • matches("annotation", substring). Filter on all fields of annotation. For example: matches("annotation", "some-content").

  • type("text"), type("image"), type("resource"). Filter on the type of annotation data.

view

enum(AnnotationView)

Controls which fields are populated in the response.

Request body

The request body must be empty.

Response body

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

Lists the Annotations in the specified Annotation store.

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

object(Annotation)

The returned Annotations. Won't be more values than the value of pageSize in the request. See AnnotationView in the request for populated fields.

nextPageToken

string

Token to retrieve the next page of results or empty if there are no more results in the list.

Authorization Scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

AnnotationView

The optional view on Annotation.

Enums
ANNOTATION_VIEW_UNSPECIFIED Same as BASIC.
ANNOTATION_VIEW_BASIC Only name, annotationSource and customData fields are populated.
ANNOTATION_VIEW_FULL All fields are populated.