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": "a243b678-189b-4821-94ac-88717b24663d",
  "tenantId": "1800657a-7caa-410c-8575-0a37c11a3279",
  "messageTypeId": "ac09783a-be05-40f6-a236-9dee39f6414c",
  "messageTypeLookupKey": "sample string 4",
  "userId": "0a0f7e0f-0c1f-41ae-b236-dda867802c28",
  "userGroupId": "822e1472-56e8-41de-9944-b3b9d69d9ee3",
  "deviceId": "afd46d7b-0ea5-4289-96ae-7f573bd3ca81",
  "deviceGroupId": "d29b107a-2ea6-46a6-b720-24352d79b128",
  "applicationId": "da817c87-8f96-45a5-abb7-f67f02364a33",
  "applicationVersionId": "9dab061e-c260-4e12-bca4-ec2c4b2a9cdb",
  "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": "d293392b-1fee-45a4-89c8-fb59a7d79cc8",
  "messageAuditMessageAuditTypeId": "9e6abb46-0f76-4aac-95be-82460221b844",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-04-21T02:09:28.5664342+00:00",
  "messageAuditUpdatedDateUtc": "2025-04-21T02:09:28.5664342+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-04-21T02:09:28.5664342+00:00",
  "updatedDateUtc": "2025-04-21T02:09:28.5664342+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-04-21T02:09:28.5664342+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-04-21T02:09:28.5664342+00:00</UpdatedDateUtc>
  <ApplicationId>da817c87-8f96-45a5-abb7-f67f02364a33</ApplicationId>
  <ApplicationVersionId>9dab061e-c260-4e12-bca4-ec2c4b2a9cdb</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>d29b107a-2ea6-46a6-b720-24352d79b128</DeviceGroupId>
  <DeviceId>afd46d7b-0ea5-4289-96ae-7f573bd3ca81</DeviceId>
  <MessageAuditCreatedDateUtc>2025-04-21T02:09:28.5664342+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>d293392b-1fee-45a4-89c8-fb59a7d79cc8</MessageAuditId>
  <MessageAuditMessageAuditTypeId>9e6abb46-0f76-4aac-95be-82460221b844</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-04-21T02:09:28.5664342+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>a243b678-189b-4821-94ac-88717b24663d</MessageId>
  <MessageTypeId>ac09783a-be05-40f6-a236-9dee39f6414c</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>1800657a-7caa-410c-8575-0a37c11a3279</TenantId>
  <UserGroupId>822e1472-56e8-41de-9944-b3b9d69d9ee3</UserGroupId>
  <UserId>0a0f7e0f-0c1f-41ae-b236-dda867802c28</UserId>
</MessageRepresentation>