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": "1f5009ee-9b2d-443f-8d6c-0fb9f7748eab",
  "tenantId": "8ec350a0-9a01-45ee-83dd-d996f51fb4cd",
  "messageTypeId": "ab8c1bf8-9e39-4e03-8141-05b4bd1e910c",
  "messageTypeLookupKey": "sample string 4",
  "userId": "91bfa0fa-e0bf-4a11-9dab-a0af3d967f27",
  "userGroupId": "89fa1ff8-9a41-4e47-befc-772f85f54107",
  "deviceId": "de1ccbcd-1d4d-4fa8-8879-a94f94d3ad5d",
  "deviceGroupId": "9b12803e-203b-44f3-ab2d-bd19152f8e28",
  "applicationId": "67cf62aa-836c-4809-8f58-761f629f4f48",
  "applicationVersionId": "c6e7d3c1-b9c9-4167-bf2c-6a87bbf9bd9f",
  "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": "0a9bc5df-f5b6-4603-8a1b-471c3848c15f",
  "messageAuditMessageAuditTypeId": "580023de-138e-4a55-a474-bfca285823ad",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-08T20:42:18.4554517+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-08T20:42:18.4554517+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-08T20:42:18.4554517+00:00",
  "updatedDateUtc": "2026-06-08T20:42:18.4554517+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-08T20:42:18.4554517+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-08T20:42:18.4554517+00:00</UpdatedDateUtc>
  <ApplicationId>67cf62aa-836c-4809-8f58-761f629f4f48</ApplicationId>
  <ApplicationVersionId>c6e7d3c1-b9c9-4167-bf2c-6a87bbf9bd9f</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>9b12803e-203b-44f3-ab2d-bd19152f8e28</DeviceGroupId>
  <DeviceId>de1ccbcd-1d4d-4fa8-8879-a94f94d3ad5d</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-08T20:42:18.4554517+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>0a9bc5df-f5b6-4603-8a1b-471c3848c15f</MessageAuditId>
  <MessageAuditMessageAuditTypeId>580023de-138e-4a55-a474-bfca285823ad</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-08T20:42:18.4554517+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>1f5009ee-9b2d-443f-8d6c-0fb9f7748eab</MessageId>
  <MessageTypeId>ab8c1bf8-9e39-4e03-8141-05b4bd1e910c</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>8ec350a0-9a01-45ee-83dd-d996f51fb4cd</TenantId>
  <UserGroupId>89fa1ff8-9a41-4e47-befc-772f85f54107</UserGroupId>
  <UserId>91bfa0fa-e0bf-4a11-9dab-a0af3d967f27</UserId>
</MessageRepresentation>