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": "2d345182-bc4d-4541-b8a3-e0f2b3b425b5",
  "tenantId": "2f702f8f-cdfc-4e15-9ed7-599803100888",
  "messageTypeId": "4c96bdf1-1844-4b8c-ad82-fa80e5919b4b",
  "messageTypeLookupKey": "sample string 4",
  "userId": "5229ef3a-5000-4fa1-943f-fdf8f52548b1",
  "userGroupId": "7f082836-a77c-4037-bb83-1e70991854a9",
  "deviceId": "f02bc2be-35f4-4ecd-af6d-57278b725baa",
  "deviceGroupId": "0b011eac-6f78-45bf-8aa4-43b8bf14c06d",
  "applicationId": "fd54da78-98fd-4bd0-94e3-dca80316bbab",
  "applicationVersionId": "9ef83a14-d9b3-4ffa-be5c-5d5b46048c2d",
  "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": "68d9c62a-74fb-4fc9-86b2-18a0bd713f7b",
  "messageAuditMessageAuditTypeId": "cc44220d-fdea-4499-b7ae-ddccc4d1decf",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-30T11:24:58.4449579+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-30T11:24:58.4449579+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-30T11:24:58.4449579+00:00",
  "updatedDateUtc": "2026-03-30T11:24:58.4449579+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-03-30T11:24:58.4449579+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-30T11:24:58.4449579+00:00</UpdatedDateUtc>
  <ApplicationId>fd54da78-98fd-4bd0-94e3-dca80316bbab</ApplicationId>
  <ApplicationVersionId>9ef83a14-d9b3-4ffa-be5c-5d5b46048c2d</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>0b011eac-6f78-45bf-8aa4-43b8bf14c06d</DeviceGroupId>
  <DeviceId>f02bc2be-35f4-4ecd-af6d-57278b725baa</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-30T11:24:58.4449579+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>68d9c62a-74fb-4fc9-86b2-18a0bd713f7b</MessageAuditId>
  <MessageAuditMessageAuditTypeId>cc44220d-fdea-4499-b7ae-ddccc4d1decf</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-30T11:24:58.4449579+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>2d345182-bc4d-4541-b8a3-e0f2b3b425b5</MessageId>
  <MessageTypeId>4c96bdf1-1844-4b8c-ad82-fa80e5919b4b</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>2f702f8f-cdfc-4e15-9ed7-599803100888</TenantId>
  <UserGroupId>7f082836-a77c-4037-bb83-1e70991854a9</UserGroupId>
  <UserId>5229ef3a-5000-4fa1-943f-fdf8f52548b1</UserId>
</MessageRepresentation>