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": "4fac1633-63c1-4251-b954-794d1f83ce42",
    "tenantId": "e175b0c9-1097-44f3-94f8-71148bd63886",
    "userId": "7b8691ce-d156-43b3-b8f9-0fe50de24618",
    "userGroupId": "7cb1bd07-543d-4787-bc52-1907f383116a",
    "deviceId": "11492bc8-7667-4cbe-b757-d8251046aef5",
    "deviceGroupId": "4eb41df8-facb-4b44-a04c-71532c7bdce3",
    "applicationId": "3826bc29-1295-42fa-a4a1-73ebfe9c1f79",
    "applicationVersionId": "8bf20b51-5e9e-441b-ad99-f6fa5069ab83",
    "nodeId": "f4ec001b-6e4d-4c97-8ca8-a7382dada99e",
    "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-12T13:20:25.1473671+00:00",
    "updatedDateUtc": "2025-11-12T13:20:25.1473671+00:00"
  },
  {
    "nodeRouteId": "4fac1633-63c1-4251-b954-794d1f83ce42",
    "tenantId": "e175b0c9-1097-44f3-94f8-71148bd63886",
    "userId": "7b8691ce-d156-43b3-b8f9-0fe50de24618",
    "userGroupId": "7cb1bd07-543d-4787-bc52-1907f383116a",
    "deviceId": "11492bc8-7667-4cbe-b757-d8251046aef5",
    "deviceGroupId": "4eb41df8-facb-4b44-a04c-71532c7bdce3",
    "applicationId": "3826bc29-1295-42fa-a4a1-73ebfe9c1f79",
    "applicationVersionId": "8bf20b51-5e9e-441b-ad99-f6fa5069ab83",
    "nodeId": "f4ec001b-6e4d-4c97-8ca8-a7382dada99e",
    "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-12T13:20:25.1473671+00:00",
    "updatedDateUtc": "2025-11-12T13:20:25.1473671+00:00"
  },
  {
    "nodeRouteId": "4fac1633-63c1-4251-b954-794d1f83ce42",
    "tenantId": "e175b0c9-1097-44f3-94f8-71148bd63886",
    "userId": "7b8691ce-d156-43b3-b8f9-0fe50de24618",
    "userGroupId": "7cb1bd07-543d-4787-bc52-1907f383116a",
    "deviceId": "11492bc8-7667-4cbe-b757-d8251046aef5",
    "deviceGroupId": "4eb41df8-facb-4b44-a04c-71532c7bdce3",
    "applicationId": "3826bc29-1295-42fa-a4a1-73ebfe9c1f79",
    "applicationVersionId": "8bf20b51-5e9e-441b-ad99-f6fa5069ab83",
    "nodeId": "f4ec001b-6e4d-4c97-8ca8-a7382dada99e",
    "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-12T13:20:25.1473671+00:00",
    "updatedDateUtc": "2025-11-12T13:20:25.1473671+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-12T13:20:25.1473671+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-11-12T13:20:25.1473671+00:00</UpdatedDateUtc>
    <ApplicationId>3826bc29-1295-42fa-a4a1-73ebfe9c1f79</ApplicationId>
    <ApplicationVersionId>8bf20b51-5e9e-441b-ad99-f6fa5069ab83</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>4eb41df8-facb-4b44-a04c-71532c7bdce3</DeviceGroupId>
    <DeviceId>11492bc8-7667-4cbe-b757-d8251046aef5</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>f4ec001b-6e4d-4c97-8ca8-a7382dada99e</NodeId>
    <NodeRouteId>4fac1633-63c1-4251-b954-794d1f83ce42</NodeRouteId>
    <TenantId>e175b0c9-1097-44f3-94f8-71148bd63886</TenantId>
    <UserGroupId>7cb1bd07-543d-4787-bc52-1907f383116a</UserGroupId>
    <UserId>7b8691ce-d156-43b3-b8f9-0fe50de24618</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-11-12T13:20:25.1473671+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-11-12T13:20:25.1473671+00:00</UpdatedDateUtc>
    <ApplicationId>3826bc29-1295-42fa-a4a1-73ebfe9c1f79</ApplicationId>
    <ApplicationVersionId>8bf20b51-5e9e-441b-ad99-f6fa5069ab83</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>4eb41df8-facb-4b44-a04c-71532c7bdce3</DeviceGroupId>
    <DeviceId>11492bc8-7667-4cbe-b757-d8251046aef5</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>f4ec001b-6e4d-4c97-8ca8-a7382dada99e</NodeId>
    <NodeRouteId>4fac1633-63c1-4251-b954-794d1f83ce42</NodeRouteId>
    <TenantId>e175b0c9-1097-44f3-94f8-71148bd63886</TenantId>
    <UserGroupId>7cb1bd07-543d-4787-bc52-1907f383116a</UserGroupId>
    <UserId>7b8691ce-d156-43b3-b8f9-0fe50de24618</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-11-12T13:20:25.1473671+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-11-12T13:20:25.1473671+00:00</UpdatedDateUtc>
    <ApplicationId>3826bc29-1295-42fa-a4a1-73ebfe9c1f79</ApplicationId>
    <ApplicationVersionId>8bf20b51-5e9e-441b-ad99-f6fa5069ab83</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>4eb41df8-facb-4b44-a04c-71532c7bdce3</DeviceGroupId>
    <DeviceId>11492bc8-7667-4cbe-b757-d8251046aef5</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>f4ec001b-6e4d-4c97-8ca8-a7382dada99e</NodeId>
    <NodeRouteId>4fac1633-63c1-4251-b954-794d1f83ce42</NodeRouteId>
    <TenantId>e175b0c9-1097-44f3-94f8-71148bd63886</TenantId>
    <UserGroupId>7cb1bd07-543d-4787-bc52-1907f383116a</UserGroupId>
    <UserId>7b8691ce-d156-43b3-b8f9-0fe50de24618</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>