2025-06-04
▼ ▲ healthcare.projects.locations.datasets.annotationStores.create
Path : v1beta1/{+parent}/annotationStores
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the dataset this Annotation store belongs to.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
annotationStoreId
Description : Required. The ID of the Annotation store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Creates a new Annotation store within the parent dataset.
▼ ▲ healthcare.projects.locations.datasets.annotationStores.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Annotation store to get.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets the specified Annotation store or returns NOT_FOUND if it does not exist.
▼ ▲ healthcare.projects.locations.datasets.annotationStores.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Annotation store to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes the specified Annotation store and removes all annotations that are contained within it.
▼ ▲ healthcare.projects.locations.datasets.annotationStores.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Updates the specified Annotation store.
▼ ▲ healthcare.projects.locations.datasets.annotationStores.list
Path : v1beta1/{+parent}/annotationStores
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores
HTTP Method : GET
Parameters :
parent
Description : Required. Name of the dataset.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Limit on the number of Annotation stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : The next_page_token value returned from the previous List request, if any.
Location : query
Type : string
filter
Description : Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists the Annotation stores in the given dataset for a source store.
▼ ▲ healthcare.projects.locations.datasets.annotationStores.import
Path : v1beta1/{+name}:import
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}:import
HTTP Method : POST
Parameters :
name
Description : Required. The name of the Annotation store to which the server imports annotations, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Import Annotations to the Annotation store by loading data from the specified sources. If the request is successful, a detailed response is returned as of type ImportAnnotationsResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
▼ ▲ healthcare.projects.locations.datasets.annotationStores.export
Path : v1beta1/{+name}:export
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}:export
HTTP Method : POST
Parameters :
name
Description : Required. The name of the Annotation store to export annotations to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Export Annotations from the Annotation store. If the request is successful, a detailed response is returned of type ExportAnnotationsResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
▼ ▲ healthcare.projects.locations.datasets.annotationStores.evaluate
Path : v1beta1/{+name}:evaluate
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}:evaluate
HTTP Method : POST
Parameters :
name
Description : Required. The Annotation store to compare against `golden_store`, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Evaluate an Annotation store against a ground truth Annotation store. When the operation finishes successfully, a detailed response is returned of type EvaluateAnnotationStoreResponse, contained in the response. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).
▼ ▲ healthcare.projects.locations.datasets.annotationStores.annotations.create
Path : v1beta1/{+parent}/annotations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}/annotations
HTTP Method : POST
Parameters :
parent
Description : Required. The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.
▼ ▲ healthcare.projects.locations.datasets.annotationStores.annotations.get
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}/annotations/{annotationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the Annotation to retrieve.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+/annotations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets an Annotation.
▼ ▲ healthcare.projects.locations.datasets.annotationStores.annotations.delete
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}/annotations/{annotationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the Annotation to delete.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+/annotations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes an Annotation or returns NOT_FOUND if it does not exist.
▼ ▲ healthcare.projects.locations.datasets.annotationStores.annotations.patch
Path : v1beta1/{+name}
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}/annotations/{annotationsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+/annotations/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Updates the Annotation.
▼ ▲ healthcare.projects.locations.datasets.annotationStores.annotations.list
Path : v1beta1/{+parent}/annotations
Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationStores/{annotationStoresId}/annotations
HTTP Method : GET
Parameters :
parent
Description : Required. Name of the Annotation store to retrieve Annotations from.
Pattern : ^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationStores/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Limit on the number of Annotations to return in a single response. If not specified, 100 is used. May not be larger than 1000.
Location : query
Type : integer
Format : int32
pageToken
Description : The next_page_token value returned from the previous List request, if any.
Location : query
Type : string
filter
Description : Restricts Annotations returned to those matching a filter. Functions available for filtering are: - `matches("annotation_source.cloud_healthcare_source.name", substring)`. Filter on `cloud_healthcare_source.name`. For example: `matches("annotation_source.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`.
Location : query
Type : string
view
Description : Controls which fields are populated in the response.
Location : query
Type : string
Enum Descriptions :
Enum :
Parameter Order : parent
Scopes :
Description : Lists the Annotations in the given Annotation store for a source resource.