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": "8bfe9a1a-49d7-4554-9179-72ad2350eca3",
  "tenantId": "c367b675-4a72-4275-b51a-62a8f8867abe",
  "messageTypeId": "db018dcf-b130-47f4-aa04-dd72e7a39a13",
  "messageTypeLookupKey": "sample string 4",
  "userId": "fe0bd4ef-c5f6-47f4-9151-d28c77266a96",
  "userGroupId": "6a856971-13c6-498a-ad77-2bbe7022bdf2",
  "deviceId": "b36b418e-bbf2-4401-9d58-d6ec3912ced7",
  "deviceGroupId": "12bf9f6b-8b3a-46b7-bcaa-7d4be054eed6",
  "applicationId": "c9edf091-b779-48ed-b454-0a762cadd1e2",
  "applicationVersionId": "525e7ce4-6ac1-4b87-9190-6daf1b99be75",
  "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": "b690aba2-51a1-49ee-839d-abd9a226ffe8",
  "messageAuditMessageAuditTypeId": "e708a823-2826-40bc-9812-e78a3cfd4dec",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-12-14T16:02:22.2372252+00:00",
  "messageAuditUpdatedDateUtc": "2025-12-14T16:02:22.2372252+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-12-14T16:02:22.2372252+00:00",
  "updatedDateUtc": "2025-12-14T16:02:22.2372252+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>2025-12-14T16:02:22.2372252+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-14T16:02:22.2372252+00:00</UpdatedDateUtc>
  <ApplicationId>c9edf091-b779-48ed-b454-0a762cadd1e2</ApplicationId>
  <ApplicationVersionId>525e7ce4-6ac1-4b87-9190-6daf1b99be75</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>12bf9f6b-8b3a-46b7-bcaa-7d4be054eed6</DeviceGroupId>
  <DeviceId>b36b418e-bbf2-4401-9d58-d6ec3912ced7</DeviceId>
  <MessageAuditCreatedDateUtc>2025-12-14T16:02:22.2372252+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>b690aba2-51a1-49ee-839d-abd9a226ffe8</MessageAuditId>
  <MessageAuditMessageAuditTypeId>e708a823-2826-40bc-9812-e78a3cfd4dec</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-12-14T16:02:22.2372252+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>8bfe9a1a-49d7-4554-9179-72ad2350eca3</MessageId>
  <MessageTypeId>db018dcf-b130-47f4-aa04-dd72e7a39a13</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>c367b675-4a72-4275-b51a-62a8f8867abe</TenantId>
  <UserGroupId>6a856971-13c6-498a-ad77-2bbe7022bdf2</UserGroupId>
  <UserId>fe0bd4ef-c5f6-47f4-9151-d28c77266a96</UserId>
</MessageRepresentation>