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": "a4e33fc6-eafc-4fba-beed-e95415fe422e",
  "tenantId": "4a889cff-e19f-4b4a-a2cc-21a21f489bb0",
  "messageTypeId": "191fa4bc-df28-4712-9650-8136ae9e118c",
  "messageTypeLookupKey": "sample string 4",
  "userId": "b240c1ab-ea9b-4f24-ab1e-c0478c46545e",
  "userGroupId": "c4a4d6d1-6138-4ecf-bf41-4fbd2f9feb19",
  "deviceId": "8197e683-8010-4baf-8bcb-ebfe09aef15d",
  "deviceGroupId": "bbd21be0-c5b4-4a73-ba31-74eab2e24204",
  "applicationId": "85e1135b-f20b-4f94-b30c-ac9b983d26c1",
  "applicationVersionId": "dfdbd10b-fc1b-4f26-a61b-b834504ef7a1",
  "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": "0e38cf9f-361e-4969-9c3b-79c52b7c82da",
  "messageAuditMessageAuditTypeId": "2a8ae13d-2478-41f5-9122-3dc67919a935",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-09-11T11:01:25.0701833+00:00",
  "messageAuditUpdatedDateUtc": "2026-09-11T11:01:25.0701833+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-09-11T11:01:25.0701833+00:00",
  "updatedDateUtc": "2026-09-11T11:01:25.0701833+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-09-11T11:01:25.0701833+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-11T11:01:25.0701833+00:00</UpdatedDateUtc>
  <ApplicationId>85e1135b-f20b-4f94-b30c-ac9b983d26c1</ApplicationId>
  <ApplicationVersionId>dfdbd10b-fc1b-4f26-a61b-b834504ef7a1</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>bbd21be0-c5b4-4a73-ba31-74eab2e24204</DeviceGroupId>
  <DeviceId>8197e683-8010-4baf-8bcb-ebfe09aef15d</DeviceId>
  <MessageAuditCreatedDateUtc>2026-09-11T11:01:25.0701833+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>0e38cf9f-361e-4969-9c3b-79c52b7c82da</MessageAuditId>
  <MessageAuditMessageAuditTypeId>2a8ae13d-2478-41f5-9122-3dc67919a935</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-09-11T11:01:25.0701833+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>a4e33fc6-eafc-4fba-beed-e95415fe422e</MessageId>
  <MessageTypeId>191fa4bc-df28-4712-9650-8136ae9e118c</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>4a889cff-e19f-4b4a-a2cc-21a21f489bb0</TenantId>
  <UserGroupId>c4a4d6d1-6138-4ecf-bf41-4fbd2f9feb19</UserGroupId>
  <UserId>b240c1ab-ea9b-4f24-ab1e-c0478c46545e</UserId>
</MessageRepresentation>