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": "75fee352-843b-4139-a038-d1518f4e9b11",
  "tenantId": "52df0eb2-a6b9-499f-b540-68ea86d4e0bd",
  "messageTypeId": "4e68201f-2221-4926-a1f2-1d895bc12a08",
  "messageTypeLookupKey": "sample string 4",
  "userId": "ecdceec1-b5f5-4c02-b1ae-9323e5462247",
  "userGroupId": "d43a3b23-f384-4eca-9b4a-9882b45c90a2",
  "deviceId": "7ec5d47c-22cc-4380-adad-fcc3e89d6af4",
  "deviceGroupId": "e4537821-a2e4-4027-a289-0e9f344fb9d6",
  "applicationId": "3261deea-1131-4ef5-ae8d-00c4acd1f10f",
  "applicationVersionId": "81e044bd-72ea-4961-9a23-fe886fbc598d",
  "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": "0e9b52c4-3a0b-454c-ad9f-7ec61d6e13e1",
  "messageAuditMessageAuditTypeId": "c1a3a0a7-8f8d-453f-b21a-45f67fcff099",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-05-20T00:47:33.4601992+00:00",
  "messageAuditUpdatedDateUtc": "2026-05-20T00:47:33.4601992+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-05-20T00:47:33.4601992+00:00",
  "updatedDateUtc": "2026-05-20T00:47:33.4601992+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-05-20T00:47:33.4601992+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-05-20T00:47:33.4601992+00:00</UpdatedDateUtc>
  <ApplicationId>3261deea-1131-4ef5-ae8d-00c4acd1f10f</ApplicationId>
  <ApplicationVersionId>81e044bd-72ea-4961-9a23-fe886fbc598d</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>e4537821-a2e4-4027-a289-0e9f344fb9d6</DeviceGroupId>
  <DeviceId>7ec5d47c-22cc-4380-adad-fcc3e89d6af4</DeviceId>
  <MessageAuditCreatedDateUtc>2026-05-20T00:47:33.4601992+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>0e9b52c4-3a0b-454c-ad9f-7ec61d6e13e1</MessageAuditId>
  <MessageAuditMessageAuditTypeId>c1a3a0a7-8f8d-453f-b21a-45f67fcff099</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-05-20T00:47:33.4601992+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>75fee352-843b-4139-a038-d1518f4e9b11</MessageId>
  <MessageTypeId>4e68201f-2221-4926-a1f2-1d895bc12a08</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>52df0eb2-a6b9-499f-b540-68ea86d4e0bd</TenantId>
  <UserGroupId>d43a3b23-f384-4eca-9b4a-9882b45c90a2</UserGroupId>
  <UserId>ecdceec1-b5f5-4c02-b1ae-9323e5462247</UserId>
</MessageRepresentation>