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": "06324897-b66b-4b82-ae57-9bfeab83b735",
    "tenantId": "9a99347f-9347-4899-b802-3c0c097830b9",
    "userId": "c44272a9-714b-42c3-a636-82f243ed9a08",
    "userGroupId": "5ae933cd-fce0-49af-84ba-2afabd7af162",
    "deviceId": "c009aef2-228d-4bfe-93cc-665f23ff6fcd",
    "deviceGroupId": "89a4dbca-0e1d-4820-8c64-a68dbc85938c",
    "applicationId": "27db8198-f08b-4353-b5d7-441249329764",
    "applicationVersionId": "7bb7cccd-5878-47eb-9539-b8a805b9d068",
    "nodeId": "45affb2e-8e18-42ab-9742-0e765b971962",
    "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-11-08T10:54:22.1821602+00:00",
    "updatedDateUtc": "2025-11-08T10:54:22.1821602+00:00"
  },
  {
    "nodeRouteId": "06324897-b66b-4b82-ae57-9bfeab83b735",
    "tenantId": "9a99347f-9347-4899-b802-3c0c097830b9",
    "userId": "c44272a9-714b-42c3-a636-82f243ed9a08",
    "userGroupId": "5ae933cd-fce0-49af-84ba-2afabd7af162",
    "deviceId": "c009aef2-228d-4bfe-93cc-665f23ff6fcd",
    "deviceGroupId": "89a4dbca-0e1d-4820-8c64-a68dbc85938c",
    "applicationId": "27db8198-f08b-4353-b5d7-441249329764",
    "applicationVersionId": "7bb7cccd-5878-47eb-9539-b8a805b9d068",
    "nodeId": "45affb2e-8e18-42ab-9742-0e765b971962",
    "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-11-08T10:54:22.1821602+00:00",
    "updatedDateUtc": "2025-11-08T10:54:22.1821602+00:00"
  },
  {
    "nodeRouteId": "06324897-b66b-4b82-ae57-9bfeab83b735",
    "tenantId": "9a99347f-9347-4899-b802-3c0c097830b9",
    "userId": "c44272a9-714b-42c3-a636-82f243ed9a08",
    "userGroupId": "5ae933cd-fce0-49af-84ba-2afabd7af162",
    "deviceId": "c009aef2-228d-4bfe-93cc-665f23ff6fcd",
    "deviceGroupId": "89a4dbca-0e1d-4820-8c64-a68dbc85938c",
    "applicationId": "27db8198-f08b-4353-b5d7-441249329764",
    "applicationVersionId": "7bb7cccd-5878-47eb-9539-b8a805b9d068",
    "nodeId": "45affb2e-8e18-42ab-9742-0e765b971962",
    "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-11-08T10:54:22.1821602+00:00",
    "updatedDateUtc": "2025-11-08T10:54:22.1821602+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-11-08T10:54:22.1821602+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-11-08T10:54:22.1821602+00:00</UpdatedDateUtc>
    <ApplicationId>27db8198-f08b-4353-b5d7-441249329764</ApplicationId>
    <ApplicationVersionId>7bb7cccd-5878-47eb-9539-b8a805b9d068</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>89a4dbca-0e1d-4820-8c64-a68dbc85938c</DeviceGroupId>
    <DeviceId>c009aef2-228d-4bfe-93cc-665f23ff6fcd</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>45affb2e-8e18-42ab-9742-0e765b971962</NodeId>
    <NodeRouteId>06324897-b66b-4b82-ae57-9bfeab83b735</NodeRouteId>
    <TenantId>9a99347f-9347-4899-b802-3c0c097830b9</TenantId>
    <UserGroupId>5ae933cd-fce0-49af-84ba-2afabd7af162</UserGroupId>
    <UserId>c44272a9-714b-42c3-a636-82f243ed9a08</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-11-08T10:54:22.1821602+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-11-08T10:54:22.1821602+00:00</UpdatedDateUtc>
    <ApplicationId>27db8198-f08b-4353-b5d7-441249329764</ApplicationId>
    <ApplicationVersionId>7bb7cccd-5878-47eb-9539-b8a805b9d068</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>89a4dbca-0e1d-4820-8c64-a68dbc85938c</DeviceGroupId>
    <DeviceId>c009aef2-228d-4bfe-93cc-665f23ff6fcd</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>45affb2e-8e18-42ab-9742-0e765b971962</NodeId>
    <NodeRouteId>06324897-b66b-4b82-ae57-9bfeab83b735</NodeRouteId>
    <TenantId>9a99347f-9347-4899-b802-3c0c097830b9</TenantId>
    <UserGroupId>5ae933cd-fce0-49af-84ba-2afabd7af162</UserGroupId>
    <UserId>c44272a9-714b-42c3-a636-82f243ed9a08</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-11-08T10:54:22.1821602+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-11-08T10:54:22.1821602+00:00</UpdatedDateUtc>
    <ApplicationId>27db8198-f08b-4353-b5d7-441249329764</ApplicationId>
    <ApplicationVersionId>7bb7cccd-5878-47eb-9539-b8a805b9d068</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>89a4dbca-0e1d-4820-8c64-a68dbc85938c</DeviceGroupId>
    <DeviceId>c009aef2-228d-4bfe-93cc-665f23ff6fcd</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>45affb2e-8e18-42ab-9742-0e765b971962</NodeId>
    <NodeRouteId>06324897-b66b-4b82-ae57-9bfeab83b735</NodeRouteId>
    <TenantId>9a99347f-9347-4899-b802-3c0c097830b9</TenantId>
    <UserGroupId>5ae933cd-fce0-49af-84ba-2afabd7af162</UserGroupId>
    <UserId>c44272a9-714b-42c3-a636-82f243ed9a08</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>