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": "e33faf66-39c1-45cd-8f1a-24d11cb4de91",
  "tenantId": "779849d8-162f-4c80-af1f-8404f799cc9d",
  "messageTypeId": "cdb9c018-845f-4522-aefd-c5e43a6ff089",
  "messageTypeLookupKey": "sample string 4",
  "userId": "4efa3698-a5e4-4e9b-9414-cbdd5c5d5b77",
  "userGroupId": "b20a0562-f966-4440-922b-51df885a6cca",
  "deviceId": "1363575b-93d6-44c6-902d-e510e344f3f9",
  "deviceGroupId": "f19cef8a-5172-4ca2-8d09-2ff8a01bc66c",
  "applicationId": "54338d8d-9f5e-4cdc-a0d6-eeee65234e32",
  "applicationVersionId": "0c870414-010a-4bec-9a4f-cc690b251a40",
  "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": "06ac074b-58ba-43cc-a8ea-dbe4046075b2",
  "messageAuditMessageAuditTypeId": "99933f3e-5e44-4ffb-8848-e014266732f8",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-11-04T15:15:44.3510985+00:00",
  "messageAuditUpdatedDateUtc": "2025-11-04T15:15:44.3510985+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-11-04T15:15:44.3510985+00:00",
  "updatedDateUtc": "2025-11-04T15:15:44.3510985+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-11-04T15:15:44.3510985+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-04T15:15:44.3510985+00:00</UpdatedDateUtc>
  <ApplicationId>54338d8d-9f5e-4cdc-a0d6-eeee65234e32</ApplicationId>
  <ApplicationVersionId>0c870414-010a-4bec-9a4f-cc690b251a40</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>f19cef8a-5172-4ca2-8d09-2ff8a01bc66c</DeviceGroupId>
  <DeviceId>1363575b-93d6-44c6-902d-e510e344f3f9</DeviceId>
  <MessageAuditCreatedDateUtc>2025-11-04T15:15:44.3510985+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>06ac074b-58ba-43cc-a8ea-dbe4046075b2</MessageAuditId>
  <MessageAuditMessageAuditTypeId>99933f3e-5e44-4ffb-8848-e014266732f8</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-11-04T15:15:44.3510985+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>e33faf66-39c1-45cd-8f1a-24d11cb4de91</MessageId>
  <MessageTypeId>cdb9c018-845f-4522-aefd-c5e43a6ff089</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>779849d8-162f-4c80-af1f-8404f799cc9d</TenantId>
  <UserGroupId>b20a0562-f966-4440-922b-51df885a6cca</UserGroupId>
  <UserId>4efa3698-a5e4-4e9b-9414-cbdd5c5d5b77</UserId>
</MessageRepresentation>