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": "67db25c1-fe4b-4033-9956-dfb2d5efa589",
    "tenantId": "25ab94d8-56ef-413f-84b1-aee6cb0d6b9a",
    "userId": "7cb0f2fb-83af-475e-b949-bf3bbef8bd56",
    "userGroupId": "0fb08a96-3f4c-491b-8be1-54b116bf80ec",
    "deviceId": "944f44a6-9bf2-4ef9-919b-b7724b9d43e8",
    "deviceGroupId": "d6570881-af21-458b-987f-a62dd3633248",
    "applicationId": "d5e006da-d429-4472-8048-e7d81b892263",
    "applicationVersionId": "1564bdc1-d3df-438e-8c79-68f094aa7e61",
    "nodeId": "01a756a9-42c8-4abb-83f2-425b278959d2",
    "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-05T03:37:18.2298888+00:00",
    "updatedDateUtc": "2025-12-05T03:37:18.2298888+00:00"
  },
  {
    "nodeRouteId": "67db25c1-fe4b-4033-9956-dfb2d5efa589",
    "tenantId": "25ab94d8-56ef-413f-84b1-aee6cb0d6b9a",
    "userId": "7cb0f2fb-83af-475e-b949-bf3bbef8bd56",
    "userGroupId": "0fb08a96-3f4c-491b-8be1-54b116bf80ec",
    "deviceId": "944f44a6-9bf2-4ef9-919b-b7724b9d43e8",
    "deviceGroupId": "d6570881-af21-458b-987f-a62dd3633248",
    "applicationId": "d5e006da-d429-4472-8048-e7d81b892263",
    "applicationVersionId": "1564bdc1-d3df-438e-8c79-68f094aa7e61",
    "nodeId": "01a756a9-42c8-4abb-83f2-425b278959d2",
    "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-05T03:37:18.2298888+00:00",
    "updatedDateUtc": "2025-12-05T03:37:18.2298888+00:00"
  },
  {
    "nodeRouteId": "67db25c1-fe4b-4033-9956-dfb2d5efa589",
    "tenantId": "25ab94d8-56ef-413f-84b1-aee6cb0d6b9a",
    "userId": "7cb0f2fb-83af-475e-b949-bf3bbef8bd56",
    "userGroupId": "0fb08a96-3f4c-491b-8be1-54b116bf80ec",
    "deviceId": "944f44a6-9bf2-4ef9-919b-b7724b9d43e8",
    "deviceGroupId": "d6570881-af21-458b-987f-a62dd3633248",
    "applicationId": "d5e006da-d429-4472-8048-e7d81b892263",
    "applicationVersionId": "1564bdc1-d3df-438e-8c79-68f094aa7e61",
    "nodeId": "01a756a9-42c8-4abb-83f2-425b278959d2",
    "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-05T03:37:18.2298888+00:00",
    "updatedDateUtc": "2025-12-05T03:37:18.2298888+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-05T03:37:18.2298888+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-05T03:37:18.2298888+00:00</UpdatedDateUtc>
    <ApplicationId>d5e006da-d429-4472-8048-e7d81b892263</ApplicationId>
    <ApplicationVersionId>1564bdc1-d3df-438e-8c79-68f094aa7e61</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>d6570881-af21-458b-987f-a62dd3633248</DeviceGroupId>
    <DeviceId>944f44a6-9bf2-4ef9-919b-b7724b9d43e8</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>01a756a9-42c8-4abb-83f2-425b278959d2</NodeId>
    <NodeRouteId>67db25c1-fe4b-4033-9956-dfb2d5efa589</NodeRouteId>
    <TenantId>25ab94d8-56ef-413f-84b1-aee6cb0d6b9a</TenantId>
    <UserGroupId>0fb08a96-3f4c-491b-8be1-54b116bf80ec</UserGroupId>
    <UserId>7cb0f2fb-83af-475e-b949-bf3bbef8bd56</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-05T03:37:18.2298888+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-05T03:37:18.2298888+00:00</UpdatedDateUtc>
    <ApplicationId>d5e006da-d429-4472-8048-e7d81b892263</ApplicationId>
    <ApplicationVersionId>1564bdc1-d3df-438e-8c79-68f094aa7e61</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>d6570881-af21-458b-987f-a62dd3633248</DeviceGroupId>
    <DeviceId>944f44a6-9bf2-4ef9-919b-b7724b9d43e8</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>01a756a9-42c8-4abb-83f2-425b278959d2</NodeId>
    <NodeRouteId>67db25c1-fe4b-4033-9956-dfb2d5efa589</NodeRouteId>
    <TenantId>25ab94d8-56ef-413f-84b1-aee6cb0d6b9a</TenantId>
    <UserGroupId>0fb08a96-3f4c-491b-8be1-54b116bf80ec</UserGroupId>
    <UserId>7cb0f2fb-83af-475e-b949-bf3bbef8bd56</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-05T03:37:18.2298888+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-05T03:37:18.2298888+00:00</UpdatedDateUtc>
    <ApplicationId>d5e006da-d429-4472-8048-e7d81b892263</ApplicationId>
    <ApplicationVersionId>1564bdc1-d3df-438e-8c79-68f094aa7e61</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>d6570881-af21-458b-987f-a62dd3633248</DeviceGroupId>
    <DeviceId>944f44a6-9bf2-4ef9-919b-b7724b9d43e8</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>01a756a9-42c8-4abb-83f2-425b278959d2</NodeId>
    <NodeRouteId>67db25c1-fe4b-4033-9956-dfb2d5efa589</NodeRouteId>
    <TenantId>25ab94d8-56ef-413f-84b1-aee6cb0d6b9a</TenantId>
    <UserGroupId>0fb08a96-3f4c-491b-8be1-54b116bf80ec</UserGroupId>
    <UserId>7cb0f2fb-83af-475e-b949-bf3bbef8bd56</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>