Cyan Web API - Version 1

GET api/messageBodies/routeData

            Gets and example of the message body format for a Route Data message.
            NodeRoutingRequest Properties
            type: Activate/Deactivate
            targetNode: The node to apply the routes to (only key fields are required: nodeId or type/id)
            Routes: array of key/value pairs.
                Well known route keys:
                usr = UserId (Guid identifier for a Cyan User)
                usrg = UserGroupId (Guid identifier for a Cyan Application)
                app = ApplicationId (Guid identifier for a Cyan Application)
                appv = ApplicationVersionId (Guid identifier for a Cyan ApplicationVersion)
                dev = DeviceId (Guid identifier for a Cyan Device)
                devg = DeviceGroupId (Guid identifier for a Cyan DeviceGroup)
                Custom route keys:
                Any custom key/value known by an application can be used.
            applyParentRoutes:  (Activate) If true and routes is empty, system will find the parent of the targetNode 
                                and apply any active routes on the parent to the targetNode.
            applyToDescendants:  (Activate/Deactivate) If true, any routes specified will be applied to all descendants of the targetNode.
            applyToTree:  (Activate) If true, any routes specified will be applied to the targetNode as well as all nodes 
                          in the target nodes tree.  (Find root and apply to descendants)

Response Information

Response body formats

application/json, text/json

Sample:

