Full name: projects.locations.datasets.hl7V2Stores.messages.list
Lists all the messages in the given HL7v2 store with support for filtering.
Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter.
HTTP request
GET https://healthcare.googleapis.com/v1beta1/{parent=projects/*/locations/*/datasets/*/hl7V2Stores/*}/messages
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Name of the HL7v2 store to retrieve messages from. Authorization requires the following Google IAM permission on the specified resource
|
Query parameters
Parameters | |
---|---|
pageSize |
Limit on the number of messages to return in a single response. If zero the default page size of 100 is used. |
pageToken |
The nextPageToken value returned from the previous List request, if any. |
filter |
Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are:
Limitations on conjunctions:
|
orderBy |
Orders messages returned by the specified orderBy clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are:
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Lists the messages in the specified HL7v2 store.
JSON representation | |
---|---|
{ "messages": [ string ], "nextPageToken": string } |
Fields | |
---|---|
messages[] |
The returned message names. Won't be more values than the value of pageSize in the request. |
nextPageToken |
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.