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": "eaa15d7c-3755-4df8-98f6-58e07c526866",
  "tenantId": "a9372c7c-c5a4-4c15-b15b-e9ef0c6248b0",
  "messageTypeId": "d879c06d-9e26-4e97-97b4-5629e7aa6010",
  "messageTypeLookupKey": "sample string 4",
  "userId": "5e7ba136-7d34-4a07-a30f-f6a7ecb610e1",
  "userGroupId": "95d4203e-acd9-4635-a47a-e43250a99de3",
  "deviceId": "c0e02e22-817e-464c-b214-8e5e3f82b676",
  "deviceGroupId": "b772983b-aa2d-49ac-9bfd-386d019ce9e2",
  "applicationId": "af3869f1-e261-4a56-a889-b54f60063cb4",
  "applicationVersionId": "e7a0c44a-ea84-4906-8370-5005d7ad64f8",
  "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": "7b2599c1-553a-49d6-a1fd-e2d7976493c3",
  "messageAuditMessageAuditTypeId": "39e65c16-996d-46f3-9d6b-f943e84b705c",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-02-07T16:09:32.1176721+00:00",
  "messageAuditUpdatedDateUtc": "2026-02-07T16:09:32.1176721+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-02-07T16:09:32.1176721+00:00",
  "updatedDateUtc": "2026-02-07T16:09:32.1176721+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-02-07T16:09:32.1176721+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-07T16:09:32.1176721+00:00</UpdatedDateUtc>
  <ApplicationId>af3869f1-e261-4a56-a889-b54f60063cb4</ApplicationId>
  <ApplicationVersionId>e7a0c44a-ea84-4906-8370-5005d7ad64f8</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>b772983b-aa2d-49ac-9bfd-386d019ce9e2</DeviceGroupId>
  <DeviceId>c0e02e22-817e-464c-b214-8e5e3f82b676</DeviceId>
  <MessageAuditCreatedDateUtc>2026-02-07T16:09:32.1176721+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>7b2599c1-553a-49d6-a1fd-e2d7976493c3</MessageAuditId>
  <MessageAuditMessageAuditTypeId>39e65c16-996d-46f3-9d6b-f943e84b705c</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-02-07T16:09:32.1176721+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>eaa15d7c-3755-4df8-98f6-58e07c526866</MessageId>
  <MessageTypeId>d879c06d-9e26-4e97-97b4-5629e7aa6010</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>a9372c7c-c5a4-4c15-b15b-e9ef0c6248b0</TenantId>
  <UserGroupId>95d4203e-acd9-4635-a47a-e43250a99de3</UserGroupId>
  <UserId>5e7ba136-7d34-4a07-a30f-f6a7ecb610e1</UserId>
</MessageRepresentation>