Cyan Web API - Version 1


GET api/nodeRoutes/{nodeRouteId}

            Gets a NodeRoute by NodeRouteId
            

Request Information

Parameters

NameDescriptionAdditional information
nodeRouteId

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "nodeRouteId": "29cd3325-6aeb-40b9-a597-96e3b180ff5f",
  "tenantId": "2398de36-6ac9-4a83-94ca-a0572e22b2a0",
  "userId": "f6de5554-4aa2-4340-bf01-56003dc7c8a4",
  "userGroupId": "258bad1e-d3bd-441c-b566-86e399ecedb7",
  "deviceId": "36f8c9c5-79fa-4c5d-a051-4aa9b8b4073e",
  "deviceGroupId": "77d814fa-a60a-431b-a012-e79e3c6c76ca",
  "applicationId": "e00f6611-4f70-462d-8563-e1533d8c7cf2",
  "applicationVersionId": "bb97f04e-d3c1-4f63-98ec-19ada439a232",
  "nodeId": "fc9f44c9-5bfc-459c-b733-20d33986d041",
  "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": "2026-05-18T10:59:29.1239388+00:00",
  "updatedDateUtc": "2026-05-18T10:59:29.1239388+00:00"
}

application/xml, text/xml

Sample:
<NodeRouteRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2026-05-18T10:59:29.1239388+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-05-18T10:59:29.1239388+00:00</UpdatedDateUtc>
  <ApplicationId>e00f6611-4f70-462d-8563-e1533d8c7cf2</ApplicationId>
  <ApplicationVersionId>bb97f04e-d3c1-4f63-98ec-19ada439a232</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>77d814fa-a60a-431b-a012-e79e3c6c76ca</DeviceGroupId>
  <DeviceId>36f8c9c5-79fa-4c5d-a051-4aa9b8b4073e</DeviceId>
  <IgnoreNodeIdsInRouting xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </IgnoreNodeIdsInRouting>
  <Name>sample string 4</Name>
  <NodeCyanId>6</NodeCyanId>
  <NodeId>fc9f44c9-5bfc-459c-b733-20d33986d041</NodeId>
  <NodeRouteId>29cd3325-6aeb-40b9-a597-96e3b180ff5f</NodeRouteId>
  <TenantId>2398de36-6ac9-4a83-94ca-a0572e22b2a0</TenantId>
  <UserGroupId>258bad1e-d3bd-441c-b566-86e399ecedb7</UserGroupId>
  <UserId>f6de5554-4aa2-4340-bf01-56003dc7c8a4</UserId>
</NodeRouteRepresentation>