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": "f443b377-f5c9-4bd3-af28-a5540daec69d",
    "tenantId": "b208084d-dec4-4314-a242-d9a081fb44f9",
    "userId": "e5a86514-c30d-4c0f-b9d5-a501025b6563",
    "userGroupId": "6f1cd9c4-bf2d-4aa2-b135-71eaed86af97",
    "deviceId": "82955589-bd08-4277-a173-dace83f87c89",
    "deviceGroupId": "f8f1e3d8-1436-412a-8cf8-9f6bad21eb64",
    "applicationId": "903fb994-c468-4f0c-aef0-ae2a29d2158f",
    "applicationVersionId": "18885da4-a16f-47b6-80f2-322c7bab789e",
    "nodeId": "0829fc4b-1b77-4a90-8b44-f406bda62bb8",
    "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": "2025-12-14T16:02:18.0385355+00:00",
    "updatedDateUtc": "2025-12-14T16:02:18.0385355+00:00"
  },
  {
    "nodeRouteId": "f443b377-f5c9-4bd3-af28-a5540daec69d",
    "tenantId": "b208084d-dec4-4314-a242-d9a081fb44f9",
    "userId": "e5a86514-c30d-4c0f-b9d5-a501025b6563",
    "userGroupId": "6f1cd9c4-bf2d-4aa2-b135-71eaed86af97",
    "deviceId": "82955589-bd08-4277-a173-dace83f87c89",
    "deviceGroupId": "f8f1e3d8-1436-412a-8cf8-9f6bad21eb64",
    "applicationId": "903fb994-c468-4f0c-aef0-ae2a29d2158f",
    "applicationVersionId": "18885da4-a16f-47b6-80f2-322c7bab789e",
    "nodeId": "0829fc4b-1b77-4a90-8b44-f406bda62bb8",
    "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": "2025-12-14T16:02:18.0385355+00:00",
    "updatedDateUtc": "2025-12-14T16:02:18.0385355+00:00"
  },
  {
    "nodeRouteId": "f443b377-f5c9-4bd3-af28-a5540daec69d",
    "tenantId": "b208084d-dec4-4314-a242-d9a081fb44f9",
    "userId": "e5a86514-c30d-4c0f-b9d5-a501025b6563",
    "userGroupId": "6f1cd9c4-bf2d-4aa2-b135-71eaed86af97",
    "deviceId": "82955589-bd08-4277-a173-dace83f87c89",
    "deviceGroupId": "f8f1e3d8-1436-412a-8cf8-9f6bad21eb64",
    "applicationId": "903fb994-c468-4f0c-aef0-ae2a29d2158f",
    "applicationVersionId": "18885da4-a16f-47b6-80f2-322c7bab789e",
    "nodeId": "0829fc4b-1b77-4a90-8b44-f406bda62bb8",
    "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": "2025-12-14T16:02:18.0385355+00:00",
    "updatedDateUtc": "2025-12-14T16:02:18.0385355+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>2025-12-14T16:02:18.0385355+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-14T16:02:18.0385355+00:00</UpdatedDateUtc>
    <ApplicationId>903fb994-c468-4f0c-aef0-ae2a29d2158f</ApplicationId>
    <ApplicationVersionId>18885da4-a16f-47b6-80f2-322c7bab789e</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>f8f1e3d8-1436-412a-8cf8-9f6bad21eb64</DeviceGroupId>
    <DeviceId>82955589-bd08-4277-a173-dace83f87c89</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>0829fc4b-1b77-4a90-8b44-f406bda62bb8</NodeId>
    <NodeRouteId>f443b377-f5c9-4bd3-af28-a5540daec69d</NodeRouteId>
    <TenantId>b208084d-dec4-4314-a242-d9a081fb44f9</TenantId>
    <UserGroupId>6f1cd9c4-bf2d-4aa2-b135-71eaed86af97</UserGroupId>
    <UserId>e5a86514-c30d-4c0f-b9d5-a501025b6563</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-14T16:02:18.0385355+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-14T16:02:18.0385355+00:00</UpdatedDateUtc>
    <ApplicationId>903fb994-c468-4f0c-aef0-ae2a29d2158f</ApplicationId>
    <ApplicationVersionId>18885da4-a16f-47b6-80f2-322c7bab789e</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>f8f1e3d8-1436-412a-8cf8-9f6bad21eb64</DeviceGroupId>
    <DeviceId>82955589-bd08-4277-a173-dace83f87c89</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>0829fc4b-1b77-4a90-8b44-f406bda62bb8</NodeId>
    <NodeRouteId>f443b377-f5c9-4bd3-af28-a5540daec69d</NodeRouteId>
    <TenantId>b208084d-dec4-4314-a242-d9a081fb44f9</TenantId>
    <UserGroupId>6f1cd9c4-bf2d-4aa2-b135-71eaed86af97</UserGroupId>
    <UserId>e5a86514-c30d-4c0f-b9d5-a501025b6563</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-14T16:02:18.0385355+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-14T16:02:18.0385355+00:00</UpdatedDateUtc>
    <ApplicationId>903fb994-c468-4f0c-aef0-ae2a29d2158f</ApplicationId>
    <ApplicationVersionId>18885da4-a16f-47b6-80f2-322c7bab789e</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>f8f1e3d8-1436-412a-8cf8-9f6bad21eb64</DeviceGroupId>
    <DeviceId>82955589-bd08-4277-a173-dace83f87c89</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>0829fc4b-1b77-4a90-8b44-f406bda62bb8</NodeId>
    <NodeRouteId>f443b377-f5c9-4bd3-af28-a5540daec69d</NodeRouteId>
    <TenantId>b208084d-dec4-4314-a242-d9a081fb44f9</TenantId>
    <UserGroupId>6f1cd9c4-bf2d-4aa2-b135-71eaed86af97</UserGroupId>
    <UserId>e5a86514-c30d-4c0f-b9d5-a501025b6563</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>