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": "50c08d14-2987-4f51-b0a2-6d0f442ddb9a",
  "tenantId": "c013cd8b-cca7-4cf7-9581-33441c020859",
  "messageTypeId": "ff5ec6f4-8f92-4de1-b5f7-04b26b429099",
  "messageTypeLookupKey": "sample string 4",
  "userId": "a50e0048-de55-489c-9632-e7afde81ec01",
  "userGroupId": "ab0058ef-0e74-428b-9535-57123a51d84e",
  "deviceId": "4b8e22a5-cd8d-4423-8888-62379f50100e",
  "deviceGroupId": "4a93a68e-cdb3-47b2-86a6-287d9d4adad6",
  "applicationId": "bd165a46-77ad-49b3-ac5e-6f9b663a345a",
  "applicationVersionId": "22000713-c8bb-40c3-a6b1-77f29338c44f",
  "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": "ee810b69-88bd-428b-b049-605baa3a4d19",
  "messageAuditMessageAuditTypeId": "1ad1ccaa-1403-4b6d-95f7-7bfe42a58535",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-04-29T06:43:11.6445871+00:00",
  "messageAuditUpdatedDateUtc": "2026-04-29T06:43:11.6445871+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-04-29T06:43:11.6445871+00:00",
  "updatedDateUtc": "2026-04-29T06:43:11.6445871+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-04-29T06:43:11.6445871+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-29T06:43:11.6445871+00:00</UpdatedDateUtc>
  <ApplicationId>bd165a46-77ad-49b3-ac5e-6f9b663a345a</ApplicationId>
  <ApplicationVersionId>22000713-c8bb-40c3-a6b1-77f29338c44f</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>4a93a68e-cdb3-47b2-86a6-287d9d4adad6</DeviceGroupId>
  <DeviceId>4b8e22a5-cd8d-4423-8888-62379f50100e</DeviceId>
  <MessageAuditCreatedDateUtc>2026-04-29T06:43:11.6445871+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>ee810b69-88bd-428b-b049-605baa3a4d19</MessageAuditId>
  <MessageAuditMessageAuditTypeId>1ad1ccaa-1403-4b6d-95f7-7bfe42a58535</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-04-29T06:43:11.6445871+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>50c08d14-2987-4f51-b0a2-6d0f442ddb9a</MessageId>
  <MessageTypeId>ff5ec6f4-8f92-4de1-b5f7-04b26b429099</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>c013cd8b-cca7-4cf7-9581-33441c020859</TenantId>
  <UserGroupId>ab0058ef-0e74-428b-9535-57123a51d84e</UserGroupId>
  <UserId>a50e0048-de55-489c-9632-e7afde81ec01</UserId>
</MessageRepresentation>