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": "640dcae0-ef57-4188-994e-64a1064581a3",
  "tenantId": "36fd638b-ca31-4f91-b480-a323ff7055c9",
  "messageTypeId": "f0bdd07c-810c-474a-a402-7a27a7785bbc",
  "messageTypeLookupKey": "sample string 4",
  "userId": "e7ba3990-b902-4151-b59f-1331637b6664",
  "userGroupId": "08e573d1-7818-430b-b7d8-53b98bfe8cd2",
  "deviceId": "ba821d36-3d9b-40d5-87a0-183612cd649c",
  "deviceGroupId": "f5af2169-c44f-4a7a-89f7-cec6ae553287",
  "applicationId": "524d8b54-860b-4706-a029-8cced07768ac",
  "applicationVersionId": "d484786f-117b-4726-af84-39020c77e8ab",
  "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": "70e83988-3b57-474a-a65c-c84d30e3079d",
  "messageAuditMessageAuditTypeId": "91c08ed7-1c15-40ac-a84f-b669296ad9fe",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-07-22T00:21:50.9930007+00:00",
  "messageAuditUpdatedDateUtc": "2026-07-22T00:21:50.9930007+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-07-22T00:21:50.9930007+00:00",
  "updatedDateUtc": "2026-07-22T00:21:50.9930007+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-07-22T00:21:50.9930007+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-07-22T00:21:50.9930007+00:00</UpdatedDateUtc>
  <ApplicationId>524d8b54-860b-4706-a029-8cced07768ac</ApplicationId>
  <ApplicationVersionId>d484786f-117b-4726-af84-39020c77e8ab</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>f5af2169-c44f-4a7a-89f7-cec6ae553287</DeviceGroupId>
  <DeviceId>ba821d36-3d9b-40d5-87a0-183612cd649c</DeviceId>
  <MessageAuditCreatedDateUtc>2026-07-22T00:21:50.9930007+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>70e83988-3b57-474a-a65c-c84d30e3079d</MessageAuditId>
  <MessageAuditMessageAuditTypeId>91c08ed7-1c15-40ac-a84f-b669296ad9fe</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-07-22T00:21:50.9930007+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>640dcae0-ef57-4188-994e-64a1064581a3</MessageId>
  <MessageTypeId>f0bdd07c-810c-474a-a402-7a27a7785bbc</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>36fd638b-ca31-4f91-b480-a323ff7055c9</TenantId>
  <UserGroupId>08e573d1-7818-430b-b7d8-53b98bfe8cd2</UserGroupId>
  <UserId>e7ba3990-b902-4151-b59f-1331637b6664</UserId>
</MessageRepresentation>