healthcare.projects.locations.datasets.hl7V2Stores.messages.patch

PATCH {{baseUrl}}/v1/:name?updateMask=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated.

Request Params

KeyDatatypeRequiredDescription
updateMaskstringThe update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

Request Body

{"data"=>"<byte>", "labels"=>"<object>", "messageType"=>"<string>", "name"=>"<string>", "patientIds"=>[{"type"=>"<string>", "value"=>"<string>"}, {"type"=>"<string>", "value"=>"<string>"}], "sendFacility"=>"<string>", "sendTime"=>"<google-datetime>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;createTime&quot;:&quot;occaecat&quot;,&quot;data&quot;:&quot;\u003cbyte\u003e&quot;,&quot;labels&quot;:&quot;\u003cobject\u003e&quot;,&quot;messageType&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;parsedData&quot;:{&quot;segments&quot;:[{&quot;fields&quot;:{},&quot;segmentId&quot;:&quot;Lore&quot;,&quot;setId&quot;:&quot;dolor&quot;},{&quot;fields&quot;:{},&quot;segmentId&quot;:&quot;non ullamco ut aliquip cillum&quot;,&quot;setId&quot;:&quot;exercitation eiusmod&quot;}]},&quot;patientIds&quot;:[{&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;},{&quot;type&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;}],&quot;sendFacility&quot;:&quot;\u003cstring\u003e&quot;,&quot;sendTime&quot;:&quot;\u003cgoogle-datetime\u003e&quot;}