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": "2f0a0144-3d2b-4f90-a07c-d22020628b48",
  "tenantId": "6547306e-a334-4201-ab05-1ae7b486ca82",
  "userId": "81300976-8934-4449-af27-8e6d2056a3e7",
  "userGroupId": "46d8c2bb-8a23-452b-bb9f-904fe1335589",
  "deviceId": "1a4c1502-80e4-43b4-b754-a9753aa58a8d",
  "deviceGroupId": "64178ec1-fc5c-4758-a900-7bfe8812201c",
  "applicationId": "3f86d7e1-796d-4e45-9188-54392f1b268e",
  "applicationVersionId": "60f837fd-06cd-445f-ab1c-e7dcdd751649",
  "nodeId": "79d65a1e-4af2-464b-bd03-39f78a203e40",
  "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-03-22T04:46:47.6946789+00:00",
  "updatedDateUtc": "2026-03-22T04:46:47.6946789+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-03-22T04:46:47.6946789+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-22T04:46:47.6946789+00:00</UpdatedDateUtc>
  <ApplicationId>3f86d7e1-796d-4e45-9188-54392f1b268e</ApplicationId>
  <ApplicationVersionId>60f837fd-06cd-445f-ab1c-e7dcdd751649</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>64178ec1-fc5c-4758-a900-7bfe8812201c</DeviceGroupId>
  <DeviceId>1a4c1502-80e4-43b4-b754-a9753aa58a8d</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>79d65a1e-4af2-464b-bd03-39f78a203e40</NodeId>
  <NodeRouteId>2f0a0144-3d2b-4f90-a07c-d22020628b48</NodeRouteId>
  <TenantId>6547306e-a334-4201-ab05-1ae7b486ca82</TenantId>
  <UserGroupId>46d8c2bb-8a23-452b-bb9f-904fe1335589</UserGroupId>
  <UserId>81300976-8934-4449-af27-8e6d2056a3e7</UserId>
</NodeRouteRepresentation>