Method: instances.updateMetadata

Full name: projects.locations.datasets.dicomStores.studies.series.instances.updateMetadata

instances.updateMetadata modifies the metadata of a single instance.

The request body must contain a JSON Patch document specifying the updates to be applied to the metadata of the instance.

HTTP request

PATCH https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/dicomStores/*}/dicomWeb/{dicomWebPath=studies/*/series/*/instances/*}/metadata

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The name of the DICOM store that is being accessed (for example, projects/{projectId}/locations/{locationId}/datasets/{datasetId}/dicomStores/{dicomStoreId}).

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

  • healthcare.dicomStores.dicomWebUpdate
dicomWebPath

string

Required. The path of the instances.updateMetadata request (for example, studies/{studyUid}/series/{seriesUid}/instances/{instanceUid}).

Request body

The request body contains an instance of HttpBody.

Response body

If successful, the response is a generic HTTP response whose format is defined by the method.

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.