Cyan Web API - Version 1


GET api/nodeRoutes?{nodeId}

            Gets all of the NodeRoutes for a Node
            

Request Information

Parameters

NameDescriptionAdditional information
nodeId

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "nodeRouteId": "35b06c3b-2f64-415e-b10b-d1cf77f3c519",
    "tenantId": "644afab4-ea7a-4b3e-ab44-9715bc48a93c",
    "userId": "02dc8440-a0e9-4c28-a430-4ffa09110195",
    "userGroupId": "793cfc03-d665-437a-8d0b-b4b38a06e5de",
    "deviceId": "d206637d-fd3c-452a-a96c-12d175bb89b9",
    "deviceGroupId": "56fe624c-7979-48c1-911d-0a6d5f72df74",
    "applicationId": "4ce929ba-5614-49b7-8df5-6fcee6681126",
    "applicationVersionId": "e2cb8515-6348-4b1a-abd8-4847560c4210",
    "nodeId": "ee5586b8-bab6-4eb5-90f1-a8f9d9899e40",
    "name": "sample string 4",
    "description": "sample string 5",
    "nodeCyanId": 6,
    "cyanId": 7,
    "customKey": "sample string 8",
    "customValue": "sample string 9",
    "applyParentRoutes": true,
    "applyToDescendants": true,
    "applyToTree": true,
    "applyToParents": true,
    "applyToSiblings": true,
    "applyToSiblingsType": "sample string 15",
    "ignoreNodeIdsInRouting": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    "createdDateUtc": "2026-01-10T20:01:12.4248358+00:00",
    "updatedDateUtc": "2026-01-10T20:01:12.4248358+00:00"
  },
  {
    "nodeRouteId": "35b06c3b-2f64-415e-b10b-d1cf77f3c519",
    "tenantId": "644afab4-ea7a-4b3e-ab44-9715bc48a93c",
    "userId": "02dc8440-a0e9-4c28-a430-4ffa09110195",
    "userGroupId": "793cfc03-d665-437a-8d0b-b4b38a06e5de",
    "deviceId": "d206637d-fd3c-452a-a96c-12d175bb89b9",
    "deviceGroupId": "56fe624c-7979-48c1-911d-0a6d5f72df74",
    "applicationId": "4ce929ba-5614-49b7-8df5-6fcee6681126",
    "applicationVersionId": "e2cb8515-6348-4b1a-abd8-4847560c4210",
    "nodeId": "ee5586b8-bab6-4eb5-90f1-a8f9d9899e40",
    "name": "sample string 4",
    "description": "sample string 5",
    "nodeCyanId": 6,
    "cyanId": 7,
    "customKey": "sample string 8",
    "customValue": "sample string 9",
    "applyParentRoutes": true,
    "applyToDescendants": true,
    "applyToTree": true,
    "applyToParents": true,
    "applyToSiblings": true,
    "applyToSiblingsType": "sample string 15",
    "ignoreNodeIdsInRouting": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    "createdDateUtc": "2026-01-10T20:01:12.4248358+00:00",
    "updatedDateUtc": "2026-01-10T20:01:12.4248358+00:00"
  },
  {
    "nodeRouteId": "35b06c3b-2f64-415e-b10b-d1cf77f3c519",
    "tenantId": "644afab4-ea7a-4b3e-ab44-9715bc48a93c",
    "userId": "02dc8440-a0e9-4c28-a430-4ffa09110195",
    "userGroupId": "793cfc03-d665-437a-8d0b-b4b38a06e5de",
    "deviceId": "d206637d-fd3c-452a-a96c-12d175bb89b9",
    "deviceGroupId": "56fe624c-7979-48c1-911d-0a6d5f72df74",
    "applicationId": "4ce929ba-5614-49b7-8df5-6fcee6681126",
    "applicationVersionId": "e2cb8515-6348-4b1a-abd8-4847560c4210",
    "nodeId": "ee5586b8-bab6-4eb5-90f1-a8f9d9899e40",
    "name": "sample string 4",
    "description": "sample string 5",
    "nodeCyanId": 6,
    "cyanId": 7,
    "customKey": "sample string 8",
    "customValue": "sample string 9",
    "applyParentRoutes": true,
    "applyToDescendants": true,
    "applyToTree": true,
    "applyToParents": true,
    "applyToSiblings": true,
    "applyToSiblingsType": "sample string 15",
    "ignoreNodeIdsInRouting": [
      "sample string 1",
      "sample string 2",
      "sample string 3"
    ],
    "createdDateUtc": "2026-01-10T20:01:12.4248358+00:00",
    "updatedDateUtc": "2026-01-10T20:01:12.4248358+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfNodeRouteRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <NodeRouteRepresentation>
    <CreatedDateUtc>2026-01-10T20:01:12.4248358+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-01-10T20:01:12.4248358+00:00</UpdatedDateUtc>
    <ApplicationId>4ce929ba-5614-49b7-8df5-6fcee6681126</ApplicationId>
    <ApplicationVersionId>e2cb8515-6348-4b1a-abd8-4847560c4210</ApplicationVersionId>
    <ApplyParentRoutes>true</ApplyParentRoutes>
    <ApplyToDescendants>true</ApplyToDescendants>
    <ApplyToParents>true</ApplyToParents>
    <ApplyToSiblings>true</ApplyToSiblings>
    <ApplyToSiblingsType>sample string 15</ApplyToSiblingsType>
    <ApplyToTree>true</ApplyToTree>
    <CustomKey>sample string 8</CustomKey>
    <CustomValue>sample string 9</CustomValue>
    <CyanId>7</CyanId>
    <Description>sample string 5</Description>
    <DeviceGroupId>56fe624c-7979-48c1-911d-0a6d5f72df74</DeviceGroupId>
    <DeviceId>d206637d-fd3c-452a-a96c-12d175bb89b9</DeviceId>
    <IgnoreNodeIdsInRouting xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </IgnoreNodeIdsInRouting>
    <Name>sample string 4</Name>
    <NodeCyanId>6</NodeCyanId>
    <NodeId>ee5586b8-bab6-4eb5-90f1-a8f9d9899e40</NodeId>
    <NodeRouteId>35b06c3b-2f64-415e-b10b-d1cf77f3c519</NodeRouteId>
    <TenantId>644afab4-ea7a-4b3e-ab44-9715bc48a93c</TenantId>
    <UserGroupId>793cfc03-d665-437a-8d0b-b4b38a06e5de</UserGroupId>
    <UserId>02dc8440-a0e9-4c28-a430-4ffa09110195</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2026-01-10T20:01:12.4248358+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-01-10T20:01:12.4248358+00:00</UpdatedDateUtc>
    <ApplicationId>4ce929ba-5614-49b7-8df5-6fcee6681126</ApplicationId>
    <ApplicationVersionId>e2cb8515-6348-4b1a-abd8-4847560c4210</ApplicationVersionId>
    <ApplyParentRoutes>true</ApplyParentRoutes>
    <ApplyToDescendants>true</ApplyToDescendants>
    <ApplyToParents>true</ApplyToParents>
    <ApplyToSiblings>true</ApplyToSiblings>
    <ApplyToSiblingsType>sample string 15</ApplyToSiblingsType>
    <ApplyToTree>true</ApplyToTree>
    <CustomKey>sample string 8</CustomKey>
    <CustomValue>sample string 9</CustomValue>
    <CyanId>7</CyanId>
    <Description>sample string 5</Description>
    <DeviceGroupId>56fe624c-7979-48c1-911d-0a6d5f72df74</DeviceGroupId>
    <DeviceId>d206637d-fd3c-452a-a96c-12d175bb89b9</DeviceId>
    <IgnoreNodeIdsInRouting xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </IgnoreNodeIdsInRouting>
    <Name>sample string 4</Name>
    <NodeCyanId>6</NodeCyanId>
    <NodeId>ee5586b8-bab6-4eb5-90f1-a8f9d9899e40</NodeId>
    <NodeRouteId>35b06c3b-2f64-415e-b10b-d1cf77f3c519</NodeRouteId>
    <TenantId>644afab4-ea7a-4b3e-ab44-9715bc48a93c</TenantId>
    <UserGroupId>793cfc03-d665-437a-8d0b-b4b38a06e5de</UserGroupId>
    <UserId>02dc8440-a0e9-4c28-a430-4ffa09110195</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2026-01-10T20:01:12.4248358+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-01-10T20:01:12.4248358+00:00</UpdatedDateUtc>
    <ApplicationId>4ce929ba-5614-49b7-8df5-6fcee6681126</ApplicationId>
    <ApplicationVersionId>e2cb8515-6348-4b1a-abd8-4847560c4210</ApplicationVersionId>
    <ApplyParentRoutes>true</ApplyParentRoutes>
    <ApplyToDescendants>true</ApplyToDescendants>
    <ApplyToParents>true</ApplyToParents>
    <ApplyToSiblings>true</ApplyToSiblings>
    <ApplyToSiblingsType>sample string 15</ApplyToSiblingsType>
    <ApplyToTree>true</ApplyToTree>
    <CustomKey>sample string 8</CustomKey>
    <CustomValue>sample string 9</CustomValue>
    <CyanId>7</CyanId>
    <Description>sample string 5</Description>
    <DeviceGroupId>56fe624c-7979-48c1-911d-0a6d5f72df74</DeviceGroupId>
    <DeviceId>d206637d-fd3c-452a-a96c-12d175bb89b9</DeviceId>
    <IgnoreNodeIdsInRouting xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </IgnoreNodeIdsInRouting>
    <Name>sample string 4</Name>
    <NodeCyanId>6</NodeCyanId>
    <NodeId>ee5586b8-bab6-4eb5-90f1-a8f9d9899e40</NodeId>
    <NodeRouteId>35b06c3b-2f64-415e-b10b-d1cf77f3c519</NodeRouteId>
    <TenantId>644afab4-ea7a-4b3e-ab44-9715bc48a93c</TenantId>
    <UserGroupId>793cfc03-d665-437a-8d0b-b4b38a06e5de</UserGroupId>
    <UserId>02dc8440-a0e9-4c28-a430-4ffa09110195</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>