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": "f487c092-757b-4790-bcf1-8de2ed1742a1",
  "tenantId": "7d215ae5-d7ba-4dca-973e-71057f9be377",
  "userId": "597e375b-5760-459d-ab4b-b728c4dfe80f",
  "userGroupId": "4578d02a-cc04-4f8e-9f8a-9c53d66ac68d",
  "deviceId": "a95f9e27-2a92-4ea8-94d9-f7b0fd940d23",
  "deviceGroupId": "28fda675-885d-4409-b34b-d53337f41b77",
  "applicationId": "4122a8ab-110b-4b99-ae34-b02206ad27a5",
  "applicationVersionId": "ae9a4355-1e70-4db9-b791-209536350827",
  "nodeId": "0e7958d4-e2d2-41a5-b60b-5a4adaff7615",
  "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-22T09:15:44.880559+00:00",
  "updatedDateUtc": "2026-05-22T09:15:44.880559+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-22T09:15:44.880559+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-05-22T09:15:44.880559+00:00</UpdatedDateUtc>
  <ApplicationId>4122a8ab-110b-4b99-ae34-b02206ad27a5</ApplicationId>
  <ApplicationVersionId>ae9a4355-1e70-4db9-b791-209536350827</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>28fda675-885d-4409-b34b-d53337f41b77</DeviceGroupId>
  <DeviceId>a95f9e27-2a92-4ea8-94d9-f7b0fd940d23</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>0e7958d4-e2d2-41a5-b60b-5a4adaff7615</NodeId>
  <NodeRouteId>f487c092-757b-4790-bcf1-8de2ed1742a1</NodeRouteId>
  <TenantId>7d215ae5-d7ba-4dca-973e-71057f9be377</TenantId>
  <UserGroupId>4578d02a-cc04-4f8e-9f8a-9c53d66ac68d</UserGroupId>
  <UserId>597e375b-5760-459d-ab4b-b728c4dfe80f</UserId>
</NodeRouteRepresentation>