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": "2af948f9-e5d8-4979-af40-a338f8772058",
    "tenantId": "2274979b-ac53-4c0d-8462-bb637d09fd85",
    "userId": "9e4c7707-afe0-483c-9b47-4736911a74eb",
    "userGroupId": "9b079ba5-5fa9-4fb7-89ee-96906d9f9241",
    "deviceId": "c07c56d6-2ea1-402d-a4f6-6207aa80a77f",
    "deviceGroupId": "00264bdc-081f-44f4-b371-f36561eed259",
    "applicationId": "9b21d15d-7898-4f4e-95d4-9725b3bf835e",
    "applicationVersionId": "02f686b9-1271-4adf-a8ab-e94dd903a74c",
    "nodeId": "f2dd5a69-dea6-4619-b55e-2df9a42fc334",
    "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-06-10T23:18:58.7655611+00:00",
    "updatedDateUtc": "2025-06-10T23:18:58.7655611+00:00"
  },
  {
    "nodeRouteId": "2af948f9-e5d8-4979-af40-a338f8772058",
    "tenantId": "2274979b-ac53-4c0d-8462-bb637d09fd85",
    "userId": "9e4c7707-afe0-483c-9b47-4736911a74eb",
    "userGroupId": "9b079ba5-5fa9-4fb7-89ee-96906d9f9241",
    "deviceId": "c07c56d6-2ea1-402d-a4f6-6207aa80a77f",
    "deviceGroupId": "00264bdc-081f-44f4-b371-f36561eed259",
    "applicationId": "9b21d15d-7898-4f4e-95d4-9725b3bf835e",
    "applicationVersionId": "02f686b9-1271-4adf-a8ab-e94dd903a74c",
    "nodeId": "f2dd5a69-dea6-4619-b55e-2df9a42fc334",
    "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-06-10T23:18:58.7655611+00:00",
    "updatedDateUtc": "2025-06-10T23:18:58.7655611+00:00"
  },
  {
    "nodeRouteId": "2af948f9-e5d8-4979-af40-a338f8772058",
    "tenantId": "2274979b-ac53-4c0d-8462-bb637d09fd85",
    "userId": "9e4c7707-afe0-483c-9b47-4736911a74eb",
    "userGroupId": "9b079ba5-5fa9-4fb7-89ee-96906d9f9241",
    "deviceId": "c07c56d6-2ea1-402d-a4f6-6207aa80a77f",
    "deviceGroupId": "00264bdc-081f-44f4-b371-f36561eed259",
    "applicationId": "9b21d15d-7898-4f4e-95d4-9725b3bf835e",
    "applicationVersionId": "02f686b9-1271-4adf-a8ab-e94dd903a74c",
    "nodeId": "f2dd5a69-dea6-4619-b55e-2df9a42fc334",
    "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-06-10T23:18:58.7655611+00:00",
    "updatedDateUtc": "2025-06-10T23:18:58.7655611+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-06-10T23:18:58.7655611+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-06-10T23:18:58.7655611+00:00</UpdatedDateUtc>
    <ApplicationId>9b21d15d-7898-4f4e-95d4-9725b3bf835e</ApplicationId>
    <ApplicationVersionId>02f686b9-1271-4adf-a8ab-e94dd903a74c</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>00264bdc-081f-44f4-b371-f36561eed259</DeviceGroupId>
    <DeviceId>c07c56d6-2ea1-402d-a4f6-6207aa80a77f</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>f2dd5a69-dea6-4619-b55e-2df9a42fc334</NodeId>
    <NodeRouteId>2af948f9-e5d8-4979-af40-a338f8772058</NodeRouteId>
    <TenantId>2274979b-ac53-4c0d-8462-bb637d09fd85</TenantId>
    <UserGroupId>9b079ba5-5fa9-4fb7-89ee-96906d9f9241</UserGroupId>
    <UserId>9e4c7707-afe0-483c-9b47-4736911a74eb</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-06-10T23:18:58.7655611+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-06-10T23:18:58.7655611+00:00</UpdatedDateUtc>
    <ApplicationId>9b21d15d-7898-4f4e-95d4-9725b3bf835e</ApplicationId>
    <ApplicationVersionId>02f686b9-1271-4adf-a8ab-e94dd903a74c</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>00264bdc-081f-44f4-b371-f36561eed259</DeviceGroupId>
    <DeviceId>c07c56d6-2ea1-402d-a4f6-6207aa80a77f</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>f2dd5a69-dea6-4619-b55e-2df9a42fc334</NodeId>
    <NodeRouteId>2af948f9-e5d8-4979-af40-a338f8772058</NodeRouteId>
    <TenantId>2274979b-ac53-4c0d-8462-bb637d09fd85</TenantId>
    <UserGroupId>9b079ba5-5fa9-4fb7-89ee-96906d9f9241</UserGroupId>
    <UserId>9e4c7707-afe0-483c-9b47-4736911a74eb</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-06-10T23:18:58.7655611+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-06-10T23:18:58.7655611+00:00</UpdatedDateUtc>
    <ApplicationId>9b21d15d-7898-4f4e-95d4-9725b3bf835e</ApplicationId>
    <ApplicationVersionId>02f686b9-1271-4adf-a8ab-e94dd903a74c</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>00264bdc-081f-44f4-b371-f36561eed259</DeviceGroupId>
    <DeviceId>c07c56d6-2ea1-402d-a4f6-6207aa80a77f</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>f2dd5a69-dea6-4619-b55e-2df9a42fc334</NodeId>
    <NodeRouteId>2af948f9-e5d8-4979-af40-a338f8772058</NodeRouteId>
    <TenantId>2274979b-ac53-4c0d-8462-bb637d09fd85</TenantId>
    <UserGroupId>9b079ba5-5fa9-4fb7-89ee-96906d9f9241</UserGroupId>
    <UserId>9e4c7707-afe0-483c-9b47-4736911a74eb</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>