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": "73e221e4-3bc0-4a3b-809c-c76cbb852ed0",
  "tenantId": "ff5418ea-551b-4b58-bcba-c2be083d2e96",
  "messageTypeId": "83114d73-7e20-4020-87ae-8583e6fe0efa",
  "messageTypeLookupKey": "sample string 4",
  "userId": "b2b8454f-53a7-4cc8-82fb-be9ae56b8ff3",
  "userGroupId": "d79691dd-1bdb-4f79-8da1-b987f338dd83",
  "deviceId": "c358a056-3e04-4b81-bbd6-df4f20f7bc00",
  "deviceGroupId": "38824e6c-1a87-4ebd-99a6-d04b3b732ba9",
  "applicationId": "c1fb3f1c-f6cc-4b20-9d55-16ae0bb3f98e",
  "applicationVersionId": "26fd51cd-b89f-4e8f-aa31-00ec2c069afc",
  "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": "0e85622a-35ac-4e86-9115-75e8dd33b05b",
  "messageAuditMessageAuditTypeId": "a094620a-5bce-4f79-8dc0-83126ef28b8a",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-08-06T02:04:16.2558071+00:00",
  "messageAuditUpdatedDateUtc": "2026-08-06T02:04:16.2558071+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-08-06T02:04:16.2558071+00:00",
  "updatedDateUtc": "2026-08-06T02:04:16.2558071+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-08-06T02:04:16.2558071+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-06T02:04:16.2558071+00:00</UpdatedDateUtc>
  <ApplicationId>c1fb3f1c-f6cc-4b20-9d55-16ae0bb3f98e</ApplicationId>
  <ApplicationVersionId>26fd51cd-b89f-4e8f-aa31-00ec2c069afc</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>38824e6c-1a87-4ebd-99a6-d04b3b732ba9</DeviceGroupId>
  <DeviceId>c358a056-3e04-4b81-bbd6-df4f20f7bc00</DeviceId>
  <MessageAuditCreatedDateUtc>2026-08-06T02:04:16.2558071+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>0e85622a-35ac-4e86-9115-75e8dd33b05b</MessageAuditId>
  <MessageAuditMessageAuditTypeId>a094620a-5bce-4f79-8dc0-83126ef28b8a</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-08-06T02:04:16.2558071+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>73e221e4-3bc0-4a3b-809c-c76cbb852ed0</MessageId>
  <MessageTypeId>83114d73-7e20-4020-87ae-8583e6fe0efa</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>ff5418ea-551b-4b58-bcba-c2be083d2e96</TenantId>
  <UserGroupId>d79691dd-1bdb-4f79-8da1-b987f338dd83</UserGroupId>
  <UserId>b2b8454f-53a7-4cc8-82fb-be9ae56b8ff3</UserId>
</MessageRepresentation>