Method: annotationStores.import

Full name: projects.locations.datasets.annotationStores.import

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][google.longrunning.Operation.result.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).

HTTP request

POST https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/annotationStores/*}:import

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`name`	`string` Required. The name of the Annotation store to which the server imports annotations, in the format `projects/{projectId}/locations/{locationId}/datasets/{datasetId}/annotationStores/{annotationStoreId}`. Authorization requires the following IAM permission on the specified resource `name`: `healthcare.annotationStores.import`

name

string

Required. The name of the Annotation store to which the server imports annotations, in the format projects/{projectId}/locations/{locationId}/datasets/{datasetId}/annotationStores/{annotationStoreId}.

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

healthcare.annotationStores.import

Request body

The request body contains data with the following structure:

JSON representation
{ // Union field `source` can be only one of the following: "gcsSource": { object(`GcsSource`) } // End of list of possible types for union field `source`. }

Fields

Fields
Union field `source`. The Annotation must be provided in JSON format of the `Annotation`. For example, an annotation might look like the following: json { "annotation_source": { "cloud_healthcare_source": { "name": "projects/test_project/locations/test_location/datasets/test_dataset/fhirStores/test_fhir_store/resources/test_type/test_id" } }, "text_annotation": { "details": { "patient/text/div/value": { "findings": [ { "info_type": "PERSON_NAME", "start": "4", "end": "12", "quote": "John Doe", }, { "info_type": "DATE", "start": "37", "end": "47", "quote": "1900-12-24", } ] }, "patient/birth_date/value_us": { "findings": [ { "info_type": "DATE", "start": "0", "end": "10", "quote": "1900-12-24", } ] } } } } Each file consists of exactly one annotation. `source` can be only one of the following:
`gcsSource`	`object(GcsSource)`

Union field source. The Annotation must be provided in JSON format of the Annotation. For example, an annotation might look like the following: json { "annotation_source": { "cloud_healthcare_source": { "name": "projects/test_project/locations/test_location/datasets/test_dataset/fhirStores/test_fhir_store/resources/test_type/test_id" } }, "text_annotation": { "details": { "patient/text/div/value": { "findings": [ { "info_type": "PERSON_NAME", "start": "4", "end": "12", "quote": "John Doe", }, { "info_type": "DATE", "start": "37", "end": "47", "quote": "1900-12-24", } ] }, "patient/birth_date/value_us": { "findings": [ { "info_type": "DATE", "start": "0", "end": "10", "quote": "1900-12-24", } ] } } } } Each file consists of exactly one annotation. source can be only one of the following:

gcsSource

object(GcsSource)

Response body

If successful, the response body contains an instance of Operation.

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.

GcsSource

Specifies the configuration for importing data from Cloud Storage.

JSON representation
{ "uri": string }

Fields

Fields
`uri`	`string` Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: `gs://{bucket_id}/{objectId}`. The URI can include wildcards in `objectId` and thus identify multiple files. Supported wildcards: '' to match 0 or more non-separator characters '' to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .dcm), which imports all files with the extension in the specified directory and its sub-directories. For example, `gs://my-bucket/my-directory/*.json` imports all files with .json extensions in `my-directory/` and its sub-directories. '?' to match 1 character All other URI formats are invalid. Files matching the wildcard are expected to contain content only, no metadata.

uri

string

Points to a Cloud Storage URI containing file(s) with content only. The URI must be in the following format: gs://{bucket_id}/{objectId}. The URI can include wildcards in objectId and thus identify multiple files. Supported wildcards: '*' to match 0 or more non-separator characters '**' to match 0 or more characters (including separators). Must be used at the end of a path and with no other wildcards in the path. Can also be used with a file extension (such as .dcm), which imports all files with the extension in the specified directory and its sub-directories. For example, gs://my-bucket/my-directory/**.json imports all files with .json extensions in my-directory/ and its sub-directories. '?' to match 1 character All other URI formats are invalid. Files matching the wildcard are expected to contain content only, no metadata.