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": "0217d51c-2ec4-4cac-a8d4-384fda55c236",
  "tenantId": "dfa0ef14-47ed-4751-a544-9ddd4326fc4d",
  "messageTypeId": "6176ec4a-2b6a-4eb7-b71a-f09494f0ef84",
  "messageTypeLookupKey": "sample string 4",
  "userId": "cff10c52-5876-4ad6-817a-f363af5bfa11",
  "userGroupId": "7cff9c91-2248-48e7-8ba2-81e7712cdbae",
  "deviceId": "1edef5b9-5a32-453f-a166-b508a20a05d7",
  "deviceGroupId": "281278ee-c0bf-4625-b3d4-a1f7da3f99ec",
  "applicationId": "002e9a15-e68d-4a62-97a0-b782fa9678a0",
  "applicationVersionId": "ff390d87-234c-4722-b5c7-bc53f6889b26",
  "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": "a70bde0e-e8ed-4fe2-a3c4-8f0fe4e0f00f",
  "messageAuditMessageAuditTypeId": "78e49336-7b85-42e0-be38-42a2118c8a9d",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-09-30T19:49:09.3063196+00:00",
  "messageAuditUpdatedDateUtc": "2026-09-30T19:49:09.3063196+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-09-30T19:49:09.3063196+00:00",
  "updatedDateUtc": "2026-09-30T19:49:09.3063196+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-30T19:49:09.3063196+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-30T19:49:09.3063196+00:00</UpdatedDateUtc>
  <ApplicationId>002e9a15-e68d-4a62-97a0-b782fa9678a0</ApplicationId>
  <ApplicationVersionId>ff390d87-234c-4722-b5c7-bc53f6889b26</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>281278ee-c0bf-4625-b3d4-a1f7da3f99ec</DeviceGroupId>
  <DeviceId>1edef5b9-5a32-453f-a166-b508a20a05d7</DeviceId>
  <MessageAuditCreatedDateUtc>2026-09-30T19:49:09.3063196+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>a70bde0e-e8ed-4fe2-a3c4-8f0fe4e0f00f</MessageAuditId>
  <MessageAuditMessageAuditTypeId>78e49336-7b85-42e0-be38-42a2118c8a9d</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-09-30T19:49:09.3063196+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>0217d51c-2ec4-4cac-a8d4-384fda55c236</MessageId>
  <MessageTypeId>6176ec4a-2b6a-4eb7-b71a-f09494f0ef84</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>dfa0ef14-47ed-4751-a544-9ddd4326fc4d</TenantId>
  <UserGroupId>7cff9c91-2248-48e7-8ba2-81e7712cdbae</UserGroupId>
  <UserId>cff10c52-5876-4ad6-817a-f363af5bfa11</UserId>
</MessageRepresentation>