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": "40ac0f7e-5014-4e6c-90e2-759bede21ab2",
  "tenantId": "132eedaf-0c15-4121-89e7-9809618bdab9",
  "messageTypeId": "33ba66fc-ae88-4376-b310-af947bf10b1d",
  "messageTypeLookupKey": "sample string 4",
  "userId": "cf5dddd4-4cd7-4de1-a7a6-acc4ba62286a",
  "userGroupId": "6b4fff36-a4e1-4e17-a8b2-3c9e2dcb09df",
  "deviceId": "7dce9f52-be1d-43b4-ad89-d10beccdbd23",
  "deviceGroupId": "533d0922-6921-43c3-92b6-c9ac66547a4f",
  "applicationId": "00f47896-d8d9-4f88-9fdc-e09c5d985675",
  "applicationVersionId": "e8dc25c8-81d0-4143-9db1-7c7b2d637892",
  "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": "c2be1697-ff57-4496-ac27-1b977dfb76d3",
  "messageAuditMessageAuditTypeId": "7781bdb7-283e-4c4c-ad7d-03ae1099cf8f",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-09-29T21:14:59.5171443+00:00",
  "messageAuditUpdatedDateUtc": "2026-09-29T21:14:59.5171443+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-09-29T21:14:59.5171443+00:00",
  "updatedDateUtc": "2026-09-29T21:14:59.5171443+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-29T21:14:59.5171443+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-29T21:14:59.5171443+00:00</UpdatedDateUtc>
  <ApplicationId>00f47896-d8d9-4f88-9fdc-e09c5d985675</ApplicationId>
  <ApplicationVersionId>e8dc25c8-81d0-4143-9db1-7c7b2d637892</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>533d0922-6921-43c3-92b6-c9ac66547a4f</DeviceGroupId>
  <DeviceId>7dce9f52-be1d-43b4-ad89-d10beccdbd23</DeviceId>
  <MessageAuditCreatedDateUtc>2026-09-29T21:14:59.5171443+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>c2be1697-ff57-4496-ac27-1b977dfb76d3</MessageAuditId>
  <MessageAuditMessageAuditTypeId>7781bdb7-283e-4c4c-ad7d-03ae1099cf8f</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-09-29T21:14:59.5171443+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>40ac0f7e-5014-4e6c-90e2-759bede21ab2</MessageId>
  <MessageTypeId>33ba66fc-ae88-4376-b310-af947bf10b1d</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>132eedaf-0c15-4121-89e7-9809618bdab9</TenantId>
  <UserGroupId>6b4fff36-a4e1-4e17-a8b2-3c9e2dcb09df</UserGroupId>
  <UserId>cf5dddd4-4cd7-4de1-a7a6-acc4ba62286a</UserId>
</MessageRepresentation>