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": "19d6f0f8-0175-4454-9f78-06f2bb1b9a1a",
    "tenantId": "6df7dda5-e569-4c92-b2b8-e0c78324cf30",
    "userId": "76a3034a-fb29-4ade-9c99-1bddc859f40a",
    "userGroupId": "f437ce62-dbc2-4b0f-b976-1a300bc8a8b2",
    "deviceId": "922ddbbe-7e3f-4bef-9065-d33752c8bf52",
    "deviceGroupId": "01b6db88-44a5-4489-998c-1b3ace2c5b57",
    "applicationId": "3280e419-aecc-4079-97a2-053c7e0a8b46",
    "applicationVersionId": "f832a417-427b-43b5-a899-d83bf9edb484",
    "nodeId": "f28b7370-efd8-4763-9128-0816407a4158",
    "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-03-31T04:00:22.4418294+00:00",
    "updatedDateUtc": "2026-03-31T04:00:22.4418294+00:00"
  },
  {
    "nodeRouteId": "19d6f0f8-0175-4454-9f78-06f2bb1b9a1a",
    "tenantId": "6df7dda5-e569-4c92-b2b8-e0c78324cf30",
    "userId": "76a3034a-fb29-4ade-9c99-1bddc859f40a",
    "userGroupId": "f437ce62-dbc2-4b0f-b976-1a300bc8a8b2",
    "deviceId": "922ddbbe-7e3f-4bef-9065-d33752c8bf52",
    "deviceGroupId": "01b6db88-44a5-4489-998c-1b3ace2c5b57",
    "applicationId": "3280e419-aecc-4079-97a2-053c7e0a8b46",
    "applicationVersionId": "f832a417-427b-43b5-a899-d83bf9edb484",
    "nodeId": "f28b7370-efd8-4763-9128-0816407a4158",
    "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-03-31T04:00:22.4418294+00:00",
    "updatedDateUtc": "2026-03-31T04:00:22.4418294+00:00"
  },
  {
    "nodeRouteId": "19d6f0f8-0175-4454-9f78-06f2bb1b9a1a",
    "tenantId": "6df7dda5-e569-4c92-b2b8-e0c78324cf30",
    "userId": "76a3034a-fb29-4ade-9c99-1bddc859f40a",
    "userGroupId": "f437ce62-dbc2-4b0f-b976-1a300bc8a8b2",
    "deviceId": "922ddbbe-7e3f-4bef-9065-d33752c8bf52",
    "deviceGroupId": "01b6db88-44a5-4489-998c-1b3ace2c5b57",
    "applicationId": "3280e419-aecc-4079-97a2-053c7e0a8b46",
    "applicationVersionId": "f832a417-427b-43b5-a899-d83bf9edb484",
    "nodeId": "f28b7370-efd8-4763-9128-0816407a4158",
    "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-03-31T04:00:22.4418294+00:00",
    "updatedDateUtc": "2026-03-31T04:00:22.4418294+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-03-31T04:00:22.4418294+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-31T04:00:22.4418294+00:00</UpdatedDateUtc>
    <ApplicationId>3280e419-aecc-4079-97a2-053c7e0a8b46</ApplicationId>
    <ApplicationVersionId>f832a417-427b-43b5-a899-d83bf9edb484</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>01b6db88-44a5-4489-998c-1b3ace2c5b57</DeviceGroupId>
    <DeviceId>922ddbbe-7e3f-4bef-9065-d33752c8bf52</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>f28b7370-efd8-4763-9128-0816407a4158</NodeId>
    <NodeRouteId>19d6f0f8-0175-4454-9f78-06f2bb1b9a1a</NodeRouteId>
    <TenantId>6df7dda5-e569-4c92-b2b8-e0c78324cf30</TenantId>
    <UserGroupId>f437ce62-dbc2-4b0f-b976-1a300bc8a8b2</UserGroupId>
    <UserId>76a3034a-fb29-4ade-9c99-1bddc859f40a</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2026-03-31T04:00:22.4418294+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-31T04:00:22.4418294+00:00</UpdatedDateUtc>
    <ApplicationId>3280e419-aecc-4079-97a2-053c7e0a8b46</ApplicationId>
    <ApplicationVersionId>f832a417-427b-43b5-a899-d83bf9edb484</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>01b6db88-44a5-4489-998c-1b3ace2c5b57</DeviceGroupId>
    <DeviceId>922ddbbe-7e3f-4bef-9065-d33752c8bf52</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>f28b7370-efd8-4763-9128-0816407a4158</NodeId>
    <NodeRouteId>19d6f0f8-0175-4454-9f78-06f2bb1b9a1a</NodeRouteId>
    <TenantId>6df7dda5-e569-4c92-b2b8-e0c78324cf30</TenantId>
    <UserGroupId>f437ce62-dbc2-4b0f-b976-1a300bc8a8b2</UserGroupId>
    <UserId>76a3034a-fb29-4ade-9c99-1bddc859f40a</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2026-03-31T04:00:22.4418294+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-31T04:00:22.4418294+00:00</UpdatedDateUtc>
    <ApplicationId>3280e419-aecc-4079-97a2-053c7e0a8b46</ApplicationId>
    <ApplicationVersionId>f832a417-427b-43b5-a899-d83bf9edb484</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>01b6db88-44a5-4489-998c-1b3ace2c5b57</DeviceGroupId>
    <DeviceId>922ddbbe-7e3f-4bef-9065-d33752c8bf52</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>f28b7370-efd8-4763-9128-0816407a4158</NodeId>
    <NodeRouteId>19d6f0f8-0175-4454-9f78-06f2bb1b9a1a</NodeRouteId>
    <TenantId>6df7dda5-e569-4c92-b2b8-e0c78324cf30</TenantId>
    <UserGroupId>f437ce62-dbc2-4b0f-b976-1a300bc8a8b2</UserGroupId>
    <UserId>76a3034a-fb29-4ade-9c99-1bddc859f40a</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>