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": "a8d777f2-6a8a-47b0-a573-46da6904a419",
  "tenantId": "f77ecd4c-dba2-44b2-994b-1b1319d9bffb",
  "messageTypeId": "f7acc47a-b3b8-4958-b021-60ad4eac6750",
  "messageTypeLookupKey": "sample string 4",
  "userId": "88c13817-629c-4ea3-b8b2-4adcc19985b4",
  "userGroupId": "de72590c-b064-40be-bb3e-31e0c42cee9a",
  "deviceId": "e25280ef-8329-4bda-9ac0-2726d148e330",
  "deviceGroupId": "a2afaea6-ddfb-46ca-9661-8d1a8a22bf0c",
  "applicationId": "afe11754-d15e-4bc6-b69c-896ab9ed14c6",
  "applicationVersionId": "2e068854-71ea-4ad8-8757-a420e320e88c",
  "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": "93f1d08f-4887-4127-87f4-4a845b31aedf",
  "messageAuditMessageAuditTypeId": "341a4974-7e77-4848-9802-d71e59046e49",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-28T17:18:45.1239147+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-28T17:18:45.1239147+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-28T17:18:45.1239147+00:00",
  "updatedDateUtc": "2026-03-28T17:18:45.1239147+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-03-28T17:18:45.1239147+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-28T17:18:45.1239147+00:00</UpdatedDateUtc>
  <ApplicationId>afe11754-d15e-4bc6-b69c-896ab9ed14c6</ApplicationId>
  <ApplicationVersionId>2e068854-71ea-4ad8-8757-a420e320e88c</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>a2afaea6-ddfb-46ca-9661-8d1a8a22bf0c</DeviceGroupId>
  <DeviceId>e25280ef-8329-4bda-9ac0-2726d148e330</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-28T17:18:45.1239147+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>93f1d08f-4887-4127-87f4-4a845b31aedf</MessageAuditId>
  <MessageAuditMessageAuditTypeId>341a4974-7e77-4848-9802-d71e59046e49</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-28T17:18:45.1239147+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>a8d777f2-6a8a-47b0-a573-46da6904a419</MessageId>
  <MessageTypeId>f7acc47a-b3b8-4958-b021-60ad4eac6750</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>f77ecd4c-dba2-44b2-994b-1b1319d9bffb</TenantId>
  <UserGroupId>de72590c-b064-40be-bb3e-31e0c42cee9a</UserGroupId>
  <UserId>88c13817-629c-4ea3-b8b2-4adcc19985b4</UserId>
</MessageRepresentation>