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": "542da8e3-7dd0-488d-aedb-47fd3b450d0b",
  "tenantId": "9325be1b-a0ca-4414-8852-7ba434bf9de7",
  "messageTypeId": "9b2cfa86-0530-45d4-a5f7-c8803abe23f2",
  "messageTypeLookupKey": "sample string 4",
  "userId": "712b711a-d981-4cfb-a40f-9ae07bda4eab",
  "userGroupId": "b7f4ba5d-a106-4c8f-9a54-df04650aefa5",
  "deviceId": "f27bacd3-ee97-498c-9b83-5a1edd417794",
  "deviceGroupId": "6b5bc82a-acf0-48dd-a114-c5c301b2d02f",
  "applicationId": "9838f849-064b-488d-9aa1-2b5b961c4ab8",
  "applicationVersionId": "3ad49c73-535d-455c-8440-5fcf7292d6d3",
  "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": "936c9d0f-b678-4e4a-a741-25b3a1e3a2d4",
  "messageAuditMessageAuditTypeId": "d4abb136-46ff-46bc-9f88-345795dfe5c6",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-09-13T07:29:58.7087058+00:00",
  "messageAuditUpdatedDateUtc": "2025-09-13T07:29:58.7087058+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-09-13T07:29:58.7087058+00:00",
  "updatedDateUtc": "2025-09-13T07:29:58.7087058+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>2025-09-13T07:29:58.7087058+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-09-13T07:29:58.7087058+00:00</UpdatedDateUtc>
  <ApplicationId>9838f849-064b-488d-9aa1-2b5b961c4ab8</ApplicationId>
  <ApplicationVersionId>3ad49c73-535d-455c-8440-5fcf7292d6d3</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>6b5bc82a-acf0-48dd-a114-c5c301b2d02f</DeviceGroupId>
  <DeviceId>f27bacd3-ee97-498c-9b83-5a1edd417794</DeviceId>
  <MessageAuditCreatedDateUtc>2025-09-13T07:29:58.7087058+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>936c9d0f-b678-4e4a-a741-25b3a1e3a2d4</MessageAuditId>
  <MessageAuditMessageAuditTypeId>d4abb136-46ff-46bc-9f88-345795dfe5c6</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-09-13T07:29:58.7087058+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>542da8e3-7dd0-488d-aedb-47fd3b450d0b</MessageId>
  <MessageTypeId>9b2cfa86-0530-45d4-a5f7-c8803abe23f2</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>9325be1b-a0ca-4414-8852-7ba434bf9de7</TenantId>
  <UserGroupId>b7f4ba5d-a106-4c8f-9a54-df04650aefa5</UserGroupId>
  <UserId>712b711a-d981-4cfb-a40f-9ae07bda4eab</UserId>
</MessageRepresentation>