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": "e7be9ec4-44f7-4c29-9a02-f6b253865591",
    "tenantId": "44eb0fef-0b40-477f-978c-8949a0e4a1a3",
    "userId": "d3b6febd-3e44-4cf6-9345-f1b4abf10d8a",
    "userGroupId": "1121d572-ed19-4f5c-8c25-c875d4f80566",
    "deviceId": "82fe07cc-a7ea-484a-987f-575dc381d676",
    "deviceGroupId": "0a90adbe-4190-4669-bc21-b95c661681be",
    "applicationId": "cb9fcb50-54d1-4918-9c25-39d59c199aca",
    "applicationVersionId": "eb0dcfbc-1a62-4c5d-ade2-cb0382be4a52",
    "nodeId": "843bb9af-4085-4129-a56e-6683e2e33a32",
    "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-13T13:37:44.1109631+00:00",
    "updatedDateUtc": "2025-12-13T13:37:44.1109631+00:00"
  },
  {
    "nodeRouteId": "e7be9ec4-44f7-4c29-9a02-f6b253865591",
    "tenantId": "44eb0fef-0b40-477f-978c-8949a0e4a1a3",
    "userId": "d3b6febd-3e44-4cf6-9345-f1b4abf10d8a",
    "userGroupId": "1121d572-ed19-4f5c-8c25-c875d4f80566",
    "deviceId": "82fe07cc-a7ea-484a-987f-575dc381d676",
    "deviceGroupId": "0a90adbe-4190-4669-bc21-b95c661681be",
    "applicationId": "cb9fcb50-54d1-4918-9c25-39d59c199aca",
    "applicationVersionId": "eb0dcfbc-1a62-4c5d-ade2-cb0382be4a52",
    "nodeId": "843bb9af-4085-4129-a56e-6683e2e33a32",
    "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-13T13:37:44.1109631+00:00",
    "updatedDateUtc": "2025-12-13T13:37:44.1109631+00:00"
  },
  {
    "nodeRouteId": "e7be9ec4-44f7-4c29-9a02-f6b253865591",
    "tenantId": "44eb0fef-0b40-477f-978c-8949a0e4a1a3",
    "userId": "d3b6febd-3e44-4cf6-9345-f1b4abf10d8a",
    "userGroupId": "1121d572-ed19-4f5c-8c25-c875d4f80566",
    "deviceId": "82fe07cc-a7ea-484a-987f-575dc381d676",
    "deviceGroupId": "0a90adbe-4190-4669-bc21-b95c661681be",
    "applicationId": "cb9fcb50-54d1-4918-9c25-39d59c199aca",
    "applicationVersionId": "eb0dcfbc-1a62-4c5d-ade2-cb0382be4a52",
    "nodeId": "843bb9af-4085-4129-a56e-6683e2e33a32",
    "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-13T13:37:44.1109631+00:00",
    "updatedDateUtc": "2025-12-13T13:37:44.1109631+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-13T13:37:44.1109631+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-13T13:37:44.1109631+00:00</UpdatedDateUtc>
    <ApplicationId>cb9fcb50-54d1-4918-9c25-39d59c199aca</ApplicationId>
    <ApplicationVersionId>eb0dcfbc-1a62-4c5d-ade2-cb0382be4a52</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>0a90adbe-4190-4669-bc21-b95c661681be</DeviceGroupId>
    <DeviceId>82fe07cc-a7ea-484a-987f-575dc381d676</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>843bb9af-4085-4129-a56e-6683e2e33a32</NodeId>
    <NodeRouteId>e7be9ec4-44f7-4c29-9a02-f6b253865591</NodeRouteId>
    <TenantId>44eb0fef-0b40-477f-978c-8949a0e4a1a3</TenantId>
    <UserGroupId>1121d572-ed19-4f5c-8c25-c875d4f80566</UserGroupId>
    <UserId>d3b6febd-3e44-4cf6-9345-f1b4abf10d8a</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-13T13:37:44.1109631+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-13T13:37:44.1109631+00:00</UpdatedDateUtc>
    <ApplicationId>cb9fcb50-54d1-4918-9c25-39d59c199aca</ApplicationId>
    <ApplicationVersionId>eb0dcfbc-1a62-4c5d-ade2-cb0382be4a52</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>0a90adbe-4190-4669-bc21-b95c661681be</DeviceGroupId>
    <DeviceId>82fe07cc-a7ea-484a-987f-575dc381d676</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>843bb9af-4085-4129-a56e-6683e2e33a32</NodeId>
    <NodeRouteId>e7be9ec4-44f7-4c29-9a02-f6b253865591</NodeRouteId>
    <TenantId>44eb0fef-0b40-477f-978c-8949a0e4a1a3</TenantId>
    <UserGroupId>1121d572-ed19-4f5c-8c25-c875d4f80566</UserGroupId>
    <UserId>d3b6febd-3e44-4cf6-9345-f1b4abf10d8a</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-13T13:37:44.1109631+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-13T13:37:44.1109631+00:00</UpdatedDateUtc>
    <ApplicationId>cb9fcb50-54d1-4918-9c25-39d59c199aca</ApplicationId>
    <ApplicationVersionId>eb0dcfbc-1a62-4c5d-ade2-cb0382be4a52</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>0a90adbe-4190-4669-bc21-b95c661681be</DeviceGroupId>
    <DeviceId>82fe07cc-a7ea-484a-987f-575dc381d676</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>843bb9af-4085-4129-a56e-6683e2e33a32</NodeId>
    <NodeRouteId>e7be9ec4-44f7-4c29-9a02-f6b253865591</NodeRouteId>
    <TenantId>44eb0fef-0b40-477f-978c-8949a0e4a1a3</TenantId>
    <UserGroupId>1121d572-ed19-4f5c-8c25-c875d4f80566</UserGroupId>
    <UserId>d3b6febd-3e44-4cf6-9345-f1b4abf10d8a</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>