Cyan Web API - Version 1


GET api/messages/{messageId}

            Gets a Message.
            

Request Information

Parameters

NameDescriptionAdditional information
messageId

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "messageId": "3825a7ce-091a-4847-8f3d-80e29e341a18",
  "tenantId": "49e3f914-5cc2-492a-946b-f185288b27e3",
  "messageTypeId": "2a99a05a-eec9-4b54-b2e5-5d391b75cf9d",
  "messageTypeLookupKey": "sample string 4",
  "userId": "f826a4db-f1b0-45f7-bacd-5c9a994ad426",
  "userGroupId": "ebe9ef0a-3940-4da2-8cc3-2aad08060312",
  "deviceId": "209f6474-75b8-48c9-8308-1c6fe135b302",
  "deviceGroupId": "68bd0502-271b-44e4-ab6f-48f92c819610",
  "applicationId": "cbd64935-72f3-4968-8242-bf6a7e7e7b97",
  "applicationVersionId": "d77bcf5b-f62e-4421-b09f-3043bed94816",
  "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": "de85271e-c414-472b-96d8-2421ad82cf52",
  "messageAuditMessageAuditTypeId": "4fea736a-7ed2-49e0-8d95-3bbeff9c6432",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-09-22T17:40:14.6552848+00:00",
  "messageAuditUpdatedDateUtc": "2026-09-22T17:40:14.6552848+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-09-22T17:40:14.6552848+00:00",
  "updatedDateUtc": "2026-09-22T17:40:14.6552848+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-22T17:40:14.6552848+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-22T17:40:14.6552848+00:00</UpdatedDateUtc>
  <ApplicationId>cbd64935-72f3-4968-8242-bf6a7e7e7b97</ApplicationId>
  <ApplicationVersionId>d77bcf5b-f62e-4421-b09f-3043bed94816</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>68bd0502-271b-44e4-ab6f-48f92c819610</DeviceGroupId>
  <DeviceId>209f6474-75b8-48c9-8308-1c6fe135b302</DeviceId>
  <MessageAuditCreatedDateUtc>2026-09-22T17:40:14.6552848+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>de85271e-c414-472b-96d8-2421ad82cf52</MessageAuditId>
  <MessageAuditMessageAuditTypeId>4fea736a-7ed2-49e0-8d95-3bbeff9c6432</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-09-22T17:40:14.6552848+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>3825a7ce-091a-4847-8f3d-80e29e341a18</MessageId>
  <MessageTypeId>2a99a05a-eec9-4b54-b2e5-5d391b75cf9d</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>49e3f914-5cc2-492a-946b-f185288b27e3</TenantId>
  <UserGroupId>ebe9ef0a-3940-4da2-8cc3-2aad08060312</UserGroupId>
  <UserId>f826a4db-f1b0-45f7-bacd-5c9a994ad426</UserId>
</MessageRepresentation>