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": "e5106386-43b0-4534-8e9a-ca1af0df8a7a",
  "tenantId": "96fa9932-9c63-4786-8ce9-89a5ce8eed45",
  "messageTypeId": "172f52c7-e9d6-4b3b-b896-38be998d863b",
  "messageTypeLookupKey": "sample string 4",
  "userId": "71f801f1-a962-4a23-bd03-23d436612180",
  "userGroupId": "ac437f04-69f6-4ce8-9a2f-65563e34072a",
  "deviceId": "e3f1320b-f0ec-43cb-9a8b-f5ef80219b96",
  "deviceGroupId": "8730d355-5d82-4fa1-8af8-9278a1bf9981",
  "applicationId": "4c736ec3-5ae3-4367-9cb5-497dfd8b7150",
  "applicationVersionId": "10b2c351-7ae3-488b-b6a8-8d502b49547e",
  "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": "3373100d-edbe-4cad-8581-221853e1f467",
  "messageAuditMessageAuditTypeId": "2c44b511-fac9-4dc6-8ee3-79c4d89ad8e3",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-02-04T00:30:32.8905542+00:00",
  "messageAuditUpdatedDateUtc": "2026-02-04T00:30:32.8905542+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-02-04T00:30:32.8905542+00:00",
  "updatedDateUtc": "2026-02-04T00:30:32.8905542+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-02-04T00:30:32.8905542+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-04T00:30:32.8905542+00:00</UpdatedDateUtc>
  <ApplicationId>4c736ec3-5ae3-4367-9cb5-497dfd8b7150</ApplicationId>
  <ApplicationVersionId>10b2c351-7ae3-488b-b6a8-8d502b49547e</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>8730d355-5d82-4fa1-8af8-9278a1bf9981</DeviceGroupId>
  <DeviceId>e3f1320b-f0ec-43cb-9a8b-f5ef80219b96</DeviceId>
  <MessageAuditCreatedDateUtc>2026-02-04T00:30:32.8905542+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>3373100d-edbe-4cad-8581-221853e1f467</MessageAuditId>
  <MessageAuditMessageAuditTypeId>2c44b511-fac9-4dc6-8ee3-79c4d89ad8e3</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-02-04T00:30:32.8905542+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>e5106386-43b0-4534-8e9a-ca1af0df8a7a</MessageId>
  <MessageTypeId>172f52c7-e9d6-4b3b-b896-38be998d863b</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>96fa9932-9c63-4786-8ce9-89a5ce8eed45</TenantId>
  <UserGroupId>ac437f04-69f6-4ce8-9a2f-65563e34072a</UserGroupId>
  <UserId>71f801f1-a962-4a23-bd03-23d436612180</UserId>
</MessageRepresentation>