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": "043110ec-bb1a-42ff-a5ed-17e201968c89",
  "tenantId": "ae53f136-9f74-4847-acc8-2b394cde8dbb",
  "messageTypeId": "327afddc-77f1-4b55-b6cb-943c820ed5ca",
  "messageTypeLookupKey": "sample string 4",
  "userId": "46d064d3-444f-4f2e-991e-51dddf5bf9c8",
  "userGroupId": "24db39e4-6eea-45eb-8905-5d5784f7758b",
  "deviceId": "ba1f825f-eda7-48e5-a4bf-2ba2067f6320",
  "deviceGroupId": "6cb19661-42ea-4941-b90f-fdd297c379f0",
  "applicationId": "83bc811f-1f0c-4527-a554-439fb91364a4",
  "applicationVersionId": "09c3b7fa-4fd0-4470-b021-1bd9c13cf815",
  "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": "c98ef67b-1a33-4e97-9505-b94334c8a78e",
  "messageAuditMessageAuditTypeId": "4e6694e7-caad-4c5e-a589-2eb5a2d4c229",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-05-19T06:51:46.4463229+00:00",
  "messageAuditUpdatedDateUtc": "2026-05-19T06:51:46.4463229+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-05-19T06:51:46.4463229+00:00",
  "updatedDateUtc": "2026-05-19T06:51:46.4463229+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-19T06:51:46.4463229+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-05-19T06:51:46.4463229+00:00</UpdatedDateUtc>
  <ApplicationId>83bc811f-1f0c-4527-a554-439fb91364a4</ApplicationId>
  <ApplicationVersionId>09c3b7fa-4fd0-4470-b021-1bd9c13cf815</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>6cb19661-42ea-4941-b90f-fdd297c379f0</DeviceGroupId>
  <DeviceId>ba1f825f-eda7-48e5-a4bf-2ba2067f6320</DeviceId>
  <MessageAuditCreatedDateUtc>2026-05-19T06:51:46.4463229+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>c98ef67b-1a33-4e97-9505-b94334c8a78e</MessageAuditId>
  <MessageAuditMessageAuditTypeId>4e6694e7-caad-4c5e-a589-2eb5a2d4c229</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-05-19T06:51:46.4463229+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>043110ec-bb1a-42ff-a5ed-17e201968c89</MessageId>
  <MessageTypeId>327afddc-77f1-4b55-b6cb-943c820ed5ca</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>ae53f136-9f74-4847-acc8-2b394cde8dbb</TenantId>
  <UserGroupId>24db39e4-6eea-45eb-8905-5d5784f7758b</UserGroupId>
  <UserId>46d064d3-444f-4f2e-991e-51dddf5bf9c8</UserId>
</MessageRepresentation>