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": "081f59b7-73d0-4738-b968-0e5e57838673",
  "tenantId": "f81bb7bb-136e-4530-abb5-bd1b6cbe8613",
  "messageTypeId": "9e7d9739-d566-4a08-ad14-9caa4581efcb",
  "messageTypeLookupKey": "sample string 4",
  "userId": "9df681ba-7129-4b7a-b356-fcfaa23e435c",
  "userGroupId": "60486ed9-bb2b-4467-9785-db1b2b068fb9",
  "deviceId": "bd53a389-e655-4989-9c65-946fd4d59d2a",
  "deviceGroupId": "400b477e-14fa-4a06-86d6-4c45c340373c",
  "applicationId": "3448ba80-af45-42f1-95f3-6c78570db956",
  "applicationVersionId": "63f7a821-b38e-44a7-b3a5-be7aa1dc49a0",
  "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": "d06ed2eb-ee25-41b2-9d6b-516dcd5a4e8e",
  "messageAuditMessageAuditTypeId": "14bdd3f1-ab10-4be4-9825-8086b5547660",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-08-11T02:32:42.4139198+00:00",
  "messageAuditUpdatedDateUtc": "2026-08-11T02:32:42.4139198+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-08-11T02:32:42.4139198+00:00",
  "updatedDateUtc": "2026-08-11T02:32:42.4139198+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-08-11T02:32:42.4139198+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-11T02:32:42.4139198+00:00</UpdatedDateUtc>
  <ApplicationId>3448ba80-af45-42f1-95f3-6c78570db956</ApplicationId>
  <ApplicationVersionId>63f7a821-b38e-44a7-b3a5-be7aa1dc49a0</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>400b477e-14fa-4a06-86d6-4c45c340373c</DeviceGroupId>
  <DeviceId>bd53a389-e655-4989-9c65-946fd4d59d2a</DeviceId>
  <MessageAuditCreatedDateUtc>2026-08-11T02:32:42.4139198+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>d06ed2eb-ee25-41b2-9d6b-516dcd5a4e8e</MessageAuditId>
  <MessageAuditMessageAuditTypeId>14bdd3f1-ab10-4be4-9825-8086b5547660</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-08-11T02:32:42.4139198+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>081f59b7-73d0-4738-b968-0e5e57838673</MessageId>
  <MessageTypeId>9e7d9739-d566-4a08-ad14-9caa4581efcb</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>f81bb7bb-136e-4530-abb5-bd1b6cbe8613</TenantId>
  <UserGroupId>60486ed9-bb2b-4467-9785-db1b2b068fb9</UserGroupId>
  <UserId>9df681ba-7129-4b7a-b356-fcfaa23e435c</UserId>
</MessageRepresentation>