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": "0d922602-38ce-4312-8dc8-6aab0ea85a83",
  "tenantId": "a573b8d1-2115-4e39-bf94-091bd0467c8c",
  "messageTypeId": "24fc071b-8d22-4064-89c9-a75dd1dad17d",
  "messageTypeLookupKey": "sample string 4",
  "userId": "6b27b520-08ff-4cbc-bf15-c8d7f4ece203",
  "userGroupId": "cc71fb7a-6a42-438c-9396-86fe33c80bd4",
  "deviceId": "d2b494da-b4c0-49cb-9296-b08048750aec",
  "deviceGroupId": "bcf07ed9-9dc1-4b85-b9f4-bf7b05c8e647",
  "applicationId": "b7c58098-cad6-4f40-9427-4b6ea037259a",
  "applicationVersionId": "a337798f-f040-4937-87ee-00f73c1f951b",
  "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": "48148c60-e31d-428f-a55a-9b84c1ca631a",
  "messageAuditMessageAuditTypeId": "e7f6f0a3-5eab-42c1-9098-35de7ac5ec38",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-11-15T11:39:24.572374+00:00",
  "messageAuditUpdatedDateUtc": "2025-11-15T11:39:24.572374+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-11-15T11:39:24.572374+00:00",
  "updatedDateUtc": "2025-11-15T11:39:24.572374+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>2025-11-15T11:39:24.572374+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-15T11:39:24.572374+00:00</UpdatedDateUtc>
  <ApplicationId>b7c58098-cad6-4f40-9427-4b6ea037259a</ApplicationId>
  <ApplicationVersionId>a337798f-f040-4937-87ee-00f73c1f951b</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>bcf07ed9-9dc1-4b85-b9f4-bf7b05c8e647</DeviceGroupId>
  <DeviceId>d2b494da-b4c0-49cb-9296-b08048750aec</DeviceId>
  <MessageAuditCreatedDateUtc>2025-11-15T11:39:24.572374+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>48148c60-e31d-428f-a55a-9b84c1ca631a</MessageAuditId>
  <MessageAuditMessageAuditTypeId>e7f6f0a3-5eab-42c1-9098-35de7ac5ec38</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-11-15T11:39:24.572374+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>0d922602-38ce-4312-8dc8-6aab0ea85a83</MessageId>
  <MessageTypeId>24fc071b-8d22-4064-89c9-a75dd1dad17d</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>a573b8d1-2115-4e39-bf94-091bd0467c8c</TenantId>
  <UserGroupId>cc71fb7a-6a42-438c-9396-86fe33c80bd4</UserGroupId>
  <UserId>6b27b520-08ff-4cbc-bf15-c8d7f4ece203</UserId>
</MessageRepresentation>