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": "4dd71412-a9ed-4cb2-a95c-065e93165a2c",
  "tenantId": "6dccccb2-79cd-4a49-87fc-c967a5ebf45e",
  "messageTypeId": "7bbe04f6-7c63-4fc3-b21d-47b185ed13a7",
  "messageTypeLookupKey": "sample string 4",
  "userId": "578777dc-c725-4cb6-a2a0-8f1be2f91246",
  "userGroupId": "8355da1f-a2a8-4fac-9ff4-392ebe3c3655",
  "deviceId": "5073153f-ddaf-4597-bec0-44e0899b8628",
  "deviceGroupId": "25cff1dc-db9e-47d1-99a9-7df5bb96e647",
  "applicationId": "85277f35-6e29-4dfa-9a4a-9aab60b33498",
  "applicationVersionId": "5ad7cbbe-b4a7-4f7b-85be-43eeff40a48e",
  "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": "9cf3ef2d-0579-4265-af8e-f6a506c6232d",
  "messageAuditMessageAuditTypeId": "f125e600-c27a-45ec-9864-97dd90f3b67c",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-04-24T23:47:29.8358552+00:00",
  "messageAuditUpdatedDateUtc": "2026-04-24T23:47:29.8358552+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-04-24T23:47:29.8358552+00:00",
  "updatedDateUtc": "2026-04-24T23:47:29.8358552+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-04-24T23:47:29.8358552+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-24T23:47:29.8358552+00:00</UpdatedDateUtc>
  <ApplicationId>85277f35-6e29-4dfa-9a4a-9aab60b33498</ApplicationId>
  <ApplicationVersionId>5ad7cbbe-b4a7-4f7b-85be-43eeff40a48e</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>25cff1dc-db9e-47d1-99a9-7df5bb96e647</DeviceGroupId>
  <DeviceId>5073153f-ddaf-4597-bec0-44e0899b8628</DeviceId>
  <MessageAuditCreatedDateUtc>2026-04-24T23:47:29.8358552+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>9cf3ef2d-0579-4265-af8e-f6a506c6232d</MessageAuditId>
  <MessageAuditMessageAuditTypeId>f125e600-c27a-45ec-9864-97dd90f3b67c</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-04-24T23:47:29.8358552+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>4dd71412-a9ed-4cb2-a95c-065e93165a2c</MessageId>
  <MessageTypeId>7bbe04f6-7c63-4fc3-b21d-47b185ed13a7</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>6dccccb2-79cd-4a49-87fc-c967a5ebf45e</TenantId>
  <UserGroupId>8355da1f-a2a8-4fac-9ff4-392ebe3c3655</UserGroupId>
  <UserId>578777dc-c725-4cb6-a2a0-8f1be2f91246</UserId>
</MessageRepresentation>