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": "04831cc9-724a-4599-97b3-7393788de90c",
  "tenantId": "05ca02e9-c2a5-46d9-bd7e-27574c269cae",
  "messageTypeId": "95268129-fadd-46d9-920f-a398da5b5e20",
  "messageTypeLookupKey": "sample string 4",
  "userId": "97800b18-0287-4ade-98b7-89ddb4a6d8dc",
  "userGroupId": "23d59faa-ab96-4df7-9078-e5f9e57d0dcd",
  "deviceId": "c8de114b-0271-436e-9ed7-b8bdb2baf37a",
  "deviceGroupId": "5e1e0639-4ff1-4144-a08f-5f97a74e6697",
  "applicationId": "eda1a80a-fd50-4273-bb8c-b47c3bfd93ff",
  "applicationVersionId": "dab32486-5461-4b4b-a31a-685af8ac39d9",
  "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": "d74c9f69-f105-4683-af3c-4eaa2dd01544",
  "messageAuditMessageAuditTypeId": "4abefb8a-ccb6-4214-bc19-13468917a488",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-04-02T19:32:55.7102808+00:00",
  "messageAuditUpdatedDateUtc": "2026-04-02T19:32:55.7102808+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-04-02T19:32:55.7102808+00:00",
  "updatedDateUtc": "2026-04-02T19:32:55.7102808+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-02T19:32:55.7102808+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-02T19:32:55.7102808+00:00</UpdatedDateUtc>
  <ApplicationId>eda1a80a-fd50-4273-bb8c-b47c3bfd93ff</ApplicationId>
  <ApplicationVersionId>dab32486-5461-4b4b-a31a-685af8ac39d9</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>5e1e0639-4ff1-4144-a08f-5f97a74e6697</DeviceGroupId>
  <DeviceId>c8de114b-0271-436e-9ed7-b8bdb2baf37a</DeviceId>
  <MessageAuditCreatedDateUtc>2026-04-02T19:32:55.7102808+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>d74c9f69-f105-4683-af3c-4eaa2dd01544</MessageAuditId>
  <MessageAuditMessageAuditTypeId>4abefb8a-ccb6-4214-bc19-13468917a488</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-04-02T19:32:55.7102808+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>04831cc9-724a-4599-97b3-7393788de90c</MessageId>
  <MessageTypeId>95268129-fadd-46d9-920f-a398da5b5e20</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>05ca02e9-c2a5-46d9-bd7e-27574c269cae</TenantId>
  <UserGroupId>23d59faa-ab96-4df7-9078-e5f9e57d0dcd</UserGroupId>
  <UserId>97800b18-0287-4ade-98b7-89ddb4a6d8dc</UserId>
</MessageRepresentation>