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": "246d6c3a-46ea-4c3b-9ba1-a2686d49751b",
  "tenantId": "146a8ff4-3f2f-419f-8249-3fe42fbb8ae2",
  "messageTypeId": "8704c904-ed43-43c3-a5eb-b435e0ec8f73",
  "messageTypeLookupKey": "sample string 4",
  "userId": "aaf1a0a2-b48a-40ac-afd8-c728cd163805",
  "userGroupId": "4dbc47d3-85e3-44b3-8afa-5120d04965f4",
  "deviceId": "1cb0b967-026b-4cb1-956d-3dbb8bd00b6c",
  "deviceGroupId": "1c631d2a-4b56-4886-9ca6-ce66342ffd98",
  "applicationId": "d0e84f8c-02af-42b3-822c-960287d5009a",
  "applicationVersionId": "a4476d2c-3238-4d46-bd86-ee4ab89f4560",
  "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": "804e706a-a1d9-4848-a5c7-d7512206688f",
  "messageAuditMessageAuditTypeId": "115b0afc-0de5-440d-a74d-6032a19f10d3",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-09-05T13:26:33.8325017+00:00",
  "messageAuditUpdatedDateUtc": "2025-09-05T13:26:33.8325017+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-09-05T13:26:33.8325017+00:00",
  "updatedDateUtc": "2025-09-05T13:26:33.8325017+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-05T13:26:33.8325017+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-09-05T13:26:33.8325017+00:00</UpdatedDateUtc>
  <ApplicationId>d0e84f8c-02af-42b3-822c-960287d5009a</ApplicationId>
  <ApplicationVersionId>a4476d2c-3238-4d46-bd86-ee4ab89f4560</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>1c631d2a-4b56-4886-9ca6-ce66342ffd98</DeviceGroupId>
  <DeviceId>1cb0b967-026b-4cb1-956d-3dbb8bd00b6c</DeviceId>
  <MessageAuditCreatedDateUtc>2025-09-05T13:26:33.8325017+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>804e706a-a1d9-4848-a5c7-d7512206688f</MessageAuditId>
  <MessageAuditMessageAuditTypeId>115b0afc-0de5-440d-a74d-6032a19f10d3</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-09-05T13:26:33.8325017+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>246d6c3a-46ea-4c3b-9ba1-a2686d49751b</MessageId>
  <MessageTypeId>8704c904-ed43-43c3-a5eb-b435e0ec8f73</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>146a8ff4-3f2f-419f-8249-3fe42fbb8ae2</TenantId>
  <UserGroupId>4dbc47d3-85e3-44b3-8afa-5120d04965f4</UserGroupId>
  <UserId>aaf1a0a2-b48a-40ac-afd8-c728cd163805</UserId>
</MessageRepresentation>