consent_artifacts

Creates, updates, deletes, gets or lists a consent_artifacts resource.

Overview

Name	consent_artifacts
Type	Resource
Id	google.healthcare.consent_artifacts

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the Consent artifact, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}. Cannot be changed after creation.
consentContentScreenshots	array	Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
consentContentVersion	string	Optional. An string indicating the version of the consent information shown to the user.
guardianSignature	object	Optional. A signature from a guardian. (id: Signature)
metadata	object	Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
userId	string	Required. User's UUID provided by the client.
userSignature	object	Optional. User's signature. (id: Signature)
witnessSignature	object	Optional. A signature from a witness. (id: Signature)

list

Successful response

Name	Datatype	Description
name	string	Identifier. Resource name of the Consent artifact, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}. Cannot be changed after creation.
consentContentScreenshots	array	Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
consentContentVersion	string	Optional. An string indicating the version of the consent information shown to the user.
guardianSignature	object	Optional. A signature from a guardian. (id: Signature)
metadata	object	Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
userId	string	Required. User's UUID provided by the client.
userSignature	object	Optional. User's signature. (id: Signature)
witnessSignature	object	Optional. A signature from a witness. (id: Signature)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, datasetsId, consentStoresId, consentArtifactsId		Gets the specified Consent artifact.
list	select	projectsId, locationsId, datasetsId, consentStoresId	pageSize, pageToken, filter	Lists the Consent artifacts in the specified consent store.
create	insert	projectsId, locationsId, datasetsId, consentStoresId		Creates a new Consent artifact in the parent consent store.
delete	delete	projectsId, locationsId, datasetsId, consentStoresId, consentArtifactsId		Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
consentArtifactsId	string
consentStoresId	string
datasetsId	string
locationsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Gets the specified Consent artifact.

SELECT
name,
consentContentScreenshots,
consentContentVersion,
guardianSignature,
metadata,
userId,
userSignature,
witnessSignature
FROM google.healthcare.consent_artifacts
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND consentStoresId = '{{ consentStoresId }}' -- required
AND consentArtifactsId = '{{ consentArtifactsId }}' -- required;

list

Lists the Consent artifacts in the specified consent store.

SELECT
name,
consentContentScreenshots,
consentContentVersion,
guardianSignature,
metadata,
userId,
userSignature,
witnessSignature
FROM google.healthcare.consent_artifacts
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND consentStoresId = '{{ consentStoresId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

INSERT examples

create

Creates a new Consent artifact in the parent consent store.

INSERT INTO google.healthcare.consent_artifacts (
data__name,
data__userId,
data__userSignature,
data__guardianSignature,
data__witnessSignature,
data__consentContentScreenshots,
data__consentContentVersion,
data__metadata,
projectsId,
locationsId,
datasetsId,
consentStoresId
)
SELECT 
'{{ name }}',
'{{ userId }}',
'{{ userSignature }}',
'{{ guardianSignature }}',
'{{ witnessSignature }}',
'{{ consentContentScreenshots }}',
'{{ consentContentVersion }}',
'{{ metadata }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ datasetsId }}',
'{{ consentStoresId }}'
RETURNING
name,
consentContentScreenshots,
consentContentVersion,
guardianSignature,
metadata,
userId,
userSignature,
witnessSignature
;

Manifest

# Description fields are for documentation purposes
- name: consent_artifacts
  props:
    - name: projectsId
      value: string
      description: Required parameter for the consent_artifacts resource.
    - name: locationsId
      value: string
      description: Required parameter for the consent_artifacts resource.
    - name: datasetsId
      value: string
      description: Required parameter for the consent_artifacts resource.
    - name: consentStoresId
      value: string
      description: Required parameter for the consent_artifacts resource.
    - name: name
      value: string
      description: >
        Identifier. Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be changed after creation.
        
    - name: userId
      value: string
      description: >
        Required. User's UUID provided by the client.
        
    - name: userSignature
      value: object
      description: >
        Optional. User's signature.
        
    - name: guardianSignature
      value: object
      description: >
        Optional. A signature from a guardian.
        
    - name: witnessSignature
      value: object
      description: >
        Optional. A signature from a witness.
        
    - name: consentContentScreenshots
      value: array
      description: >
        Optional. Screenshots, PDFs, or other binary information documenting the user's consent.
        
    - name: consentContentVersion
      value: string
      description: >
        Optional. An string indicating the version of the consent information shown to the user.
        
    - name: metadata
      value: object
      description: >
        Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version.
        

DELETE examples

delete

Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.

DELETE FROM google.healthcare.consent_artifacts
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND consentStoresId = '{{ consentStoresId }}' --required
AND consentArtifactsId = '{{ consentArtifactsId }}' --required;