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": "d2612878-93f5-41c8-91d9-b2c3f129f505",
  "tenantId": "c7b93e45-ea00-4e35-b5c8-03ccc1a29282",
  "messageTypeId": "17bf1365-33d6-48a8-bacb-6c9c1662da5a",
  "messageTypeLookupKey": "sample string 4",
  "userId": "eb0fd2d3-0281-4d3e-b6fa-ef49bb99799f",
  "userGroupId": "072b6d64-3045-4d4e-a333-9508bd230a71",
  "deviceId": "36659434-0572-446d-9007-286214440a78",
  "deviceGroupId": "1e2688bd-9d36-4820-8fff-d6e12908f856",
  "applicationId": "d9bdf504-0704-4570-af7a-d9d16131b478",
  "applicationVersionId": "81d1198b-73a9-4ba6-ae56-fe4eb5c8fc9e",
  "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": "d8c98aec-4a25-426c-b5f8-c4c992188a73",
  "messageAuditMessageAuditTypeId": "00e5a479-7442-47cf-9c02-06ba3b506927",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-23T16:19:29.9040277+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-23T16:19:29.9040277+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-23T16:19:29.9040277+00:00",
  "updatedDateUtc": "2026-06-23T16:19:29.9040277+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-06-23T16:19:29.9040277+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-23T16:19:29.9040277+00:00</UpdatedDateUtc>
  <ApplicationId>d9bdf504-0704-4570-af7a-d9d16131b478</ApplicationId>
  <ApplicationVersionId>81d1198b-73a9-4ba6-ae56-fe4eb5c8fc9e</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>1e2688bd-9d36-4820-8fff-d6e12908f856</DeviceGroupId>
  <DeviceId>36659434-0572-446d-9007-286214440a78</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-23T16:19:29.9040277+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>d8c98aec-4a25-426c-b5f8-c4c992188a73</MessageAuditId>
  <MessageAuditMessageAuditTypeId>00e5a479-7442-47cf-9c02-06ba3b506927</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-23T16:19:29.9040277+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>d2612878-93f5-41c8-91d9-b2c3f129f505</MessageId>
  <MessageTypeId>17bf1365-33d6-48a8-bacb-6c9c1662da5a</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>c7b93e45-ea00-4e35-b5c8-03ccc1a29282</TenantId>
  <UserGroupId>072b6d64-3045-4d4e-a333-9508bd230a71</UserGroupId>
  <UserId>eb0fd2d3-0281-4d3e-b6fa-ef49bb99799f</UserId>
</MessageRepresentation>