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": "a9fabe73-a3c3-4f79-80a6-bbeed7fe9de8",
  "tenantId": "0f63c3c1-ea90-493a-8eca-683be725a39d",
  "userId": "4ffd8cec-7a3c-42bc-b84a-a7f1db6796e1",
  "userGroupId": "6906bde9-5eb5-4194-8d75-20a64d9d008b",
  "deviceId": "4a7da181-5997-493e-9464-b4be5ee58c9c",
  "deviceGroupId": "72264c71-4872-4c9c-99e1-9587d70cba55",
  "applicationId": "45f60def-7646-4b27-91fd-900581f2526e",
  "applicationVersionId": "ef35dbbb-170c-4b9d-b27c-77ab05821883",
  "nodeId": "7a0dfae0-9594-4321-a83c-d24f8c3f99d2",
  "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-11T03:11:44.3974063+00:00",
  "updatedDateUtc": "2026-08-11T03:11:44.3974063+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-11T03:11:44.3974063+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-11T03:11:44.3974063+00:00</UpdatedDateUtc>
  <ApplicationId>45f60def-7646-4b27-91fd-900581f2526e</ApplicationId>
  <ApplicationVersionId>ef35dbbb-170c-4b9d-b27c-77ab05821883</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>72264c71-4872-4c9c-99e1-9587d70cba55</DeviceGroupId>
  <DeviceId>4a7da181-5997-493e-9464-b4be5ee58c9c</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>7a0dfae0-9594-4321-a83c-d24f8c3f99d2</NodeId>
  <NodeRouteId>a9fabe73-a3c3-4f79-80a6-bbeed7fe9de8</NodeRouteId>
  <TenantId>0f63c3c1-ea90-493a-8eca-683be725a39d</TenantId>
  <UserGroupId>6906bde9-5eb5-4194-8d75-20a64d9d008b</UserGroupId>
  <UserId>4ffd8cec-7a3c-42bc-b84a-a7f1db6796e1</UserId>
</NodeRouteRepresentation>