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": "89f70915-3b05-454f-8dd1-e796c06383dc",
  "tenantId": "033633ba-dd86-44b4-9de4-e2067914a177",
  "messageTypeId": "c9311ce3-1493-47e5-9fd6-7457be665123",
  "messageTypeLookupKey": "sample string 4",
  "userId": "ec5f9a25-0b12-450b-8e43-2cb6f31fddac",
  "userGroupId": "fbdc7b08-55f9-48ff-a8a7-9bc3c0197fcb",
  "deviceId": "483f47b3-2b43-48e1-8776-a0dfa77ce7da",
  "deviceGroupId": "a7cbc473-1477-4e7a-b4d9-7c1c20e8e91a",
  "applicationId": "d3314d9d-e268-4b5a-8b56-a967cbb95f29",
  "applicationVersionId": "9068e634-c9e5-4520-b35e-1a3d4baedd2d",
  "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": "417850ed-b10f-4e1a-ab54-b29cd91704e7",
  "messageAuditMessageAuditTypeId": "c4080ae1-018a-4ccc-8e8c-651c1e01f359",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-19T11:06:47.0136214+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-19T11:06:47.0136214+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-19T11:06:47.0136214+00:00",
  "updatedDateUtc": "2026-03-19T11:06:47.0136214+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-03-19T11:06:47.0136214+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-19T11:06:47.0136214+00:00</UpdatedDateUtc>
  <ApplicationId>d3314d9d-e268-4b5a-8b56-a967cbb95f29</ApplicationId>
  <ApplicationVersionId>9068e634-c9e5-4520-b35e-1a3d4baedd2d</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>a7cbc473-1477-4e7a-b4d9-7c1c20e8e91a</DeviceGroupId>
  <DeviceId>483f47b3-2b43-48e1-8776-a0dfa77ce7da</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-19T11:06:47.0136214+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>417850ed-b10f-4e1a-ab54-b29cd91704e7</MessageAuditId>
  <MessageAuditMessageAuditTypeId>c4080ae1-018a-4ccc-8e8c-651c1e01f359</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-19T11:06:47.0136214+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>89f70915-3b05-454f-8dd1-e796c06383dc</MessageId>
  <MessageTypeId>c9311ce3-1493-47e5-9fd6-7457be665123</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>033633ba-dd86-44b4-9de4-e2067914a177</TenantId>
  <UserGroupId>fbdc7b08-55f9-48ff-a8a7-9bc3c0197fcb</UserGroupId>
  <UserId>ec5f9a25-0b12-450b-8e43-2cb6f31fddac</UserId>
</MessageRepresentation>