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": "5e2ed7e1-b5d9-45ee-bbab-28e6c335dec5",
  "tenantId": "19050178-f8b7-4fa6-b81a-0477ff3c2e21",
  "messageTypeId": "97c313ff-e78b-40d1-bd27-4e22b4fbb553",
  "messageTypeLookupKey": "sample string 4",
  "userId": "3f82c0a1-92d1-4acf-bdb9-55ff3437e41d",
  "userGroupId": "e41df389-61c1-4605-8d6a-a35e6f19af55",
  "deviceId": "64924a16-3696-4708-9727-1e48df88765d",
  "deviceGroupId": "aa85e69c-b1e4-4b58-8962-2b672ba76f42",
  "applicationId": "19264a5a-ebc7-47ef-bba4-7c504ea558dc",
  "applicationVersionId": "4dd16f4f-7745-464c-be9d-769a372e41b1",
  "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": "5cf3e122-6cea-4533-ac0e-b715d96ffd48",
  "messageAuditMessageAuditTypeId": "9e96426c-4e8c-480c-a186-900dfdc383c1",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-05T15:14:26.165108+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-05T15:14:26.165108+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-05T15:14:26.165108+00:00",
  "updatedDateUtc": "2026-06-05T15:14:26.165108+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-06-05T15:14:26.165108+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-05T15:14:26.165108+00:00</UpdatedDateUtc>
  <ApplicationId>19264a5a-ebc7-47ef-bba4-7c504ea558dc</ApplicationId>
  <ApplicationVersionId>4dd16f4f-7745-464c-be9d-769a372e41b1</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>aa85e69c-b1e4-4b58-8962-2b672ba76f42</DeviceGroupId>
  <DeviceId>64924a16-3696-4708-9727-1e48df88765d</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-05T15:14:26.165108+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>5cf3e122-6cea-4533-ac0e-b715d96ffd48</MessageAuditId>
  <MessageAuditMessageAuditTypeId>9e96426c-4e8c-480c-a186-900dfdc383c1</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-05T15:14:26.165108+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>5e2ed7e1-b5d9-45ee-bbab-28e6c335dec5</MessageId>
  <MessageTypeId>97c313ff-e78b-40d1-bd27-4e22b4fbb553</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>19050178-f8b7-4fa6-b81a-0477ff3c2e21</TenantId>
  <UserGroupId>e41df389-61c1-4605-8d6a-a35e6f19af55</UserGroupId>
  <UserId>3f82c0a1-92d1-4acf-bdb9-55ff3437e41d</UserId>
</MessageRepresentation>