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": "f4f846aa-25e4-49b1-90b4-d1ecce2a2dd1",
    "tenantId": "9ba172b9-bed2-459a-90f4-e0a4da12864d",
    "userId": "a667bcfd-7989-47cf-8300-8f672fe6130b",
    "userGroupId": "286d195e-3e0a-4ddc-bea2-4b28461848bf",
    "deviceId": "494b5084-060f-4110-802c-695af5c8c5d9",
    "deviceGroupId": "fdf50c6f-cc97-4709-a794-6d45f66fe245",
    "applicationId": "8a04ef1c-4046-42f9-a3b3-e23cc85c6c07",
    "applicationVersionId": "f4218f0c-5163-4b03-8d55-b49d2bf4013b",
    "nodeId": "1a185839-2177-42f4-baac-22e808be7a46",
    "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-16T08:37:07.7094803+00:00",
    "updatedDateUtc": "2025-12-16T08:37:07.7094803+00:00"
  },
  {
    "nodeRouteId": "f4f846aa-25e4-49b1-90b4-d1ecce2a2dd1",
    "tenantId": "9ba172b9-bed2-459a-90f4-e0a4da12864d",
    "userId": "a667bcfd-7989-47cf-8300-8f672fe6130b",
    "userGroupId": "286d195e-3e0a-4ddc-bea2-4b28461848bf",
    "deviceId": "494b5084-060f-4110-802c-695af5c8c5d9",
    "deviceGroupId": "fdf50c6f-cc97-4709-a794-6d45f66fe245",
    "applicationId": "8a04ef1c-4046-42f9-a3b3-e23cc85c6c07",
    "applicationVersionId": "f4218f0c-5163-4b03-8d55-b49d2bf4013b",
    "nodeId": "1a185839-2177-42f4-baac-22e808be7a46",
    "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-16T08:37:07.7094803+00:00",
    "updatedDateUtc": "2025-12-16T08:37:07.7094803+00:00"
  },
  {
    "nodeRouteId": "f4f846aa-25e4-49b1-90b4-d1ecce2a2dd1",
    "tenantId": "9ba172b9-bed2-459a-90f4-e0a4da12864d",
    "userId": "a667bcfd-7989-47cf-8300-8f672fe6130b",
    "userGroupId": "286d195e-3e0a-4ddc-bea2-4b28461848bf",
    "deviceId": "494b5084-060f-4110-802c-695af5c8c5d9",
    "deviceGroupId": "fdf50c6f-cc97-4709-a794-6d45f66fe245",
    "applicationId": "8a04ef1c-4046-42f9-a3b3-e23cc85c6c07",
    "applicationVersionId": "f4218f0c-5163-4b03-8d55-b49d2bf4013b",
    "nodeId": "1a185839-2177-42f4-baac-22e808be7a46",
    "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-16T08:37:07.7094803+00:00",
    "updatedDateUtc": "2025-12-16T08:37:07.7094803+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-16T08:37:07.7094803+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-16T08:37:07.7094803+00:00</UpdatedDateUtc>
    <ApplicationId>8a04ef1c-4046-42f9-a3b3-e23cc85c6c07</ApplicationId>
    <ApplicationVersionId>f4218f0c-5163-4b03-8d55-b49d2bf4013b</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>fdf50c6f-cc97-4709-a794-6d45f66fe245</DeviceGroupId>
    <DeviceId>494b5084-060f-4110-802c-695af5c8c5d9</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>1a185839-2177-42f4-baac-22e808be7a46</NodeId>
    <NodeRouteId>f4f846aa-25e4-49b1-90b4-d1ecce2a2dd1</NodeRouteId>
    <TenantId>9ba172b9-bed2-459a-90f4-e0a4da12864d</TenantId>
    <UserGroupId>286d195e-3e0a-4ddc-bea2-4b28461848bf</UserGroupId>
    <UserId>a667bcfd-7989-47cf-8300-8f672fe6130b</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-16T08:37:07.7094803+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-16T08:37:07.7094803+00:00</UpdatedDateUtc>
    <ApplicationId>8a04ef1c-4046-42f9-a3b3-e23cc85c6c07</ApplicationId>
    <ApplicationVersionId>f4218f0c-5163-4b03-8d55-b49d2bf4013b</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>fdf50c6f-cc97-4709-a794-6d45f66fe245</DeviceGroupId>
    <DeviceId>494b5084-060f-4110-802c-695af5c8c5d9</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>1a185839-2177-42f4-baac-22e808be7a46</NodeId>
    <NodeRouteId>f4f846aa-25e4-49b1-90b4-d1ecce2a2dd1</NodeRouteId>
    <TenantId>9ba172b9-bed2-459a-90f4-e0a4da12864d</TenantId>
    <UserGroupId>286d195e-3e0a-4ddc-bea2-4b28461848bf</UserGroupId>
    <UserId>a667bcfd-7989-47cf-8300-8f672fe6130b</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-16T08:37:07.7094803+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-16T08:37:07.7094803+00:00</UpdatedDateUtc>
    <ApplicationId>8a04ef1c-4046-42f9-a3b3-e23cc85c6c07</ApplicationId>
    <ApplicationVersionId>f4218f0c-5163-4b03-8d55-b49d2bf4013b</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>fdf50c6f-cc97-4709-a794-6d45f66fe245</DeviceGroupId>
    <DeviceId>494b5084-060f-4110-802c-695af5c8c5d9</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>1a185839-2177-42f4-baac-22e808be7a46</NodeId>
    <NodeRouteId>f4f846aa-25e4-49b1-90b4-d1ecce2a2dd1</NodeRouteId>
    <TenantId>9ba172b9-bed2-459a-90f4-e0a4da12864d</TenantId>
    <UserGroupId>286d195e-3e0a-4ddc-bea2-4b28461848bf</UserGroupId>
    <UserId>a667bcfd-7989-47cf-8300-8f672fe6130b</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>