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": "963465fd-e0b3-4615-839d-0ac6ef8aa9c7",
  "tenantId": "636c9b16-b2ff-469f-91d5-a41af8581034",
  "messageTypeId": "452f53a4-1993-459a-adf8-25094d0f9165",
  "messageTypeLookupKey": "sample string 4",
  "userId": "84127b78-6cc2-4623-ba09-3fe086accda9",
  "userGroupId": "b96236ba-dd74-4acd-9e43-874daf527a92",
  "deviceId": "4fb4cb25-a969-4b83-9975-a68322c3648b",
  "deviceGroupId": "f9c6d1c3-9311-41b1-9fb5-bac3de04e432",
  "applicationId": "4dce0486-d1da-4c89-afaa-5e682b21f576",
  "applicationVersionId": "f351f9bf-4d79-4bf4-a2af-34b90be959cb",
  "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": "369a03a4-c722-47af-8e00-468db25f68d8",
  "messageAuditMessageAuditTypeId": "68afe9be-3ae4-433a-8d88-89c8b2c3191b",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-06T09:04:26.4293804+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-06T09:04:26.4293804+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-06T09:04:26.4293804+00:00",
  "updatedDateUtc": "2026-06-06T09:04:26.4293804+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-06T09:04:26.4293804+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-06T09:04:26.4293804+00:00</UpdatedDateUtc>
  <ApplicationId>4dce0486-d1da-4c89-afaa-5e682b21f576</ApplicationId>
  <ApplicationVersionId>f351f9bf-4d79-4bf4-a2af-34b90be959cb</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>f9c6d1c3-9311-41b1-9fb5-bac3de04e432</DeviceGroupId>
  <DeviceId>4fb4cb25-a969-4b83-9975-a68322c3648b</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-06T09:04:26.4293804+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>369a03a4-c722-47af-8e00-468db25f68d8</MessageAuditId>
  <MessageAuditMessageAuditTypeId>68afe9be-3ae4-433a-8d88-89c8b2c3191b</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-06T09:04:26.4293804+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>963465fd-e0b3-4615-839d-0ac6ef8aa9c7</MessageId>
  <MessageTypeId>452f53a4-1993-459a-adf8-25094d0f9165</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>636c9b16-b2ff-469f-91d5-a41af8581034</TenantId>
  <UserGroupId>b96236ba-dd74-4acd-9e43-874daf527a92</UserGroupId>
  <UserId>84127b78-6cc2-4623-ba09-3fe086accda9</UserId>
</MessageRepresentation>