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": "5c1cbd6f-82fa-4ed4-b0c8-2390a5cdd5ef",
  "tenantId": "706e7aed-e693-4fa0-8276-8391d1f2477d",
  "messageTypeId": "e488f60b-8f01-453a-9ec1-93e8a0c400f9",
  "messageTypeLookupKey": "sample string 4",
  "userId": "bec6b3eb-94e1-4285-be84-318063c80fd7",
  "userGroupId": "7bf3d702-f1ed-44a2-8594-f97133d306c2",
  "deviceId": "98d9ab11-987a-4163-a8a2-a309082b5f52",
  "deviceGroupId": "784853ea-aaec-4282-a7c7-2e0239ad7592",
  "applicationId": "258d4a0a-f57a-4a6a-b5e1-64541412a385",
  "applicationVersionId": "a51c094b-3295-40ca-8c9b-1bd30abfde9a",
  "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": "ce58cf2b-c91d-4366-b8a3-2dbb498d41c9",
  "messageAuditMessageAuditTypeId": "255e4708-875e-4c3f-a2dd-c915c0ba34c2",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-24T13:49:21.0032749+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-24T13:49:21.0032749+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-24T13:49:21.0032749+00:00",
  "updatedDateUtc": "2026-06-24T13:49:21.0032749+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-06-24T13:49:21.0032749+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-24T13:49:21.0032749+00:00</UpdatedDateUtc>
  <ApplicationId>258d4a0a-f57a-4a6a-b5e1-64541412a385</ApplicationId>
  <ApplicationVersionId>a51c094b-3295-40ca-8c9b-1bd30abfde9a</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>784853ea-aaec-4282-a7c7-2e0239ad7592</DeviceGroupId>
  <DeviceId>98d9ab11-987a-4163-a8a2-a309082b5f52</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-24T13:49:21.0032749+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>ce58cf2b-c91d-4366-b8a3-2dbb498d41c9</MessageAuditId>
  <MessageAuditMessageAuditTypeId>255e4708-875e-4c3f-a2dd-c915c0ba34c2</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-24T13:49:21.0032749+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>5c1cbd6f-82fa-4ed4-b0c8-2390a5cdd5ef</MessageId>
  <MessageTypeId>e488f60b-8f01-453a-9ec1-93e8a0c400f9</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>706e7aed-e693-4fa0-8276-8391d1f2477d</TenantId>
  <UserGroupId>7bf3d702-f1ed-44a2-8594-f97133d306c2</UserGroupId>
  <UserId>bec6b3eb-94e1-4285-be84-318063c80fd7</UserId>
</MessageRepresentation>