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": "f64cfdce-19d6-4592-92a5-20afcfa2cd8e",
  "tenantId": "fa53278a-d72e-4c23-a237-da7e47c295a2",
  "messageTypeId": "a2981cb4-1c84-4839-bfae-1ee9b1dc6bad",
  "messageTypeLookupKey": "sample string 4",
  "userId": "92debe0b-02d8-44a5-a9f5-cb851c752115",
  "userGroupId": "98c4149c-ef64-4347-9758-eb8aae540a50",
  "deviceId": "6f4f8dcc-ae53-47f0-9312-0c0c3df0eba0",
  "deviceGroupId": "9d13ae10-a04c-4341-b57b-4536b4408984",
  "applicationId": "df3ac078-2024-4ae6-a954-9ab364806b6d",
  "applicationVersionId": "0a641e0e-8331-47f4-969b-ae0adb7c5f5e",
  "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": "7f14b3a3-49f5-4caa-8458-00effa0014ea",
  "messageAuditMessageAuditTypeId": "4082ca83-f081-487a-93b3-71cdf2b9ca76",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-23T17:59:46.4791006+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-23T17:59:46.4791006+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-23T17:59:46.4791006+00:00",
  "updatedDateUtc": "2026-06-23T17:59:46.4791006+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-23T17:59:46.4791006+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-23T17:59:46.4791006+00:00</UpdatedDateUtc>
  <ApplicationId>df3ac078-2024-4ae6-a954-9ab364806b6d</ApplicationId>
  <ApplicationVersionId>0a641e0e-8331-47f4-969b-ae0adb7c5f5e</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>9d13ae10-a04c-4341-b57b-4536b4408984</DeviceGroupId>
  <DeviceId>6f4f8dcc-ae53-47f0-9312-0c0c3df0eba0</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-23T17:59:46.4791006+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>7f14b3a3-49f5-4caa-8458-00effa0014ea</MessageAuditId>
  <MessageAuditMessageAuditTypeId>4082ca83-f081-487a-93b3-71cdf2b9ca76</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-23T17:59:46.4791006+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>f64cfdce-19d6-4592-92a5-20afcfa2cd8e</MessageId>
  <MessageTypeId>a2981cb4-1c84-4839-bfae-1ee9b1dc6bad</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>fa53278a-d72e-4c23-a237-da7e47c295a2</TenantId>
  <UserGroupId>98c4149c-ef64-4347-9758-eb8aae540a50</UserGroupId>
  <UserId>92debe0b-02d8-44a5-a9f5-cb851c752115</UserId>
</MessageRepresentation>