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": "3833d274-e280-444c-95d4-6819a206b4b0",
  "tenantId": "869c060c-c5d4-4978-b04a-466fe1b7194d",
  "messageTypeId": "437ac10c-32de-43e3-a6a8-689130c07b85",
  "messageTypeLookupKey": "sample string 4",
  "userId": "c93ef76c-5259-45cd-b39d-7d7217b903c2",
  "userGroupId": "194e549b-20e0-4917-8282-ccdcb2b74b22",
  "deviceId": "5c9006b2-f8a8-4c0e-ac30-cb591e719e94",
  "deviceGroupId": "bc1edbd4-47d8-4a07-9db0-063bbf9df4ea",
  "applicationId": "e06049a2-efd2-427b-b5ff-9112e556831c",
  "applicationVersionId": "aa6c6f96-caf0-47b5-9a38-913209102632",
  "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": "b137a20a-8e1f-4454-a211-6cd1f2779473",
  "messageAuditMessageAuditTypeId": "fe2f1241-0c98-4a13-ab9d-98146a0f6b86",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-07T17:42:55.8215982+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-07T17:42:55.8215982+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-07T17:42:55.8215982+00:00",
  "updatedDateUtc": "2026-03-07T17:42:55.8215982+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-03-07T17:42:55.8215982+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-07T17:42:55.8215982+00:00</UpdatedDateUtc>
  <ApplicationId>e06049a2-efd2-427b-b5ff-9112e556831c</ApplicationId>
  <ApplicationVersionId>aa6c6f96-caf0-47b5-9a38-913209102632</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>bc1edbd4-47d8-4a07-9db0-063bbf9df4ea</DeviceGroupId>
  <DeviceId>5c9006b2-f8a8-4c0e-ac30-cb591e719e94</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-07T17:42:55.8215982+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>b137a20a-8e1f-4454-a211-6cd1f2779473</MessageAuditId>
  <MessageAuditMessageAuditTypeId>fe2f1241-0c98-4a13-ab9d-98146a0f6b86</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-07T17:42:55.8215982+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>3833d274-e280-444c-95d4-6819a206b4b0</MessageId>
  <MessageTypeId>437ac10c-32de-43e3-a6a8-689130c07b85</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>869c060c-c5d4-4978-b04a-466fe1b7194d</TenantId>
  <UserGroupId>194e549b-20e0-4917-8282-ccdcb2b74b22</UserGroupId>
  <UserId>c93ef76c-5259-45cd-b39d-7d7217b903c2</UserId>
</MessageRepresentation>