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": "c31f011f-fbc4-4b94-8547-f87ce1433478",
  "tenantId": "efc6d52f-8d37-485f-a701-7bd15e69dc96",
  "userId": "d34f1700-5bce-410d-9772-f29ca2e77c5d",
  "userGroupId": "238c4f2d-3251-46c1-84c6-d1539f114cfa",
  "deviceId": "2e9cc656-ab67-4986-a094-2cc01d236d51",
  "deviceGroupId": "c45ab18e-9c51-4c10-bd80-ad707ef86e98",
  "applicationId": "0088ad7e-db54-4cb6-b0a9-57469deaa314",
  "applicationVersionId": "a47cc257-40ae-43e9-8b29-e9394c7d68c6",
  "nodeId": "ebbe9d9c-492e-4548-8edf-32f17996ebc0",
  "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-08-15T17:25:41.281535+00:00",
  "updatedDateUtc": "2026-08-15T17:25:41.281535+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-08-15T17:25:41.281535+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-15T17:25:41.281535+00:00</UpdatedDateUtc>
  <ApplicationId>0088ad7e-db54-4cb6-b0a9-57469deaa314</ApplicationId>
  <ApplicationVersionId>a47cc257-40ae-43e9-8b29-e9394c7d68c6</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>c45ab18e-9c51-4c10-bd80-ad707ef86e98</DeviceGroupId>
  <DeviceId>2e9cc656-ab67-4986-a094-2cc01d236d51</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>ebbe9d9c-492e-4548-8edf-32f17996ebc0</NodeId>
  <NodeRouteId>c31f011f-fbc4-4b94-8547-f87ce1433478</NodeRouteId>
  <TenantId>efc6d52f-8d37-485f-a701-7bd15e69dc96</TenantId>
  <UserGroupId>238c4f2d-3251-46c1-84c6-d1539f114cfa</UserGroupId>
  <UserId>d34f1700-5bce-410d-9772-f29ca2e77c5d</UserId>
</NodeRouteRepresentation>