--- title: "GET /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores" method: GET path: "/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores" tags: ["projects"] --- # GET /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores `GET /v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores` ## Request - Base URL: `https://healthcare.googleapis.com` - URL: `https://healthcare.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores` - Auth: one of: - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-healthcare` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-healthcare` - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` - TypeScript: (a function with typed inputs; its response is checked against the schema) Lists the DICOM stores in the given dataset. ## Path parameters - `projectsId` string, required - `locationsId` string, required - `datasetsId` string, required ## Query parameters - `filter` string - `pageSize` integer - `pageToken` string ## Response `200` Successful response - ListDicomStoresResponse: Lists the DICOM stores in the given dataset. - `dicomStores` DicomStore[]: The returned DICOM stores. Won't be more DICOM stores than the value of page_size in the request. - `labels` object: User-supplied key-value pairs used to organize DICOM stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. - `name` string: Identifier. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. - `notificationConfig` NotificationConfig: Specifies where to send notifications upon changes to a data store. - `pubsubTopic` string: The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. - `sendForBulkImport` boolean: Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. - `notificationConfigs` DicomNotificationConfig[]: Optional. Specifies where and whether to send notifications upon changes to a DICOM store. - `pubsubTopic` string: Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - `streamConfigs` GoogleCloudHealthcareV1DicomStreamConfig[]: Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. - `bigqueryDestination` GoogleCloudHealthcareV1DicomBigQueryDestination: The BigQuery table where the server writes the output. - `force` boolean: Optional. Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. - `includeSourceStore` boolean: Optional. If true, the source store name will be included as a column in the BigQuery schema. - `schemaFlattened` SchemaFlattened: Using this field will flatten the DICOM instances into a BigQuery table. The table will have one column for each DICOM tag. The column name will be the DICOM tag's textual representation. - `schemaJson` SchemaJSON: Using this field will set the schema such that all DICOM tags will be included in the BigQuery table as a single JSON type column. The BigQuery table schema will include the following columns: * `StudyInstanceUID` (Type: STRING): DICOM Tag 0020000D. * `SeriesInstanceUID` (Type: STRING): DICOM Tag 0020000E. * `SOPInstanceUID` (Type: STRING): DICOM Tag 00080018. * `SourceDicomStore` (Type: STRING): The name of the source DICOM store. This field is only included if the `include_source_store` option is set to true. * `Metadata` (Type: JSON): All DICOM tags for the instance, stored in a single JSON object. * `StructuredStorageSize` (Type: INTEGER): Size of the structured storage in bytes. * `DroppedTags` (Type: STRING, Repeated: Yes): List of tags that were dropped during the conversion. * `StorageClass` (Type: STRING): The storage class of the instance. * `LastUpdated` (Type: TIMESTAMP): Timestamp of the last update to the instance. * `BlobStorageSize` (Type: INTEGER): Size of the blob storage in bytes. * `Type` (Type: STRING): Indicates the type of operation (e.g., INSERT, DELETE). - `tableUri` string: Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId` - `writeDisposition` 'WRITE_DISPOSITION_UNSPECIFIED' | 'WRITE_EMPTY' | 'WRITE_TRUNCATE' | 'WRITE_APPEND': Optional. Determines whether the existing table in the destination is to be overwritten or appended to. If a write_disposition is specified, the `force` parameter is ignored. - `nextPageToken` string: Token to retrieve the next page of results or empty if there are no more results in the list. ## Changes - **2026-10-30** `7027c0ced7f9`: 4 info - the security scope `https://www.googleapis.com/auth/cloud-healthcare` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-healthcare` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2c` [Operation history](https://skmtc.dev/google/apis/healthcare/changes/v1/projects/:projectsId/locations/:locationsId/datasets/:datasetsId/dicomStores/get.md) --- [API](https://skmtc.dev/google/apis/healthcare.md) - [All operations](https://skmtc.dev/google/apis/healthcare/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/healthcare/revisions/7027c0ced7f9?raw)