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": "552b27d0-6512-496d-b1fa-3f2825943f12",
  "tenantId": "cc46247c-1de5-4797-af97-63ff3bc3aca7",
  "messageTypeId": "cf322b41-4bdd-4d33-ac41-c5453555f94c",
  "messageTypeLookupKey": "sample string 4",
  "userId": "3eada9c5-f901-4c1f-9ffa-73c39340197f",
  "userGroupId": "831882b6-423d-48ad-9e61-797465c98a08",
  "deviceId": "2e96e30d-ab80-4049-8615-bc62fbca2a06",
  "deviceGroupId": "b02fd6b4-c8ad-44c3-9083-ca2ea6d076a5",
  "applicationId": "eb9a4a27-c7f3-4b0e-ba6a-034055e1e95f",
  "applicationVersionId": "243e558d-b831-412c-95dd-318b27774945",
  "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": "c87ccb79-cf33-45cc-b9c7-b0da2d6557f0",
  "messageAuditMessageAuditTypeId": "45850b1e-149d-4bdf-9ced-bcfc9927a257",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-06T04:08:46.3418732+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-06T04:08:46.3418732+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-06T04:08:46.3418732+00:00",
  "updatedDateUtc": "2026-03-06T04:08:46.3418732+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-03-06T04:08:46.3418732+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-06T04:08:46.3418732+00:00</UpdatedDateUtc>
  <ApplicationId>eb9a4a27-c7f3-4b0e-ba6a-034055e1e95f</ApplicationId>
  <ApplicationVersionId>243e558d-b831-412c-95dd-318b27774945</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>b02fd6b4-c8ad-44c3-9083-ca2ea6d076a5</DeviceGroupId>
  <DeviceId>2e96e30d-ab80-4049-8615-bc62fbca2a06</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-06T04:08:46.3418732+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>c87ccb79-cf33-45cc-b9c7-b0da2d6557f0</MessageAuditId>
  <MessageAuditMessageAuditTypeId>45850b1e-149d-4bdf-9ced-bcfc9927a257</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-06T04:08:46.3418732+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>552b27d0-6512-496d-b1fa-3f2825943f12</MessageId>
  <MessageTypeId>cf322b41-4bdd-4d33-ac41-c5453555f94c</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>cc46247c-1de5-4797-af97-63ff3bc3aca7</TenantId>
  <UserGroupId>831882b6-423d-48ad-9e61-797465c98a08</UserGroupId>
  <UserId>3eada9c5-f901-4c1f-9ffa-73c39340197f</UserId>
</MessageRepresentation>