Method: consents.list

Full name: projects.locations.datasets.consentStores.consents.list

Lists the Consent in the given consent store, returning each Consent's latest revision.

HTTP request

GET https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/consentStores/*}/consents

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the consent store to retrieve Consents from.

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

  • healthcare.consents.list

Query parameters

Parameters
pageSize

integer

Optional. Limit on the number of Consents to return in a single response. If not specified, 100 is used. May not be larger than 1000.

pageToken

string

Optional. The nextPageToken value returned from the previous List request, if any.

filter

string

Optional. Restricts the consents returned to those matching a filter. The following syntax is available:

  • A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality(=), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with great in the comment field.
  • A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator(=), along with the less than/greater than operators(<, <=, >, >=). Note that there is no inequality (!=) operator. You can prepend the NOT operator to an expression to negate it.
  • A date field value must be written in yyyy-mm-dd form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator(=) , along with the less than/greater than operators(<, <=, >, >=). Note that there is no inequality(!=) operator. You can prepend the NOT operator to an expression to negate it.
  • Multiple field query expressions can be combined in one query by adding AND or OR operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the NOT operator to an expression to negate it.

The fields available for filtering are:

  • userId. For example, filter='userId="user123"'.
  • consentArtifact
  • state
  • revisionCreateTime
  • metadata. For example, filter=Metadata(\"testkey\")=\"value\" or filter=HasMetadata(\"testkey\").

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "consents": [
    {
      object(Consent)
    }
  ],
  "nextPageToken": string
}
Fields
consents[]

object(Consent)

The returned Consents. The maximum number of Consents returned is determined by the value of pageSize in the ListConsentsRequest.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

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.