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": "328d7a34-c0b2-40d7-9fe8-0a90940fa76e",
  "tenantId": "b25ad191-b0da-437a-bb16-6f325bdc4a80",
  "messageTypeId": "13090ddb-cc67-44ed-8213-71a6d74615f4",
  "messageTypeLookupKey": "sample string 4",
  "userId": "7595b270-8d07-4d6a-a891-a830a7456466",
  "userGroupId": "4a019deb-eee2-45c9-9cc7-1b394e99ac12",
  "deviceId": "06cc11d5-5cdd-4910-a901-5f7d9a8c3a2c",
  "deviceGroupId": "86498b96-b2b8-4173-bd7e-78d8f4247c7e",
  "applicationId": "83a5fe62-a21a-483d-89f5-7aa1aef8e6f2",
  "applicationVersionId": "08106904-30b0-48bc-932f-05cef83a5774",
  "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": "13eb9bc4-6e9c-4e51-9666-16b85d24285d",
  "messageAuditMessageAuditTypeId": "fc8b9a17-b856-4216-92c1-fdfcd90ac67e",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-06-09T04:26:28.3783206+00:00",
  "messageAuditUpdatedDateUtc": "2025-06-09T04:26:28.3783206+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-06-09T04:26:28.3783206+00:00",
  "updatedDateUtc": "2025-06-09T04:26:28.3783206+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-06-09T04:26:28.3783206+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-06-09T04:26:28.3783206+00:00</UpdatedDateUtc>
  <ApplicationId>83a5fe62-a21a-483d-89f5-7aa1aef8e6f2</ApplicationId>
  <ApplicationVersionId>08106904-30b0-48bc-932f-05cef83a5774</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>86498b96-b2b8-4173-bd7e-78d8f4247c7e</DeviceGroupId>
  <DeviceId>06cc11d5-5cdd-4910-a901-5f7d9a8c3a2c</DeviceId>
  <MessageAuditCreatedDateUtc>2025-06-09T04:26:28.3783206+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>13eb9bc4-6e9c-4e51-9666-16b85d24285d</MessageAuditId>
  <MessageAuditMessageAuditTypeId>fc8b9a17-b856-4216-92c1-fdfcd90ac67e</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-06-09T04:26:28.3783206+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>328d7a34-c0b2-40d7-9fe8-0a90940fa76e</MessageId>
  <MessageTypeId>13090ddb-cc67-44ed-8213-71a6d74615f4</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>b25ad191-b0da-437a-bb16-6f325bdc4a80</TenantId>
  <UserGroupId>4a019deb-eee2-45c9-9cc7-1b394e99ac12</UserGroupId>
  <UserId>7595b270-8d07-4d6a-a891-a830a7456466</UserId>
</MessageRepresentation>