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": "1b302227-403e-435f-9ddf-8d761a68f8c7",
  "tenantId": "3b9c996c-a138-4216-be7b-f40873653618",
  "messageTypeId": "c6fbdf3a-6e41-4c41-9c2c-30fd9ac9f7fb",
  "messageTypeLookupKey": "sample string 4",
  "userId": "9b5aee37-59a8-4e33-bbcd-54bd877a535d",
  "userGroupId": "e36c18ad-35af-402a-aa02-8972d4374b62",
  "deviceId": "d5d1d991-4454-4156-bfb8-e08a00d5f6e0",
  "deviceGroupId": "dd77246c-4e47-4ab6-863e-269fbfca36b1",
  "applicationId": "963591b8-c734-4097-b6de-424593472740",
  "applicationVersionId": "9dd74b7e-6cbf-4351-a23c-47f7d5057c5b",
  "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": "581fee91-b7b5-429b-9a2c-bf8eaa09b490",
  "messageAuditMessageAuditTypeId": "80a6e149-056c-4516-bf1c-0a60362516ef",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-09-02T08:31:13.8620711+00:00",
  "messageAuditUpdatedDateUtc": "2026-09-02T08:31:13.8620711+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-09-02T08:31:13.8620711+00:00",
  "updatedDateUtc": "2026-09-02T08:31:13.8620711+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-09-02T08:31:13.8620711+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-02T08:31:13.8620711+00:00</UpdatedDateUtc>
  <ApplicationId>963591b8-c734-4097-b6de-424593472740</ApplicationId>
  <ApplicationVersionId>9dd74b7e-6cbf-4351-a23c-47f7d5057c5b</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>dd77246c-4e47-4ab6-863e-269fbfca36b1</DeviceGroupId>
  <DeviceId>d5d1d991-4454-4156-bfb8-e08a00d5f6e0</DeviceId>
  <MessageAuditCreatedDateUtc>2026-09-02T08:31:13.8620711+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>581fee91-b7b5-429b-9a2c-bf8eaa09b490</MessageAuditId>
  <MessageAuditMessageAuditTypeId>80a6e149-056c-4516-bf1c-0a60362516ef</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-09-02T08:31:13.8620711+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>1b302227-403e-435f-9ddf-8d761a68f8c7</MessageId>
  <MessageTypeId>c6fbdf3a-6e41-4c41-9c2c-30fd9ac9f7fb</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>3b9c996c-a138-4216-be7b-f40873653618</TenantId>
  <UserGroupId>e36c18ad-35af-402a-aa02-8972d4374b62</UserGroupId>
  <UserId>9b5aee37-59a8-4e33-bbcd-54bd877a535d</UserId>
</MessageRepresentation>