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": "d9dd2124-8225-4f7a-b3c4-925012ad3e85",
  "tenantId": "10a1b27b-4158-4bc8-b0b6-6f11c39187d6",
  "messageTypeId": "b97859d2-a77d-46ae-92c1-db7424fd6cc8",
  "messageTypeLookupKey": "sample string 4",
  "userId": "3cb87f8e-a15f-4b95-a7f9-18f8051ad26f",
  "userGroupId": "f53ce3f1-a459-41a3-9a7d-694a8f38a971",
  "deviceId": "0cc8f89a-a99d-4ddd-8f76-b4cf8bcf9219",
  "deviceGroupId": "98f96941-49ad-437b-8976-641dbd3860d3",
  "applicationId": "c1260b14-deee-4851-8da0-f0f665146b8b",
  "applicationVersionId": "9b07e83e-7fa9-4565-933c-67c0cbfae166",
  "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": "20d854df-bcf2-4722-8001-72297860de1e",
  "messageAuditMessageAuditTypeId": "b2820f46-217f-4c90-92cf-d000b4fd7e27",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-04-28T00:36:46.7092038+00:00",
  "messageAuditUpdatedDateUtc": "2026-04-28T00:36:46.7092038+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-04-28T00:36:46.7092038+00:00",
  "updatedDateUtc": "2026-04-28T00:36:46.7092038+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-04-28T00:36:46.7092038+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-28T00:36:46.7092038+00:00</UpdatedDateUtc>
  <ApplicationId>c1260b14-deee-4851-8da0-f0f665146b8b</ApplicationId>
  <ApplicationVersionId>9b07e83e-7fa9-4565-933c-67c0cbfae166</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>98f96941-49ad-437b-8976-641dbd3860d3</DeviceGroupId>
  <DeviceId>0cc8f89a-a99d-4ddd-8f76-b4cf8bcf9219</DeviceId>
  <MessageAuditCreatedDateUtc>2026-04-28T00:36:46.7092038+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>20d854df-bcf2-4722-8001-72297860de1e</MessageAuditId>
  <MessageAuditMessageAuditTypeId>b2820f46-217f-4c90-92cf-d000b4fd7e27</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-04-28T00:36:46.7092038+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>d9dd2124-8225-4f7a-b3c4-925012ad3e85</MessageId>
  <MessageTypeId>b97859d2-a77d-46ae-92c1-db7424fd6cc8</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>10a1b27b-4158-4bc8-b0b6-6f11c39187d6</TenantId>
  <UserGroupId>f53ce3f1-a459-41a3-9a7d-694a8f38a971</UserGroupId>
  <UserId>3cb87f8e-a15f-4b95-a7f9-18f8051ad26f</UserId>
</MessageRepresentation>