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": "badc69ab-24b0-41ba-9cef-a0b2a2cfbd06",
  "messageRouteRepresentation": {
    "messageRouteId": "576a990b-7902-4cdf-b45c-1243883cf04d",
    "tenantId": "15203a30-fa1a-424e-bc32-d5109ff04e9c",
    "messageTypeId": "81ed2697-67ac-4d62-a7a7-b6574ca50d4a",
    "userId": "87137678-ea2a-49dc-8811-6434b797799f",
    "userGroupId": "00b211c6-b385-4905-8e8d-5ffab0c75a7c",
    "deviceId": "fcfc9bb6-207d-4f7d-921e-f85b84e3ab01",
    "deviceGroupId": "d94e4540-d8ce-4efd-835c-684e18c83bd1",
    "applicationId": "4bb3f773-2255-4f37-ba4f-30be8026e54a",
    "applicationVersionId": "d4d6dd29-37aa-470a-b498-24c4d8e3f58a",
    "messageDestinationId": "e0b2fa91-75c7-4f8e-964f-98b93bcc2b96",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2025-05-31T21:32:47.5885689+00:00",
    "updatedDateUtc": "2025-05-31T21:32:47.5885689+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "3671bc88-bd1f-41bd-abab-453bd687e8fe",
    "messageDestinationTypeId": "d22dbefb-e5d7-42b4-b536-8821d6e63a16",
    "tenantId": "4372cffb-f0d0-41e9-a6b0-df595052a196",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2025-05-31T21:32:47.5885689+00:00",
    "updatedDateUtc": "2025-05-31T21:32:47.5885689+00:00"
  },
  "createdDateUtc": "2025-05-31T21:32:47.5885689+00:00",
  "updatedDateUtc": "2025-05-31T21:32:47.5885689+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-05-31T21:32:47.5885689+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-05-31T21:32:47.5885689+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2025-05-31T21:32:47.5885689+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-05-31T21:32:47.5885689+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>3671bc88-bd1f-41bd-abab-453bd687e8fe</MessageDestinationId>
    <MessageDestinationTypeId>d22dbefb-e5d7-42b4-b536-8821d6e63a16</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>4372cffb-f0d0-41e9-a6b0-df595052a196</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2025-05-31T21:32:47.5885689+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-05-31T21:32:47.5885689+00:00</UpdatedDateUtc>
    <ApplicationId>4bb3f773-2255-4f37-ba4f-30be8026e54a</ApplicationId>
    <ApplicationVersionId>d4d6dd29-37aa-470a-b498-24c4d8e3f58a</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>d94e4540-d8ce-4efd-835c-684e18c83bd1</DeviceGroupId>
    <DeviceId>fcfc9bb6-207d-4f7d-921e-f85b84e3ab01</DeviceId>
    <MessageDestinationId>e0b2fa91-75c7-4f8e-964f-98b93bcc2b96</MessageDestinationId>
    <MessageRouteId>576a990b-7902-4cdf-b45c-1243883cf04d</MessageRouteId>
    <MessageTypeId>81ed2697-67ac-4d62-a7a7-b6574ca50d4a</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>15203a30-fa1a-424e-bc32-d5109ff04e9c</TenantId>
    <UserGroupId>00b211c6-b385-4905-8e8d-5ffab0c75a7c</UserGroupId>
    <UserId>87137678-ea2a-49dc-8811-6434b797799f</UserId>
  </MessageRouteRepresentation>
  <TenantId>badc69ab-24b0-41ba-9cef-a0b2a2cfbd06</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.