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": "a2c5ea3d-c31b-4516-9bee-1ca663804acc",
  "tenantId": "44b8b796-4573-461e-b18c-36afe7f7d619",
  "messageTypeId": "d3393b59-5202-4249-81c5-4d7ee8acf287",
  "messageTypeLookupKey": "sample string 4",
  "userId": "b37dcbe9-e5a5-4389-9f61-67b3dd5eeaea",
  "userGroupId": "c16aec6c-8e52-484d-a6a1-9c48ea268e88",
  "deviceId": "3d9ee6a5-71c9-4eba-be14-e7ee5e29a7f6",
  "deviceGroupId": "8308d945-afaf-4141-8a2d-05102e42c5f6",
  "applicationId": "2ab55e52-110e-41d9-8985-9677fa6d662a",
  "applicationVersionId": "ff567673-eacd-45f5-8dc4-db9ce794ce85",
  "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": "81bd5f00-49cb-4ac3-94ac-1ca377007422",
  "messageAuditMessageAuditTypeId": "4f3e4bc8-1dae-4452-92ef-766ea29a73ad",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-08-02T07:19:58.0737471+00:00",
  "messageAuditUpdatedDateUtc": "2026-08-02T07:19:58.0737471+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-08-02T07:19:58.0737471+00:00",
  "updatedDateUtc": "2026-08-02T07:19:58.0737471+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-08-02T07:19:58.0737471+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-02T07:19:58.0737471+00:00</UpdatedDateUtc>
  <ApplicationId>2ab55e52-110e-41d9-8985-9677fa6d662a</ApplicationId>
  <ApplicationVersionId>ff567673-eacd-45f5-8dc4-db9ce794ce85</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>8308d945-afaf-4141-8a2d-05102e42c5f6</DeviceGroupId>
  <DeviceId>3d9ee6a5-71c9-4eba-be14-e7ee5e29a7f6</DeviceId>
  <MessageAuditCreatedDateUtc>2026-08-02T07:19:58.0737471+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>81bd5f00-49cb-4ac3-94ac-1ca377007422</MessageAuditId>
  <MessageAuditMessageAuditTypeId>4f3e4bc8-1dae-4452-92ef-766ea29a73ad</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-08-02T07:19:58.0737471+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>a2c5ea3d-c31b-4516-9bee-1ca663804acc</MessageId>
  <MessageTypeId>d3393b59-5202-4249-81c5-4d7ee8acf287</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>44b8b796-4573-461e-b18c-36afe7f7d619</TenantId>
  <UserGroupId>c16aec6c-8e52-484d-a6a1-9c48ea268e88</UserGroupId>
  <UserId>b37dcbe9-e5a5-4389-9f61-67b3dd5eeaea</UserId>
</MessageRepresentation>