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": "5fafff3e-c001-449b-abb1-5ab5fbe40d77",
  "messageRouteRepresentation": {
    "messageRouteId": "5e07f4a4-25dc-475f-b4e2-777c770bd4e1",
    "tenantId": "ab9f3249-3458-4ea7-a41f-68738688e808",
    "messageTypeId": "74cba432-fc0a-4a47-9053-d6b9ebe7ef7e",
    "userId": "aa30874e-e298-4117-b1fb-9489ea97ec0e",
    "userGroupId": "72f9b9bd-4636-4b0b-b642-884e5055cbcb",
    "deviceId": "cc55ba94-98c9-443b-bf5d-74876d904c2d",
    "deviceGroupId": "16d8be3a-7a00-4c34-a6c0-267d2bb59580",
    "applicationId": "ab55a402-4a11-4444-8014-4ec4c0e25d51",
    "applicationVersionId": "16403190-75a3-43b7-aae1-eaf7fe15f357",
    "messageDestinationId": "1ec89a5a-ff94-4cd0-b566-1d58e44f2786",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2025-04-21T01:40:18.2754551+00:00",
    "updatedDateUtc": "2025-04-21T01:40:18.2754551+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "171ee7c0-5834-4d8e-9a5c-78db5f52fdb0",
    "messageDestinationTypeId": "4eab3c8a-5b2e-4400-939d-a296f2e5ae2e",
    "tenantId": "1edad669-479f-404b-8105-1d20cb7b6146",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2025-04-21T01:40:18.2754551+00:00",
    "updatedDateUtc": "2025-04-21T01:40:18.2754551+00:00"
  },
  "createdDateUtc": "2025-04-21T01:40:18.2754551+00:00",
  "updatedDateUtc": "2025-04-21T01:40:18.2754551+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-04-21T01:40:18.2754551+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-04-21T01:40:18.2754551+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2025-04-21T01:40:18.2754551+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-04-21T01:40:18.2754551+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>171ee7c0-5834-4d8e-9a5c-78db5f52fdb0</MessageDestinationId>
    <MessageDestinationTypeId>4eab3c8a-5b2e-4400-939d-a296f2e5ae2e</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>1edad669-479f-404b-8105-1d20cb7b6146</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2025-04-21T01:40:18.2754551+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-04-21T01:40:18.2754551+00:00</UpdatedDateUtc>
    <ApplicationId>ab55a402-4a11-4444-8014-4ec4c0e25d51</ApplicationId>
    <ApplicationVersionId>16403190-75a3-43b7-aae1-eaf7fe15f357</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>16d8be3a-7a00-4c34-a6c0-267d2bb59580</DeviceGroupId>
    <DeviceId>cc55ba94-98c9-443b-bf5d-74876d904c2d</DeviceId>
    <MessageDestinationId>1ec89a5a-ff94-4cd0-b566-1d58e44f2786</MessageDestinationId>
    <MessageRouteId>5e07f4a4-25dc-475f-b4e2-777c770bd4e1</MessageRouteId>
    <MessageTypeId>74cba432-fc0a-4a47-9053-d6b9ebe7ef7e</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>ab9f3249-3458-4ea7-a41f-68738688e808</TenantId>
    <UserGroupId>72f9b9bd-4636-4b0b-b642-884e5055cbcb</UserGroupId>
    <UserId>aa30874e-e298-4117-b1fb-9489ea97ec0e</UserId>
  </MessageRouteRepresentation>
  <TenantId>5fafff3e-c001-449b-abb1-5ab5fbe40d77</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.