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": "73d49603-f96b-4e91-891b-5249d1368207",
  "tenantId": "3e8cff35-a57e-46b8-b538-937b1609e5e8",
  "userId": "f74b3434-7a70-4123-acb1-4d87c9a5b739",
  "userGroupId": "2d9daf60-f228-4f66-9422-aea3325919e7",
  "deviceId": "18b028ac-3baa-4059-8491-18512416891b",
  "deviceGroupId": "f8f19def-3fca-4eba-a10f-8a921a0b0eeb",
  "applicationId": "819ed63d-4c00-4e36-994b-79dbbf144d95",
  "applicationVersionId": "6080a372-188b-46a0-8144-ccffabe06e36",
  "nodeId": "d93c0f43-0b72-4d81-b3fc-faa11521e337",
  "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-06-01T14:26:42.1600855+00:00",
  "updatedDateUtc": "2026-06-01T14:26:42.1600855+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-06-01T14:26:42.1600855+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-01T14:26:42.1600855+00:00</UpdatedDateUtc>
  <ApplicationId>819ed63d-4c00-4e36-994b-79dbbf144d95</ApplicationId>
  <ApplicationVersionId>6080a372-188b-46a0-8144-ccffabe06e36</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>f8f19def-3fca-4eba-a10f-8a921a0b0eeb</DeviceGroupId>
  <DeviceId>18b028ac-3baa-4059-8491-18512416891b</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>d93c0f43-0b72-4d81-b3fc-faa11521e337</NodeId>
  <NodeRouteId>73d49603-f96b-4e91-891b-5249d1368207</NodeRouteId>
  <TenantId>3e8cff35-a57e-46b8-b538-937b1609e5e8</TenantId>
  <UserGroupId>2d9daf60-f228-4f66-9422-aea3325919e7</UserGroupId>
  <UserId>f74b3434-7a70-4123-acb1-4d87c9a5b739</UserId>
</NodeRouteRepresentation>