Required. The name of the Annotation store to export annotations to, in the format of projects/{projectId}/locations/{locationId}/datasets/{datasetId}/annotationStores/{annotationStoreId}.
Authorization requires the following IAM permission on the specified resource name:
healthcare.annotationStores.export
Request body
The request body contains data with the following structure:
JSON representation
{// Union field destination can be only one of the following:"gcsDestination": {object(GcsDestination)},"bigqueryDestination": {object(BigQueryDestination)}// End of list of possible types for union field destination.}
Fields
Union field destination. Destination for export. destination can be only one of the following:
The Cloud Storage destination to export to. URI for a Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced in uriPrefix.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis API endpoint exports annotations from a specified Annotation store.\u003c/p\u003e\n"],["\u003cp\u003eThe export destination can be either Cloud Storage, requiring the \u003ccode\u003eroles/storage.objectAdmin\u003c/code\u003e role, or BigQuery, requiring the \u003ccode\u003eroles/bigquery.dataEditor\u003c/code\u003e and \u003ccode\u003eroles/bigquery.jobUser\u003c/code\u003e roles.\u003c/p\u003e\n"],["\u003cp\u003eA successful request returns an \u003ccode\u003eExportAnnotationsResponse\u003c/code\u003e within the \u003ccode\u003eresponse\u003c/code\u003e field of a long-running operation.\u003c/p\u003e\n"],["\u003cp\u003eThe API request must be made using the \u003ccode\u003ePOST\u003c/code\u003e method to the specified URL, including the Annotation store name in the format \u003ccode\u003eprojects/{projectId}/locations/{locationId}/datasets/{datasetId}/annotationStores/{annotationStoreId}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires \u003ccode\u003ehealthcare.annotationStores.export\u003c/code\u003e IAM permission on the specified resource name and one of the OAuth scopes: \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-healthcare\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: annotationStores.export\n\n**Full name**: projects.locations.datasets.annotationStores.export\n\nExport [Annotations](/healthcare-api/docs/reference/rest/v1beta1/projects.locations.datasets.annotationStores.annotations#Annotation) from the [Annotation store](/healthcare-api/docs/reference/rest/v1beta1/projects.locations.datasets.annotationStores#AnnotationStore). If the request is successful, a detailed response is returned of type [ExportAnnotationsResponse](/healthcare-api/docs/reference/rest/Shared.Types/ExportAnnotationsResponse), contained in the \\[response\\]\\[google.longrunning.Operation.result.response\\] field when the operation finishes. The [metadata](/healthcare-api/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation.FIELDS.metadata) field type is [OperationMetadata](/healthcare-api/docs/reference/rest/v1beta1/OperationMetadata). Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)).\n\n### HTTP request\n\n`POST https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/annotationStores/*}:export`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/healthcare-api/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-healthcare`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\nGcsDestination\n--------------\n\nThe Cloud Storage location for export."]]
