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": "5de53c5a-3b50-4d0d-8dbe-4c42abef2b0f",
  "tenantId": "5b208c99-fd06-411e-8888-8fe832cc0a43",
  "messageTypeId": "7fb1ab39-9422-405c-85ed-2bccecec6343",
  "messageTypeLookupKey": "sample string 4",
  "userId": "74838b37-cd57-4df0-a45f-e3c7985acb15",
  "userGroupId": "c896f1bd-c81a-46e0-b40a-532502210763",
  "deviceId": "8e7d29db-fd33-4e9c-a55c-c2540709e713",
  "deviceGroupId": "5c438b2b-ab2e-49a0-9ea3-e94317ddb28d",
  "applicationId": "6328cf26-df63-47a2-9d26-e9457a42029e",
  "applicationVersionId": "1334dccb-0b85-4d90-9b4a-a1c2971c78dc",
  "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": "fe59ee70-736d-4bc3-bdea-e2edf254d328",
  "messageAuditMessageAuditTypeId": "d7c73026-d695-49a8-9bb0-e51448e22c22",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-08-27T04:33:20.6889181+00:00",
  "messageAuditUpdatedDateUtc": "2026-08-27T04:33:20.6889181+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-08-27T04:33:20.6889181+00:00",
  "updatedDateUtc": "2026-08-27T04:33:20.6889181+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-08-27T04:33:20.6889181+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-27T04:33:20.6889181+00:00</UpdatedDateUtc>
  <ApplicationId>6328cf26-df63-47a2-9d26-e9457a42029e</ApplicationId>
  <ApplicationVersionId>1334dccb-0b85-4d90-9b4a-a1c2971c78dc</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>5c438b2b-ab2e-49a0-9ea3-e94317ddb28d</DeviceGroupId>
  <DeviceId>8e7d29db-fd33-4e9c-a55c-c2540709e713</DeviceId>
  <MessageAuditCreatedDateUtc>2026-08-27T04:33:20.6889181+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>fe59ee70-736d-4bc3-bdea-e2edf254d328</MessageAuditId>
  <MessageAuditMessageAuditTypeId>d7c73026-d695-49a8-9bb0-e51448e22c22</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-08-27T04:33:20.6889181+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>5de53c5a-3b50-4d0d-8dbe-4c42abef2b0f</MessageId>
  <MessageTypeId>7fb1ab39-9422-405c-85ed-2bccecec6343</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>5b208c99-fd06-411e-8888-8fe832cc0a43</TenantId>
  <UserGroupId>c896f1bd-c81a-46e0-b40a-532502210763</UserGroupId>
  <UserId>74838b37-cd57-4df0-a45f-e3c7985acb15</UserId>
</MessageRepresentation>