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/v1/{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-01-28 UTC."],[[["This API endpoint, `projects.locations.datasets.consentStores.consents.reject`, is used to reject the latest revision of a specified Consent by updating its state to `REJECTED`."],["A new revision is not committed if the latest revision of the Consent is already in the `REJECTED` state, but an error will occur if it is in the `ACTIVE` or `REVOKED` state."],["The API uses a `POST` request to the specified URL, which includes parameters like `projects`, `locations`, `datasets`, `consentStores`, and `consents` to identify the target consent."],["The request body can optionally include a `consentArtifact` which references the document of the user's rejection, and the proper IAM authorization is needed to access this artifact."],["Successful requests will return a `Consent` instance, and the API requires specific OAuth scopes for authentication and authorization."]]],[]]
