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": "caf46c22-6566-4003-82e0-811119c7e1f6",
  "tenantId": "4d2c69c6-bb98-437d-87d4-19253ccae7f8",
  "messageTypeId": "3017f499-5270-4318-8880-90df21cd3625",
  "messageTypeLookupKey": "sample string 4",
  "userId": "244b42d5-60ef-43f9-828d-d322cdef084a",
  "userGroupId": "93051642-bb38-4dd3-8da6-5ba11eb8194f",
  "deviceId": "3a31c0bb-eaee-4b6e-930e-04802cf5845c",
  "deviceGroupId": "ade258f1-3f10-4f0b-9038-271a821d0124",
  "applicationId": "a8d5faf6-103b-4dec-801b-5108f21e7a03",
  "applicationVersionId": "20433157-b021-493f-b9bc-7ab4866939e0",
  "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": "3cb4aa6d-293b-4b6c-807f-0dac45b1345d",
  "messageAuditMessageAuditTypeId": "82d2e0a6-fb98-46c0-99d3-0696d371f8af",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-05-11T10:11:51.2261247+00:00",
  "messageAuditUpdatedDateUtc": "2026-05-11T10:11:51.2261247+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-05-11T10:11:51.2261247+00:00",
  "updatedDateUtc": "2026-05-11T10:11:51.2261247+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-05-11T10:11:51.2261247+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-05-11T10:11:51.2261247+00:00</UpdatedDateUtc>
  <ApplicationId>a8d5faf6-103b-4dec-801b-5108f21e7a03</ApplicationId>
  <ApplicationVersionId>20433157-b021-493f-b9bc-7ab4866939e0</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>ade258f1-3f10-4f0b-9038-271a821d0124</DeviceGroupId>
  <DeviceId>3a31c0bb-eaee-4b6e-930e-04802cf5845c</DeviceId>
  <MessageAuditCreatedDateUtc>2026-05-11T10:11:51.2261247+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>3cb4aa6d-293b-4b6c-807f-0dac45b1345d</MessageAuditId>
  <MessageAuditMessageAuditTypeId>82d2e0a6-fb98-46c0-99d3-0696d371f8af</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-05-11T10:11:51.2261247+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>caf46c22-6566-4003-82e0-811119c7e1f6</MessageId>
  <MessageTypeId>3017f499-5270-4318-8880-90df21cd3625</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>4d2c69c6-bb98-437d-87d4-19253ccae7f8</TenantId>
  <UserGroupId>93051642-bb38-4dd3-8da6-5ba11eb8194f</UserGroupId>
  <UserId>244b42d5-60ef-43f9-828d-d322cdef084a</UserId>
</MessageRepresentation>