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": "cefd01e4-7a36-4ca9-83f3-b52cb092b60a",
  "tenantId": "5b87524d-d649-45a1-a9eb-a0dfbb3a35e9",
  "messageTypeId": "0667d8ed-2709-406d-a7a3-f4537a030828",
  "messageTypeLookupKey": "sample string 4",
  "userId": "a6f146b9-fac7-410e-97d2-3a3ccc1b6c24",
  "userGroupId": "843a5285-324a-486c-93c9-5ee3d33f52eb",
  "deviceId": "30f88b63-d4f8-4ef4-83eb-207c02c05a63",
  "deviceGroupId": "1b2ce605-ab67-44f0-a1b3-cbce593421d9",
  "applicationId": "e0ae5db4-293b-4c17-8b2c-125de429b92c",
  "applicationVersionId": "b3bcc477-5424-42ca-8bcc-6c19f1efe864",
  "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": "4ee98dcf-34ba-450f-94eb-ca39e0b63e70",
  "messageAuditMessageAuditTypeId": "a999f48a-5dfc-44b0-bc9b-923bc418e45d",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-24T23:05:20.9511447+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-24T23:05:20.9511447+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-24T23:05:20.9511447+00:00",
  "updatedDateUtc": "2026-06-24T23:05:20.9511447+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-24T23:05:20.9511447+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-24T23:05:20.9511447+00:00</UpdatedDateUtc>
  <ApplicationId>e0ae5db4-293b-4c17-8b2c-125de429b92c</ApplicationId>
  <ApplicationVersionId>b3bcc477-5424-42ca-8bcc-6c19f1efe864</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>1b2ce605-ab67-44f0-a1b3-cbce593421d9</DeviceGroupId>
  <DeviceId>30f88b63-d4f8-4ef4-83eb-207c02c05a63</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-24T23:05:20.9511447+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>4ee98dcf-34ba-450f-94eb-ca39e0b63e70</MessageAuditId>
  <MessageAuditMessageAuditTypeId>a999f48a-5dfc-44b0-bc9b-923bc418e45d</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-24T23:05:20.9511447+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>cefd01e4-7a36-4ca9-83f3-b52cb092b60a</MessageId>
  <MessageTypeId>0667d8ed-2709-406d-a7a3-f4537a030828</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>5b87524d-d649-45a1-a9eb-a0dfbb3a35e9</TenantId>
  <UserGroupId>843a5285-324a-486c-93c9-5ee3d33f52eb</UserGroupId>
  <UserId>a6f146b9-fac7-410e-97d2-3a3ccc1b6c24</UserId>
</MessageRepresentation>