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": "86a0e29f-2eea-4d52-b4ea-124a310a2e20",
  "tenantId": "ab6cce48-d2f1-4f7d-91b6-07aff5547f42",
  "messageTypeId": "1ecab073-c44c-40bd-aedf-d417be721471",
  "messageTypeLookupKey": "sample string 4",
  "userId": "0c7f68d5-8624-4b18-a732-7a6563f6855a",
  "userGroupId": "68c7a0d5-ea34-4722-97e5-d369b239b9da",
  "deviceId": "55064868-5336-47bc-8fe5-ee980d9a6f82",
  "deviceGroupId": "3cbf8853-83a7-4736-9c86-663d03ea2ccf",
  "applicationId": "18a14dcf-feb0-4c6a-b2e5-684e4d706349",
  "applicationVersionId": "40101d04-7f88-4de1-ace5-175a846f07f1",
  "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": "2fdecc91-3b69-4f24-9850-88c3265f5000",
  "messageAuditMessageAuditTypeId": "0e760e1a-d069-4612-9f9c-e3a082678556",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-02-01T08:31:56.6563618+00:00",
  "messageAuditUpdatedDateUtc": "2026-02-01T08:31:56.6563618+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-02-01T08:31:56.6563618+00:00",
  "updatedDateUtc": "2026-02-01T08:31:56.6563618+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-02-01T08:31:56.6563618+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-01T08:31:56.6563618+00:00</UpdatedDateUtc>
  <ApplicationId>18a14dcf-feb0-4c6a-b2e5-684e4d706349</ApplicationId>
  <ApplicationVersionId>40101d04-7f88-4de1-ace5-175a846f07f1</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>3cbf8853-83a7-4736-9c86-663d03ea2ccf</DeviceGroupId>
  <DeviceId>55064868-5336-47bc-8fe5-ee980d9a6f82</DeviceId>
  <MessageAuditCreatedDateUtc>2026-02-01T08:31:56.6563618+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>2fdecc91-3b69-4f24-9850-88c3265f5000</MessageAuditId>
  <MessageAuditMessageAuditTypeId>0e760e1a-d069-4612-9f9c-e3a082678556</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-02-01T08:31:56.6563618+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>86a0e29f-2eea-4d52-b4ea-124a310a2e20</MessageId>
  <MessageTypeId>1ecab073-c44c-40bd-aedf-d417be721471</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>ab6cce48-d2f1-4f7d-91b6-07aff5547f42</TenantId>
  <UserGroupId>68c7a0d5-ea34-4722-97e5-d369b239b9da</UserGroupId>
  <UserId>0c7f68d5-8624-4b18-a732-7a6563f6855a</UserId>
</MessageRepresentation>