Cyan Web API - Version 1

POST api/messageRoute

            Creates a message route with a destination. A new destination will be created if a messageDestinationId is not passed in

Request Information

Parameters

Name	Description	Additional information
messageRouteDestinationRepresentation	- The TenantId field is required, and should match the tenant on the HTTP request header. - MessageRouteRepresentation -- MessageTypeId (Guid?) -- UserId (Guid?) -- UserGroupId (Guid?) -- DeviceId (Guid?) -- DeviceGroupId (Guid?) -- ApplicationId (Guid?) -- ApplicationVersionId (Guid?) -- MessageDestinationId (Guid) -- Name -- Description - MessageDestinationRepresentation -- MessageDestinationId (Guid) pass in if using an existing destination -- MessageDestinationTypeId (Guid) -- Name -- Description -- Address	Define this parameter in the request body.

Name

Description

Additional information

messageRouteDestinationRepresentation

- The TenantId field is required, and should match the tenant on the HTTP request header.
            - MessageRouteRepresentation
            -- MessageTypeId (Guid?)
            -- UserId (Guid?)
            -- UserGroupId (Guid?)
            -- DeviceId (Guid?)
            -- DeviceGroupId (Guid?)
            -- ApplicationId (Guid?)
            -- ApplicationVersionId (Guid?)
            -- MessageDestinationId (Guid)
            -- Name
            -- Description
            - MessageDestinationRepresentation
            -- MessageDestinationId (Guid) pass in if using an existing destination
            -- MessageDestinationTypeId (Guid)
            -- Name
            -- Description
            -- Address

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "tenantId": "2453754a-58cf-4faa-bb15-ad66dc1563ef",
  "messageRouteRepresentation": {
    "messageRouteId": "efe0c321-2df9-488a-ad4a-e73f26c80167",
    "tenantId": "9ff4b1a4-e95e-46d3-86d8-498d6c7d0d2c",
    "messageTypeId": "7ab33d27-71c7-4202-a8c5-20a08dec1c3c",
    "userId": "70ac5ad6-ec6a-42df-b76b-21981b5bb8e7",
    "userGroupId": "c1613a67-3b28-41b8-bf1c-95e1e3ab9ad3",
    "deviceId": "95e75770-19e6-429a-993d-64f0d9486d9e",
    "deviceGroupId": "0fab5128-2921-48fe-9b8b-4b4418891661",
    "applicationId": "ac15d9e3-c704-4c64-8e2e-010793860112",
    "applicationVersionId": "aa8f54c5-3f75-4b67-bb33-c50cd8280a5e",
    "messageDestinationId": "55268eac-655d-4a8a-8e5c-6e20b79ebeb9",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2025-11-15T12:16:59.2445425+00:00",
    "updatedDateUtc": "2025-11-15T12:16:59.2445425+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "03038d19-5e7f-4b12-a07e-e03fab473cdb",
    "messageDestinationTypeId": "7e4de7b0-fdd6-4659-8f0a-c08806aada8b",
    "tenantId": "8ea01cf9-e820-4d24-ac37-cd161c0df5b6",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2025-11-15T12:16:59.2445425+00:00",
    "updatedDateUtc": "2025-11-15T12:16:59.2445425+00:00"
  },
  "createdDateUtc": "2025-11-15T12:16:59.2445425+00:00",
  "updatedDateUtc": "2025-11-15T12:16:59.2445425+00:00"
}

application/xml, text/xml

Sample:

<MessageRouteDestinationRepresentation 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-11-15T12:16:59.2445425+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-15T12:16:59.2445425+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2025-11-15T12:16:59.2445425+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-11-15T12:16:59.2445425+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>03038d19-5e7f-4b12-a07e-e03fab473cdb</MessageDestinationId>
    <MessageDestinationTypeId>7e4de7b0-fdd6-4659-8f0a-c08806aada8b</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>8ea01cf9-e820-4d24-ac37-cd161c0df5b6</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2025-11-15T12:16:59.2445425+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-11-15T12:16:59.2445425+00:00</UpdatedDateUtc>
    <ApplicationId>ac15d9e3-c704-4c64-8e2e-010793860112</ApplicationId>
    <ApplicationVersionId>aa8f54c5-3f75-4b67-bb33-c50cd8280a5e</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>0fab5128-2921-48fe-9b8b-4b4418891661</DeviceGroupId>
    <DeviceId>95e75770-19e6-429a-993d-64f0d9486d9e</DeviceId>
    <MessageDestinationId>55268eac-655d-4a8a-8e5c-6e20b79ebeb9</MessageDestinationId>
    <MessageRouteId>efe0c321-2df9-488a-ad4a-e73f26c80167</MessageRouteId>
    <MessageTypeId>7ab33d27-71c7-4202-a8c5-20a08dec1c3c</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>9ff4b1a4-e95e-46d3-86d8-498d6c7d0d2c</TenantId>
    <UserGroupId>c1613a67-3b28-41b8-bf1c-95e1e3ab9ad3</UserGroupId>
    <UserId>70ac5ad6-ec6a-42df-b76b-21981b5bb8e7</UserId>
  </MessageRouteRepresentation>
  <TenantId>2453754a-58cf-4faa-bb15-ad66dc1563ef</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MessageRouteDestinationRepresentation'.