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": "b83baa43-8c13-4c2b-bbea-5c05119eee83",
  "tenantId": "dcbf40fc-6a91-4689-83f6-04bbe2666d82",
  "messageTypeId": "47b06300-bff4-4c6e-8aa6-29474db5fc79",
  "messageTypeLookupKey": "sample string 4",
  "userId": "a96556d2-e9cb-4a7b-ac0a-979e525751e3",
  "userGroupId": "1e9b2ec3-fac6-44e6-968b-b73af4413994",
  "deviceId": "c3ed9a55-e5db-4ca8-9a2b-1b1464e6ba40",
  "deviceGroupId": "e96d66cd-391c-498c-8210-f543e57e2f93",
  "applicationId": "02e81c4f-feb0-438a-a365-a4ebaefdf72a",
  "applicationVersionId": "16302744-0137-4e5a-a2cf-a999fedc47da",
  "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": "b49c3b7d-2b5f-4199-83c8-fb80dd8df8c4",
  "messageAuditMessageAuditTypeId": "bf534a8d-29f8-47fc-bf3c-b253358a0a99",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-04-08T20:26:11.2975568+00:00",
  "messageAuditUpdatedDateUtc": "2026-04-08T20:26:11.2975568+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-04-08T20:26:11.2975568+00:00",
  "updatedDateUtc": "2026-04-08T20:26:11.2975568+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-08T20:26:11.2975568+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-08T20:26:11.2975568+00:00</UpdatedDateUtc>
  <ApplicationId>02e81c4f-feb0-438a-a365-a4ebaefdf72a</ApplicationId>
  <ApplicationVersionId>16302744-0137-4e5a-a2cf-a999fedc47da</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>e96d66cd-391c-498c-8210-f543e57e2f93</DeviceGroupId>
  <DeviceId>c3ed9a55-e5db-4ca8-9a2b-1b1464e6ba40</DeviceId>
  <MessageAuditCreatedDateUtc>2026-04-08T20:26:11.2975568+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>b49c3b7d-2b5f-4199-83c8-fb80dd8df8c4</MessageAuditId>
  <MessageAuditMessageAuditTypeId>bf534a8d-29f8-47fc-bf3c-b253358a0a99</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-04-08T20:26:11.2975568+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>b83baa43-8c13-4c2b-bbea-5c05119eee83</MessageId>
  <MessageTypeId>47b06300-bff4-4c6e-8aa6-29474db5fc79</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>dcbf40fc-6a91-4689-83f6-04bbe2666d82</TenantId>
  <UserGroupId>1e9b2ec3-fac6-44e6-968b-b73af4413994</UserGroupId>
  <UserId>a96556d2-e9cb-4a7b-ac0a-979e525751e3</UserId>
</MessageRepresentation>