{
  "routingRequests": [
    {
      "startAnchor": "sample string 1",
      "endAnchor": "sample string 2",
      "routes": [
        {
          "key": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "type": 0,
      "limit": 3,
      "skip": 4,
      "applyParentRoutes": true,
      "applyToDescendants": true,
      "applyToTree": true,
      "applyToParents": true,
      "applyToSiblings": true,
      "applyToSiblingsType": "sample string 10",
      "ignoreNodeIdsInRouting": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "targetNode": {
        "tenantId": "73ddfaca-24c3-4a72-83f7-b813d8b753d2",
        "nodeId": "77a5d7f7-40ec-41e4-b81f-9dbe006a604a",
        "type": "sample string 3",
        "id": "sample string 4",
        "parentType": "sample string 5",
        "parentId": "sample string 6",
        "title": "sample string 7",
        "props": {
          "sample string 1": {},
          "sample string 3": {},
          "sample string 5": {}
        },
        "refs": {
          "sample string 1": {
            "type": "sample string 1",
            "id": "sample string 2"
          },
          "sample string 2": {
            "type": "sample string 1",
            "id": "sample string 2"
          },
          "sample string 3": {
            "type": "sample string 1",
            "id": "sample string 2"
          }
        },
        "cyanId": 8,
        "subjectToCleanup": true,
        "createdDateUtc": "2025-04-21T02:09:28.7736139+00:00",
        "updatedDateUtc": "2025-04-21T02:09:28.7736139+00:00"
      },
      "reassignExistingRoutes": true
    },
    {
      "startAnchor": "sample string 1",
      "endAnchor": "sample string 2",
      "routes": [
        {
          "key": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "type": 0,
      "limit": 3,
      "skip": 4,
      "applyParentRoutes": true,
      "applyToDescendants": true,
      "applyToTree": true,
      "applyToParents": true,
      "applyToSiblings": true,
      "applyToSiblingsType": "sample string 10",
      "ignoreNodeIdsInRouting": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "targetNode": {
        "tenantId": "73ddfaca-24c3-4a72-83f7-b813d8b753d2",
        "nodeId": "77a5d7f7-40ec-41e4-b81f-9dbe006a604a",
        "type": "sample string 3",
        "id": "sample string 4",
        "parentType": "sample string 5",
        "parentId": "sample string 6",
        "title": "sample string 7",
        "props": {
          "sample string 1": {},
          "sample string 3": {},
          "sample string 5": {}
        },
        "refs": {
          "sample string 1": {
            "type": "sample string 1",
            "id": "sample string 2"
          },
          "sample string 2": {
            "type": "sample string 1",
            "id": "sample string 2"
          },
          "sample string 3": {
            "type": "sample string 1",
            "id": "sample string 2"
          }
        },
        "cyanId": 8,
        "subjectToCleanup": true,
        "createdDateUtc": "2025-04-21T02:09:28.7736139+00:00",
        "updatedDateUtc": "2025-04-21T02:09:28.7736139+00:00"
      },
      "reassignExistingRoutes": true
    },
    {
      "startAnchor": "sample string 1",
      "endAnchor": "sample string 2",
      "routes": [
        {
          "key": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "type": 0,
      "limit": 3,
      "skip": 4,
      "applyParentRoutes": true,
      "applyToDescendants": true,
      "applyToTree": true,
      "applyToParents": true,
      "applyToSiblings": true,
      "applyToSiblingsType": "sample string 10",
      "ignoreNodeIdsInRouting": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "targetNode": {
        "tenantId": "73ddfaca-24c3-4a72-83f7-b813d8b753d2",
        "nodeId": "77a5d7f7-40ec-41e4-b81f-9dbe006a604a",
        "type": "sample string 3",
        "id": "sample string 4",
        "parentType": "sample string 5",
        "parentId": "sample string 6",
        "title": "sample string 7",
        "props": {
          "sample string 1": {},
          "sample string 3": {},
          "sample string 5": {}
        },
        "refs": {
          "sample string 1": {
            "type": "sample string 1",
            "id": "sample string 2"
          },
          "sample string 2": {
            "type": "sample string 1",
            "id": "sample string 2"
          },
          "sample string 3": {
            "type": "sample string 1",
            "id": "sample string 2"
          }
        },
        "cyanId": 8,
        "subjectToCleanup": true,
        "createdDateUtc": "2025-04-21T02:09:28.7736139+00:00",
        "updatedDateUtc": "2025-04-21T02:09:28.7736139+00:00"
      },
      "reassignExistingRoutes": true
    }
  ]
}

application/xml, text/xml

Sample:

<RouteDataMessageBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Messaging">
  <RoutingRequests xmlns:d2p1="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.DataContracts">
    <d2p1:NodeRoutingRequest>
      <d2p1:ApplyParentRoutes>true</d2p1:ApplyParentRoutes>
      <d2p1:ApplyToDescendants>true</d2p1:ApplyToDescendants>
      <d2p1:ApplyToParents>true</d2p1:ApplyToParents>
      <d2p1:ApplyToSiblings>true</d2p1:ApplyToSiblings>
      <d2p1:ApplyToSiblingsType>sample string 10</d2p1:ApplyToSiblingsType>
      <d2p1:ApplyToTree>true</d2p1:ApplyToTree>
      <d2p1:EndAnchor>sample string 2</d2p1:EndAnchor>
      <d2p1:IgnoreNodeIdsInRouting xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </d2p1:IgnoreNodeIdsInRouting>
      <d2p1:Limit>3</d2p1:Limit>
      <d2p1:ReassignExistingRoutes>true</d2p1:ReassignExistingRoutes>
      <d2p1:Routes xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:KeyValuePairOfstringstring>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value>sample string 2</d4p1:value>
        </d4p1:KeyValuePairOfstringstring>
      </d2p1:Routes>
      <d2p1:Skip>4</d2p1:Skip>
      <d2p1:StartAnchor>sample string 1</d2p1:StartAnchor>
      <d2p1:TargetNode xmlns:d4p1="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
        <d4p1:CreatedDateUtc>2025-04-21T02:09:28.7736139+00:00</d4p1:CreatedDateUtc>
        <d4p1:UpdatedDateUtc>2025-04-21T02:09:28.7736139+00:00</d4p1:UpdatedDateUtc>
        <d4p1:CyanId>8</d4p1:CyanId>
        <d4p1:Id>sample string 4</d4p1:Id>
        <d4p1:NodeId>77a5d7f7-40ec-41e4-b81f-9dbe006a604a</d4p1:NodeId>
        <d4p1:ParentId>sample string 6</d4p1:ParentId>
        <d4p1:ParentType>sample string 5</d4p1:ParentType>
        <d4p1:Props xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 5</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </d4p1:Props>
        <d4p1:Refs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>
              <d4p1:Id>sample string 2</d4p1:Id>
              <d4p1:Type>sample string 1</d4p1:Type>
            </d5p1:Value>
          </d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
            <d5p1:Key>sample string 2</d5p1:Key>
            <d5p1:Value>
              <d4p1:Id>sample string 2</d4p1:Id>
              <d4p1:Type>sample string 1</d4p1:Type>
            </d5p1:Value>
          </d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>
              <d4p1:Id>sample string 2</d4p1:Id>
              <d4p1:Type>sample string 1</d4p1:Type>
            </d5p1:Value>
          </d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        </d4p1:Refs>
        <d4p1:SubjectToCleanup>true</d4p1:SubjectToCleanup>
        <d4p1:TenantId>73ddfaca-24c3-4a72-83f7-b813d8b753d2</d4p1:TenantId>
        <d4p1:Title>sample string 7</d4p1:Title>
        <d4p1:Type>sample string 3</d4p1:Type>
      </d2p1:TargetNode>
      <d2p1:Type>Activate</d2p1:Type>
    </d2p1:NodeRoutingRequest>
    <d2p1:NodeRoutingRequest>
      <d2p1:ApplyParentRoutes>true</d2p1:ApplyParentRoutes>
      <d2p1:ApplyToDescendants>true</d2p1:ApplyToDescendants>
      <d2p1:ApplyToParents>true</d2p1:ApplyToParents>
      <d2p1:ApplyToSiblings>true</d2p1:ApplyToSiblings>
      <d2p1:ApplyToSiblingsType>sample string 10</d2p1:ApplyToSiblingsType>
      <d2p1:ApplyToTree>true</d2p1:ApplyToTree>
      <d2p1:EndAnchor>sample string 2</d2p1:EndAnchor>
      <d2p1:IgnoreNodeIdsInRouting xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </d2p1:IgnoreNodeIdsInRouting>
      <d2p1:Limit>3</d2p1:Limit>
      <d2p1:ReassignExistingRoutes>true</d2p1:ReassignExistingRoutes>
      <d2p1:Routes xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:KeyValuePairOfstringstring>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value>sample string 2</d4p1:value>
        </d4p1:KeyValuePairOfstringstring>
      </d2p1:Routes>
      <d2p1:Skip>4</d2p1:Skip>
      <d2p1:StartAnchor>sample string 1</d2p1:StartAnchor>
      <d2p1:TargetNode xmlns:d4p1="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
        <d4p1:CreatedDateUtc>2025-04-21T02:09:28.7736139+00:00</d4p1:CreatedDateUtc>
        <d4p1:UpdatedDateUtc>2025-04-21T02:09:28.7736139+00:00</d4p1:UpdatedDateUtc>
        <d4p1:CyanId>8</d4p1:CyanId>
        <d4p1:Id>sample string 4</d4p1:Id>
        <d4p1:NodeId>77a5d7f7-40ec-41e4-b81f-9dbe006a604a</d4p1:NodeId>
        <d4p1:ParentId>sample string 6</d4p1:ParentId>
        <d4p1:ParentType>sample string 5</d4p1:ParentType>
        <d4p1:Props xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 5</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </d4p1:Props>
        <d4p1:Refs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>
              <d4p1:Id>sample string 2</d4p1:Id>
              <d4p1:Type>sample string 1</d4p1:Type>
            </d5p1:Value>
          </d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
            <d5p1:Key>sample string 2</d5p1:Key>
            <d5p1:Value>
              <d4p1:Id>sample string 2</d4p1:Id>
              <d4p1:Type>sample string 1</d4p1:Type>
            </d5p1:Value>
          </d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>
              <d4p1:Id>sample string 2</d4p1:Id>
              <d4p1:Type>sample string 1</d4p1:Type>
            </d5p1:Value>
          </d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        </d4p1:Refs>
        <d4p1:SubjectToCleanup>true</d4p1:SubjectToCleanup>
        <d4p1:TenantId>73ddfaca-24c3-4a72-83f7-b813d8b753d2</d4p1:TenantId>
        <d4p1:Title>sample string 7</d4p1:Title>
        <d4p1:Type>sample string 3</d4p1:Type>
      </d2p1:TargetNode>
      <d2p1:Type>Activate</d2p1:Type>
    </d2p1:NodeRoutingRequest>
    <d2p1:NodeRoutingRequest>
      <d2p1:ApplyParentRoutes>true</d2p1:ApplyParentRoutes>
      <d2p1:ApplyToDescendants>true</d2p1:ApplyToDescendants>
      <d2p1:ApplyToParents>true</d2p1:ApplyToParents>
      <d2p1:ApplyToSiblings>true</d2p1:ApplyToSiblings>
      <d2p1:ApplyToSiblingsType>sample string 10</d2p1:ApplyToSiblingsType>
      <d2p1:ApplyToTree>true</d2p1:ApplyToTree>
      <d2p1:EndAnchor>sample string 2</d2p1:EndAnchor>
      <d2p1:IgnoreNodeIdsInRouting xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
        <d4p1:string>sample string 3</d4p1:string>
      </d2p1:IgnoreNodeIdsInRouting>
      <d2p1:Limit>3</d2p1:Limit>
      <d2p1:ReassignExistingRoutes>true</d2p1:ReassignExistingRoutes>
      <d2p1:Routes xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:KeyValuePairOfstringstring>
          <d4p1:key>sample string 1</d4p1:key>
          <d4p1:value>sample string 2</d4p1:value>
        </d4p1:KeyValuePairOfstringstring>
      </d2p1:Routes>
      <d2p1:Skip>4</d2p1:Skip>
      <d2p1:StartAnchor>sample string 1</d2p1:StartAnchor>
      <d2p1:TargetNode xmlns:d4p1="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
        <d4p1:CreatedDateUtc>2025-04-21T02:09:28.7736139+00:00</d4p1:CreatedDateUtc>
        <d4p1:UpdatedDateUtc>2025-04-21T02:09:28.7736139+00:00</d4p1:UpdatedDateUtc>
        <d4p1:CyanId>8</d4p1:CyanId>
        <d4p1:Id>sample string 4</d4p1:Id>
        <d4p1:NodeId>77a5d7f7-40ec-41e4-b81f-9dbe006a604a</d4p1:NodeId>
        <d4p1:ParentId>sample string 6</d4p1:ParentId>
        <d4p1:ParentType>sample string 5</d4p1:ParentType>
        <d4p1:Props xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 5</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </d4p1:Props>
        <d4p1:Refs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>
              <d4p1:Id>sample string 2</d4p1:Id>
              <d4p1:Type>sample string 1</d4p1:Type>
            </d5p1:Value>
          </d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
            <d5p1:Key>sample string 2</d5p1:Key>
            <d5p1:Value>
              <d4p1:Id>sample string 2</d4p1:Id>
              <d4p1:Type>sample string 1</d4p1:Type>
            </d5p1:Value>
          </d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
          <d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>
              <d4p1:Id>sample string 2</d4p1:Id>
              <d4p1:Type>sample string 1</d4p1:Type>
            </d5p1:Value>
          </d5p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        </d4p1:Refs>
        <d4p1:SubjectToCleanup>true</d4p1:SubjectToCleanup>
        <d4p1:TenantId>73ddfaca-24c3-4a72-83f7-b813d8b753d2</d4p1:TenantId>
        <d4p1:Title>sample string 7</d4p1:Title>
        <d4p1:Type>sample string 3</d4p1:Type>
      </d2p1:TargetNode>
      <d2p1:Type>Activate</d2p1:Type>
    </d2p1:NodeRoutingRequest>
  </RoutingRequests>
</RouteDataMessageBody>