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": "cb9aeb35-9c90-4cf2-9298-68cc9582b52a",
  "tenantId": "e1bff6cd-4f16-4cfe-a533-dae71d2c5831",
  "messageTypeId": "d99991c4-e2c9-4d47-8db4-606bbdeae305",
  "messageTypeLookupKey": "sample string 4",
  "userId": "aaee7ee5-c51c-431c-94d5-2a657918e64f",
  "userGroupId": "6b934377-3b0b-4763-aec0-637f99eb2e64",
  "deviceId": "c7ec3fe6-3224-41e6-8b0b-e7c1eea1a8fa",
  "deviceGroupId": "8ca5b3fb-f534-4e03-83e7-4bf69a8956e0",
  "applicationId": "dc8e6735-f95f-44a5-8c6f-14caeb3aa050",
  "applicationVersionId": "1e0be350-ff20-45d4-98c1-3ebdc4f86c52",
  "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": "1e3add54-ae1b-47c1-b783-f3d1ad33933a",
  "messageAuditMessageAuditTypeId": "26a83a97-98a6-4841-b7fd-aba5d71e2056",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-21T12:57:58.1155018+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-21T12:57:58.1155018+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-21T12:57:58.1155018+00:00",
  "updatedDateUtc": "2026-06-21T12:57:58.1155018+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-21T12:57:58.1155018+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-21T12:57:58.1155018+00:00</UpdatedDateUtc>
  <ApplicationId>dc8e6735-f95f-44a5-8c6f-14caeb3aa050</ApplicationId>
  <ApplicationVersionId>1e0be350-ff20-45d4-98c1-3ebdc4f86c52</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>8ca5b3fb-f534-4e03-83e7-4bf69a8956e0</DeviceGroupId>
  <DeviceId>c7ec3fe6-3224-41e6-8b0b-e7c1eea1a8fa</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-21T12:57:58.1155018+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>1e3add54-ae1b-47c1-b783-f3d1ad33933a</MessageAuditId>
  <MessageAuditMessageAuditTypeId>26a83a97-98a6-4841-b7fd-aba5d71e2056</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-21T12:57:58.1155018+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>cb9aeb35-9c90-4cf2-9298-68cc9582b52a</MessageId>
  <MessageTypeId>d99991c4-e2c9-4d47-8db4-606bbdeae305</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>e1bff6cd-4f16-4cfe-a533-dae71d2c5831</TenantId>
  <UserGroupId>6b934377-3b0b-4763-aec0-637f99eb2e64</UserGroupId>
  <UserId>aaee7ee5-c51c-431c-94d5-2a657918e64f</UserId>
</MessageRepresentation>