Cyan Web API - Version 1

GET api/messages/{messageId}

            Gets a Message.

Request Information

Parameters

Name	Description	Additional information
messageId		Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "messageId": "3b5e1622-5912-49f2-a311-6ac142beab0e",
  "tenantId": "63a1ee2e-28ce-4ac9-a79c-1002bdd1ae98",
  "messageTypeId": "9ff6a9d3-2a51-4bc8-aadf-edf0ed8323ec",
  "messageTypeLookupKey": "sample string 4",
  "userId": "d396d32c-f244-4382-8234-64c2c9d170a4",
  "userGroupId": "08e43854-f85d-411d-a7e3-3da24ce83a98",
  "deviceId": "bd9f74b4-6d32-4aed-89a0-a18e6e713abf",
  "deviceGroupId": "532fca78-0e9a-47c7-b4a1-9e7b7de528ef",
  "applicationId": "4abb309b-6ddd-420a-b819-59f1fa2831ad",
  "applicationVersionId": "f72dbf50-ba73-4086-a966-820c42fa130f",
  "senderSessionId": "sample string 5",
  "senderSessionSequence": 1,
  "senderCorrelationId": "sample string 6",
  "senderGroup": "sample string 7",
  "senderNote": "sample string 8",
  "body": "sample string 9",
  "storeEncryptedPassword": true,
  "storeHashedPassword": true,
  "messageAuditId": "50571f5d-50e8-4017-8563-4a22631c9159",
  "messageAuditMessageAuditTypeId": "f54505b9-12dd-4ba0-8329-b1969a2b45df",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-05-13T00:08:48.5635985+00:00",
  "messageAuditUpdatedDateUtc": "2026-05-13T00:08:48.5635985+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-05-13T00:08:48.5635985+00:00",
  "updatedDateUtc": "2026-05-13T00:08:48.5635985+00:00"
}

application/xml, text/xml

Sample:

<MessageRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2026-05-13T00:08:48.5635985+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-05-13T00:08:48.5635985+00:00</UpdatedDateUtc>
  <ApplicationId>4abb309b-6ddd-420a-b819-59f1fa2831ad</ApplicationId>
  <ApplicationVersionId>f72dbf50-ba73-4086-a966-820c42fa130f</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>532fca78-0e9a-47c7-b4a1-9e7b7de528ef</DeviceGroupId>
  <DeviceId>bd9f74b4-6d32-4aed-89a0-a18e6e713abf</DeviceId>
  <MessageAuditCreatedDateUtc>2026-05-13T00:08:48.5635985+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>50571f5d-50e8-4017-8563-4a22631c9159</MessageAuditId>
  <MessageAuditMessageAuditTypeId>f54505b9-12dd-4ba0-8329-b1969a2b45df</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-05-13T00:08:48.5635985+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>3b5e1622-5912-49f2-a311-6ac142beab0e</MessageId>
  <MessageTypeId>9ff6a9d3-2a51-4bc8-aadf-edf0ed8323ec</MessageTypeId>
  <MessageTypeLookupKey>sample string 4</MessageTypeLookupKey>
  <ResubmitCount>19</ResubmitCount>
  <SenderCorrelationId>sample string 6</SenderCorrelationId>
  <SenderGroup>sample string 7</SenderGroup>
  <SenderNote>sample string 8</SenderNote>
  <SenderSessionId>sample string 5</SenderSessionId>
  <SenderSessionSequence>1</SenderSessionSequence>
  <StoreEncryptedPassword>true</StoreEncryptedPassword>
  <StoreHashedPassword>true</StoreHashedPassword>
  <TenantId>63a1ee2e-28ce-4ac9-a79c-1002bdd1ae98</TenantId>
  <UserGroupId>08e43854-f85d-411d-a7e3-3da24ce83a98</UserGroupId>
  <UserId>d396d32c-f244-4382-8234-64c2c9d170a4</UserId>
</MessageRepresentation>