Stay organized with collections
Save and categorize content based on your preferences.
Full name: projects.locations.datasets.consentStores.consents.reject
Rejects the latest revision of the specified Consent by committing a new revision with state updated to REJECTED. If the latest revision of the specified Consent is in the REJECTED state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the ACTIVE or REVOKED state.
HTTP request
POST https://healthcare.googleapis.com/v1beta1/{name=projects/*/locations/*/datasets/*/consentStores/*/consents/*}:reject
Required. The resource name of the Consent to reject, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consents/{consentId}. An INVALID_ARGUMENT error occurs if revisionId is specified in the name.
Authorization requires the following IAM permission on the specified resource name:
healthcare.consents.reject
Request body
The request body contains data with the following structure:
JSON representation
{"consentArtifact": string}
Fields
consentArtifact
string
Optional. The resource name of the Consent artifact that contains documentation of the user's rejection of the draft Consent, of the form projects/{projectId}/locations/{locationId}/datasets/{datasetId}/consentStores/{consentStoreId}/consentArtifacts/{consent_artifact_id}. If the draft Consent had a Consent artifact, this Consent artifact overwrites it.
Authorization requires the following IAM permission on the specified resource consentArtifact:
healthcare.consentArtifacts.get
Response body
If successful, the response body contains an instance of Consent.
[[["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-04-01 UTC."],[[["This API endpoint (`projects.locations.datasets.consentStores.consents.reject`) is used to reject the latest revision of a specific Consent, updating its state to `REJECTED`."],["Rejecting a Consent involves committing a new revision unless the latest revision is already `REJECTED`, in which case no changes occur, and attempting to reject a Consent in `ACTIVE` or `REVOKED` state will result in a `FAILED_PRECONDITION` error."],["The `name` parameter is required and must follow a specific format to identify the Consent resource, and authorization requires the `healthcare.consents.reject` IAM permission."],["An optional `consentArtifact` can be included in the request body to document the user's rejection, requiring the `healthcare.consentArtifacts.get` IAM permission."],["A successful request returns an updated `Consent` resource, and authorization requires one of the specified OAuth scopes (`https://www.googleapis.com/auth/cloud-healthcare` or `https://www.googleapis.com/auth/cloud-platform`)."]]],[]]
