Google Cloud Healthcare projects API
The projects API from Google Cloud Healthcare — 111 operation(s) for projects.
The projects API from Google Cloud Healthcare — 111 operation(s) for projects.
openapi: 3.0.0
info:
contact:
name: Google
url: https://google.com
x-twitter: youtube
description: Manage, store, and access healthcare data in Google Cloud Platform.
license:
name: Creative Commons Attribution 3.0
url: http://creativecommons.org/licenses/by/3.0/
termsOfService: https://developers.google.com/terms/
title: Cloud Healthcare projects API
version: v1
x-apiClientRegistration:
url: https://console.developers.google.com
x-apisguru-categories:
- analytics
- media
x-logo:
url: https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png
x-origin:
- format: google
url: https://healthcare.googleapis.com/$discovery/rest?version=v1
version: v1
x-preferred: false
x-providerName: googleapis.com
x-serviceName: healthcare
servers:
- url: https://healthcare.googleapis.com/
tags:
- name: projects
paths:
/v1/{consentStore}:checkDataAccess:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
post:
description: Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.
operationId: healthcare.projects.locations.datasets.consentStores.checkDataAccess
parameters:
- description: Required. Name of the consent store where the requested data_id is stored, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`.
in: path
name: consentStore
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CheckDataAccessRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CheckDataAccessResponse'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
/v1/{consentStore}:evaluateUserConsents:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
post:
description: 'Evaluates the user''s Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated and when they are included in EvaluateUserConsents results.'
operationId: healthcare.projects.locations.datasets.consentStores.evaluateUserConsents
parameters:
- description: Required. Name of the consent store to retrieve User data mappings from.
in: path
name: consentStore
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EvaluateUserConsentsRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EvaluateUserConsentsResponse'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
/v1/{consentStore}:queryAccessibleData:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
post:
description: 'Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. If the request is successful, a detailed response is returned of type QueryAccessibleDataResponse, 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)). For example, the following sample log entry shows a `failed to evaluate consent policy` error that occurred during a QueryAccessibleData call to consent store `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. ```json jsonPayload: { @type: "type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDataLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}" } logName: "projects/{project_id}/logs/healthcare.googleapis.com%2Fquery_accessible_data" operation: { id: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/operations/{operation_id}" producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP" resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}" location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" } severity: "ERROR" timestamp: "TIMESTAMP" ```'
operationId: healthcare.projects.locations.datasets.consentStores.queryAccessibleData
parameters:
- description: Required. Name of the consent store to retrieve User data mappings from.
in: path
name: consentStore
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QueryAccessibleDataRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
/v1/{name}:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
delete:
description: Deletes an HL7v2 message.
operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.delete
parameters:
- description: Required. The resource name of the HL7v2 message to delete.
in: path
name: name
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Empty'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
get:
description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
operationId: healthcare.projects.locations.datasets.operations.get
parameters:
- description: The name of the operation resource.
in: path
name: name
required: true
schema:
type: string
- description: Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL.
in: query
name: view
schema:
enum:
- MESSAGE_VIEW_UNSPECIFIED
- RAW_ONLY
- PARSED_ONLY
- FULL
- SCHEMATIZED_ONLY
- BASIC
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
patch:
description: Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated.
operationId: healthcare.projects.locations.datasets.hl7V2Stores.messages.patch
parameters:
- description: Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server.
in: path
name: name
required: true
schema:
type: string
- 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
in: query
name: updateMask
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
put:
description: 'Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).'
operationId: healthcare.projects.locations.datasets.fhirStores.fhir.update
parameters:
- description: Required. The name of the resource to update.
in: path
name: name
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HttpBody'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HttpBody'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
/v1/{name}/$everything:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
get:
description: 'Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).'
operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything
parameters:
- description: Required. Name of the `Patient` resource for which the information is required.
in: path
name: name
required: true
schema:
type: string
- description: Optional. Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.
in: query
name: _count
schema:
type: integer
- description: Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made.
in: query
name: _page_token
schema:
type: string
- description: Optional. If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.
in: query
name: _since
schema:
type: string
- description: Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned. Specifying multiple `_type` parameters isn't supported. For example, the result of `_type=Observation&_type=Encounter` is undefined. Use `_type=Observation,Encounter` instead.
in: query
name: _type
schema:
type: string
- description: Optional. The response includes records prior to the end date. The date uses the format YYYY-MM-DD. If no end date is provided, all records subsequent to the start date are in scope.
in: query
name: end
schema:
type: string
- description: Optional. The response includes records subsequent to the start date. The date uses the format YYYY-MM-DD. If no start date is provided, all records prior to the end date are in scope.
in: query
name: start
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HttpBody'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
/v1/{name}/$purge:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
delete:
description: Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call `Resource-purge`, see [Deleting historical versions of a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#deleting_historical_versions_of_a_fhir_resource).
operationId: healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge
parameters:
- description: Required. The name of the resource to purge.
in: path
name: name
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Empty'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
/v1/{name}/_history:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
get:
description: Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see [Listing FHIR resource versions](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_versions).
operationId: healthcare.projects.locations.datasets.fhirStores.fhir.history
parameters:
- description: Required. The name of the resource to retrieve.
in: path
name: name
required: true
schema:
type: string
- description: 'Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z`'
in: query
name: _at
schema:
type: string
- description: The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000.
in: query
name: _count
schema:
type: integer
- description: Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made.
in: query
name: _page_token
schema:
type: string
- description: Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone.
in: query
name: _since
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HttpBody'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
/v1/{name}/fhir/metadata:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
get:
description: Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.
operationId: healthcare.projects.locations.datasets.fhirStores.fhir.capabilities
parameters:
- description: Required. Name of the FHIR store to retrieve the capabilities for.
in: path
name: name
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HttpBody'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
/v1/{name}/locations:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
get:
description: Lists information about the supported locations for this service.
operationId: healthcare.projects.locations.list
parameters:
- description: The resource that owns the locations collection, if applicable.
in: path
name: name
required: true
schema:
type: string
- description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
in: query
name: filter
schema:
type: string
- description: The maximum number of results to return. If not set, the service selects a default.
in: query
name: pageSize
schema:
type: integer
- description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
in: query
name: pageToken
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListLocationsResponse'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
/v1/{name}/operations:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
get:
description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
operationId: healthcare.projects.locations.datasets.operations.list
parameters:
- description: The name of the operation's parent resource.
in: path
name: name
required: true
schema:
type: string
- description: The standard list filter.
in: query
name: filter
schema:
type: string
- description: The standard list page size.
in: query
name: pageSize
schema:
type: integer
- description: The standard list page token.
in: query
name: pageToken
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListOperationsResponse'
description: Successful response
security:
- Oauth2:
- https://www.googleapis.com/auth/cloud-healthcare
Oauth2c:
- https://www.googleapis.com/auth/cloud-healthcare
- Oauth2:
- https://www.googleapis.com/auth/cloud-platform
Oauth2c:
- https://www.googleapis.com/auth/cloud-platform
tags:
- projects
/v1/{name}:activate:
parameters:
- $ref: '#/components/parameters/_.xgafv'
- $ref: '#/components/parameters/access_token'
- $ref: '#/components/parameters/alt'
- $ref: '#/components/parameters/callback'
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/key'
- $ref: '#/components/parameters/oauth_token'
- $ref: '#/components/parameters/prettyPrint'
- $ref: '#/components/parameters/quotaUser'
- $ref: '#/components/parameters/upload_protocol'
- $ref: '#/components/parameters/uploadType'
post:
# --- truncated at 32 KB (573 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/google-cloud-healthcare/refs/heads/main/openapi/google-cloud-healthcare-projects-api-openapi.yml