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": "f9e06327-1ef0-4fcf-be7a-a7c71b066e2e",
    "tenantId": "ce0475b2-804f-472e-a7e0-96ed6ff60025",
    "userId": "e4a4b6af-7cec-4d16-9e12-e456591658cf",
    "userGroupId": "1c216adf-c5cd-4776-a185-6d725651f32d",
    "deviceId": "6a262a01-20de-4e97-89a6-cbf351dec829",
    "deviceGroupId": "4f03b713-3bd6-4599-87a6-fb52c73e2d86",
    "applicationId": "96038398-e761-4b32-99dc-b6304ea36732",
    "applicationVersionId": "d0a08031-007b-47ba-b048-b7e2bea0d57e",
    "nodeId": "d313fcad-f1d1-4eac-ad73-d95978fee856",
    "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-07-05T17:49:30.7679068+00:00",
    "updatedDateUtc": "2025-07-05T17:49:30.7679068+00:00"
  },
  {
    "nodeRouteId": "f9e06327-1ef0-4fcf-be7a-a7c71b066e2e",
    "tenantId": "ce0475b2-804f-472e-a7e0-96ed6ff60025",
    "userId": "e4a4b6af-7cec-4d16-9e12-e456591658cf",
    "userGroupId": "1c216adf-c5cd-4776-a185-6d725651f32d",
    "deviceId": "6a262a01-20de-4e97-89a6-cbf351dec829",
    "deviceGroupId": "4f03b713-3bd6-4599-87a6-fb52c73e2d86",
    "applicationId": "96038398-e761-4b32-99dc-b6304ea36732",
    "applicationVersionId": "d0a08031-007b-47ba-b048-b7e2bea0d57e",
    "nodeId": "d313fcad-f1d1-4eac-ad73-d95978fee856",
    "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-07-05T17:49:30.7679068+00:00",
    "updatedDateUtc": "2025-07-05T17:49:30.7679068+00:00"
  },
  {
    "nodeRouteId": "f9e06327-1ef0-4fcf-be7a-a7c71b066e2e",
    "tenantId": "ce0475b2-804f-472e-a7e0-96ed6ff60025",
    "userId": "e4a4b6af-7cec-4d16-9e12-e456591658cf",
    "userGroupId": "1c216adf-c5cd-4776-a185-6d725651f32d",
    "deviceId": "6a262a01-20de-4e97-89a6-cbf351dec829",
    "deviceGroupId": "4f03b713-3bd6-4599-87a6-fb52c73e2d86",
    "applicationId": "96038398-e761-4b32-99dc-b6304ea36732",
    "applicationVersionId": "d0a08031-007b-47ba-b048-b7e2bea0d57e",
    "nodeId": "d313fcad-f1d1-4eac-ad73-d95978fee856",
    "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-07-05T17:49:30.7679068+00:00",
    "updatedDateUtc": "2025-07-05T17:49:30.7679068+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-07-05T17:49:30.7679068+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T17:49:30.7679068+00:00</UpdatedDateUtc>
    <ApplicationId>96038398-e761-4b32-99dc-b6304ea36732</ApplicationId>
    <ApplicationVersionId>d0a08031-007b-47ba-b048-b7e2bea0d57e</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>4f03b713-3bd6-4599-87a6-fb52c73e2d86</DeviceGroupId>
    <DeviceId>6a262a01-20de-4e97-89a6-cbf351dec829</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>d313fcad-f1d1-4eac-ad73-d95978fee856</NodeId>
    <NodeRouteId>f9e06327-1ef0-4fcf-be7a-a7c71b066e2e</NodeRouteId>
    <TenantId>ce0475b2-804f-472e-a7e0-96ed6ff60025</TenantId>
    <UserGroupId>1c216adf-c5cd-4776-a185-6d725651f32d</UserGroupId>
    <UserId>e4a4b6af-7cec-4d16-9e12-e456591658cf</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-07-05T17:49:30.7679068+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T17:49:30.7679068+00:00</UpdatedDateUtc>
    <ApplicationId>96038398-e761-4b32-99dc-b6304ea36732</ApplicationId>
    <ApplicationVersionId>d0a08031-007b-47ba-b048-b7e2bea0d57e</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>4f03b713-3bd6-4599-87a6-fb52c73e2d86</DeviceGroupId>
    <DeviceId>6a262a01-20de-4e97-89a6-cbf351dec829</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>d313fcad-f1d1-4eac-ad73-d95978fee856</NodeId>
    <NodeRouteId>f9e06327-1ef0-4fcf-be7a-a7c71b066e2e</NodeRouteId>
    <TenantId>ce0475b2-804f-472e-a7e0-96ed6ff60025</TenantId>
    <UserGroupId>1c216adf-c5cd-4776-a185-6d725651f32d</UserGroupId>
    <UserId>e4a4b6af-7cec-4d16-9e12-e456591658cf</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-07-05T17:49:30.7679068+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T17:49:30.7679068+00:00</UpdatedDateUtc>
    <ApplicationId>96038398-e761-4b32-99dc-b6304ea36732</ApplicationId>
    <ApplicationVersionId>d0a08031-007b-47ba-b048-b7e2bea0d57e</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>4f03b713-3bd6-4599-87a6-fb52c73e2d86</DeviceGroupId>
    <DeviceId>6a262a01-20de-4e97-89a6-cbf351dec829</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>d313fcad-f1d1-4eac-ad73-d95978fee856</NodeId>
    <NodeRouteId>f9e06327-1ef0-4fcf-be7a-a7c71b066e2e</NodeRouteId>
    <TenantId>ce0475b2-804f-472e-a7e0-96ed6ff60025</TenantId>
    <UserGroupId>1c216adf-c5cd-4776-a185-6d725651f32d</UserGroupId>
    <UserId>e4a4b6af-7cec-4d16-9e12-e456591658cf</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>