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": "36d8a2c5-862f-4841-bf89-4b565fbae6b1",
  "tenantId": "0548694d-694d-4b18-a2fb-eed5ae95229d",
  "messageTypeId": "87f2bf1d-4b17-486c-8df9-65800bd4687d",
  "messageTypeLookupKey": "sample string 4",
  "userId": "a319140e-0986-4572-8b58-2163d21a972b",
  "userGroupId": "0289f34d-29fa-4b85-9def-b5864cae238a",
  "deviceId": "492ddf09-7019-4f36-b7b4-3af6454c7573",
  "deviceGroupId": "d7eb57c3-778d-4069-a083-52f4356da474",
  "applicationId": "8577152f-9c3b-44a8-84a2-998f94a88db9",
  "applicationVersionId": "2da47d70-cd3d-4ba0-9377-8646f7ddff1f",
  "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": "8175ad1c-6669-4f7c-8ed8-92072982a227",
  "messageAuditMessageAuditTypeId": "50dda7e7-347b-4659-aa40-70bbe26342f8",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-07-17T09:45:32.9011108+00:00",
  "messageAuditUpdatedDateUtc": "2025-07-17T09:45:32.9011108+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-07-17T09:45:32.9011108+00:00",
  "updatedDateUtc": "2025-07-17T09:45:32.9011108+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-07-17T09:45:32.9011108+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-07-17T09:45:32.9011108+00:00</UpdatedDateUtc>
  <ApplicationId>8577152f-9c3b-44a8-84a2-998f94a88db9</ApplicationId>
  <ApplicationVersionId>2da47d70-cd3d-4ba0-9377-8646f7ddff1f</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>d7eb57c3-778d-4069-a083-52f4356da474</DeviceGroupId>
  <DeviceId>492ddf09-7019-4f36-b7b4-3af6454c7573</DeviceId>
  <MessageAuditCreatedDateUtc>2025-07-17T09:45:32.9011108+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>8175ad1c-6669-4f7c-8ed8-92072982a227</MessageAuditId>
  <MessageAuditMessageAuditTypeId>50dda7e7-347b-4659-aa40-70bbe26342f8</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-07-17T09:45:32.9011108+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>36d8a2c5-862f-4841-bf89-4b565fbae6b1</MessageId>
  <MessageTypeId>87f2bf1d-4b17-486c-8df9-65800bd4687d</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>0548694d-694d-4b18-a2fb-eed5ae95229d</TenantId>
  <UserGroupId>0289f34d-29fa-4b85-9def-b5864cae238a</UserGroupId>
  <UserId>a319140e-0986-4572-8b58-2163d21a972b</UserId>
</MessageRepresentation>