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": "f8bb6c79-e2bd-4cbd-b0cb-2456a4a85e17",
  "tenantId": "4ba1ad1b-c773-4c60-b209-07c1e476831e",
  "messageTypeId": "26635b77-1d58-4b77-8fad-6c24144f3794",
  "messageTypeLookupKey": "sample string 4",
  "userId": "03ea089c-39b6-417a-a6d4-b9d547d582eb",
  "userGroupId": "b76f9ca8-75b8-467d-8115-f6bd53210921",
  "deviceId": "cdb44275-ef10-4e50-8a7b-98e195200a05",
  "deviceGroupId": "ee09f930-16cb-49b5-9de8-512369929dd8",
  "applicationId": "39e446be-319a-43bf-a724-8c28d625ee8d",
  "applicationVersionId": "02542f2a-4f95-4876-87ae-dce1deddc25e",
  "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": "592e9af6-9e65-4eff-ac5c-cb55e31f3944",
  "messageAuditMessageAuditTypeId": "157d53f7-f55c-4bb2-b6ec-0451bde2a485",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-08T12:52:12.3370654+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-08T12:52:12.3370654+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-08T12:52:12.3370654+00:00",
  "updatedDateUtc": "2026-06-08T12:52:12.3370654+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-08T12:52:12.3370654+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-08T12:52:12.3370654+00:00</UpdatedDateUtc>
  <ApplicationId>39e446be-319a-43bf-a724-8c28d625ee8d</ApplicationId>
  <ApplicationVersionId>02542f2a-4f95-4876-87ae-dce1deddc25e</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>ee09f930-16cb-49b5-9de8-512369929dd8</DeviceGroupId>
  <DeviceId>cdb44275-ef10-4e50-8a7b-98e195200a05</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-08T12:52:12.3370654+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>592e9af6-9e65-4eff-ac5c-cb55e31f3944</MessageAuditId>
  <MessageAuditMessageAuditTypeId>157d53f7-f55c-4bb2-b6ec-0451bde2a485</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-08T12:52:12.3370654+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>f8bb6c79-e2bd-4cbd-b0cb-2456a4a85e17</MessageId>
  <MessageTypeId>26635b77-1d58-4b77-8fad-6c24144f3794</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>4ba1ad1b-c773-4c60-b209-07c1e476831e</TenantId>
  <UserGroupId>b76f9ca8-75b8-467d-8115-f6bd53210921</UserGroupId>
  <UserId>03ea089c-39b6-417a-a6d4-b9d547d582eb</UserId>
</MessageRepresentation>