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": "3be34b2c-29eb-46bc-b38e-b5a9ca4c76a9",
  "tenantId": "4dd77277-d641-4930-a9d0-a9154f556dad",
  "messageTypeId": "bbde43b6-cfb7-48b4-a16e-c5c8533ec8f6",
  "messageTypeLookupKey": "sample string 4",
  "userId": "aedb317a-3131-40cf-83e5-3f6530890c4c",
  "userGroupId": "ccbe3298-4593-4a53-bdb3-7c4ad2e7d782",
  "deviceId": "7c863de0-5a5f-4f36-b5b6-47883f357ad2",
  "deviceGroupId": "0738d1e9-c0d8-4676-b9fe-f2eba3cdc514",
  "applicationId": "65acff83-fec3-44b5-a992-831c3c147a7b",
  "applicationVersionId": "c685e2a3-1bc1-4c74-b968-0211d2546b52",
  "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": "f8aa6fa3-35ef-4448-8215-782a02d0ac72",
  "messageAuditMessageAuditTypeId": "be84378d-5ca3-40d7-a200-052947c676d8",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-02-04T01:52:23.6798573+00:00",
  "messageAuditUpdatedDateUtc": "2026-02-04T01:52:23.6798573+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-02-04T01:52:23.6798573+00:00",
  "updatedDateUtc": "2026-02-04T01:52:23.6798573+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-02-04T01:52:23.6798573+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-04T01:52:23.6798573+00:00</UpdatedDateUtc>
  <ApplicationId>65acff83-fec3-44b5-a992-831c3c147a7b</ApplicationId>
  <ApplicationVersionId>c685e2a3-1bc1-4c74-b968-0211d2546b52</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>0738d1e9-c0d8-4676-b9fe-f2eba3cdc514</DeviceGroupId>
  <DeviceId>7c863de0-5a5f-4f36-b5b6-47883f357ad2</DeviceId>
  <MessageAuditCreatedDateUtc>2026-02-04T01:52:23.6798573+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>f8aa6fa3-35ef-4448-8215-782a02d0ac72</MessageAuditId>
  <MessageAuditMessageAuditTypeId>be84378d-5ca3-40d7-a200-052947c676d8</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-02-04T01:52:23.6798573+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>3be34b2c-29eb-46bc-b38e-b5a9ca4c76a9</MessageId>
  <MessageTypeId>bbde43b6-cfb7-48b4-a16e-c5c8533ec8f6</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>4dd77277-d641-4930-a9d0-a9154f556dad</TenantId>
  <UserGroupId>ccbe3298-4593-4a53-bdb3-7c4ad2e7d782</UserGroupId>
  <UserId>aedb317a-3131-40cf-83e5-3f6530890c4c</UserId>
</MessageRepresentation>