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": "5b1efade-b964-4b5e-98e7-84351a96ed6e",
  "tenantId": "896cd848-8b0b-4477-934b-7f456978487d",
  "messageTypeId": "08c6df5e-9a72-4940-b348-141ab74c420b",
  "messageTypeLookupKey": "sample string 4",
  "userId": "b8aa0c86-e8bd-495b-a271-eb42fed5747c",
  "userGroupId": "bc2d310b-01c1-4adb-924e-0636c23a5185",
  "deviceId": "c33dda67-9940-41d1-a480-a8ea97dcb739",
  "deviceGroupId": "61afed47-2aed-42a9-b1cf-62b6a397db05",
  "applicationId": "3ab1090a-e62c-42f4-8d25-b34d43bf617e",
  "applicationVersionId": "a32238fe-dd38-460f-a81e-27f8bf8fdee3",
  "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": "6d05408b-6c85-4835-89d2-d9b8e9943a94",
  "messageAuditMessageAuditTypeId": "f36f5298-c073-49d7-8d5e-12e30678583b",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-18T10:28:17.3114766+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-18T10:28:17.3114766+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-18T10:28:17.3114766+00:00",
  "updatedDateUtc": "2026-06-18T10:28:17.3114766+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-18T10:28:17.3114766+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-18T10:28:17.3114766+00:00</UpdatedDateUtc>
  <ApplicationId>3ab1090a-e62c-42f4-8d25-b34d43bf617e</ApplicationId>
  <ApplicationVersionId>a32238fe-dd38-460f-a81e-27f8bf8fdee3</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>61afed47-2aed-42a9-b1cf-62b6a397db05</DeviceGroupId>
  <DeviceId>c33dda67-9940-41d1-a480-a8ea97dcb739</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-18T10:28:17.3114766+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>6d05408b-6c85-4835-89d2-d9b8e9943a94</MessageAuditId>
  <MessageAuditMessageAuditTypeId>f36f5298-c073-49d7-8d5e-12e30678583b</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-18T10:28:17.3114766+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>5b1efade-b964-4b5e-98e7-84351a96ed6e</MessageId>
  <MessageTypeId>08c6df5e-9a72-4940-b348-141ab74c420b</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>896cd848-8b0b-4477-934b-7f456978487d</TenantId>
  <UserGroupId>bc2d310b-01c1-4adb-924e-0636c23a5185</UserGroupId>
  <UserId>b8aa0c86-e8bd-495b-a271-eb42fed5747c</UserId>
</MessageRepresentation>