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": "6e8153bb-e590-4348-8313-782d3b906282",
  "tenantId": "3e2512d0-eab3-4486-b691-e281ac7eeaef",
  "messageTypeId": "c027ed88-108d-4f5b-938f-2d8c61535f81",
  "messageTypeLookupKey": "sample string 4",
  "userId": "cf5a63b7-fe8d-42ad-adc4-7f961ceb0e4a",
  "userGroupId": "763d8fae-40b3-4d6e-b580-eea93db5d38e",
  "deviceId": "eecca96a-629a-4539-8401-a993b1e9cebd",
  "deviceGroupId": "4c443be9-7758-4027-b7cf-cc42c5bfc078",
  "applicationId": "06a07d9e-bd6d-4d9a-bbb7-c7929a54c67b",
  "applicationVersionId": "915f23aa-bdf3-4430-b66a-14dad7da7b23",
  "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": "322bd90c-d98e-48f6-aa55-a29c16976a38",
  "messageAuditMessageAuditTypeId": "dd35db15-a0d8-4dc4-81f8-b6104e5c0cf9",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-07-10T15:49:11.237694+00:00",
  "messageAuditUpdatedDateUtc": "2026-07-10T15:49:11.237694+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-07-10T15:49:11.237694+00:00",
  "updatedDateUtc": "2026-07-10T15:49:11.237694+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-07-10T15:49:11.237694+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-07-10T15:49:11.237694+00:00</UpdatedDateUtc>
  <ApplicationId>06a07d9e-bd6d-4d9a-bbb7-c7929a54c67b</ApplicationId>
  <ApplicationVersionId>915f23aa-bdf3-4430-b66a-14dad7da7b23</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>4c443be9-7758-4027-b7cf-cc42c5bfc078</DeviceGroupId>
  <DeviceId>eecca96a-629a-4539-8401-a993b1e9cebd</DeviceId>
  <MessageAuditCreatedDateUtc>2026-07-10T15:49:11.237694+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>322bd90c-d98e-48f6-aa55-a29c16976a38</MessageAuditId>
  <MessageAuditMessageAuditTypeId>dd35db15-a0d8-4dc4-81f8-b6104e5c0cf9</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-07-10T15:49:11.237694+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>6e8153bb-e590-4348-8313-782d3b906282</MessageId>
  <MessageTypeId>c027ed88-108d-4f5b-938f-2d8c61535f81</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>3e2512d0-eab3-4486-b691-e281ac7eeaef</TenantId>
  <UserGroupId>763d8fae-40b3-4d6e-b580-eea93db5d38e</UserGroupId>
  <UserId>cf5a63b7-fe8d-42ad-adc4-7f961ceb0e4a</UserId>
</MessageRepresentation>