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": "f9f4a79e-d404-4978-bb36-f7f220a26d5b",
  "tenantId": "cbe75c06-febc-48a6-8237-0d2dd7e24a75",
  "userId": "4c8a7c14-faf1-4431-9104-8dfc0d303bd7",
  "userGroupId": "da8ddce0-ab90-4d34-9bf2-c2595e811850",
  "deviceId": "7378d588-8529-4f83-b252-d9a4d90572af",
  "deviceGroupId": "be176508-f6d7-4342-b4ee-e5aaf424d2dc",
  "applicationId": "01d7c6ab-685c-445f-8749-ed0f0186c08d",
  "applicationVersionId": "ea39a1ab-f96c-4a58-aa19-8eb308594c20",
  "nodeId": "a40ec07e-ed78-4859-8af5-4ff31d3ccfcd",
  "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-02-04T01:51:08.9454387+00:00",
  "updatedDateUtc": "2026-02-04T01:51:08.9454387+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-02-04T01:51:08.9454387+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-04T01:51:08.9454387+00:00</UpdatedDateUtc>
  <ApplicationId>01d7c6ab-685c-445f-8749-ed0f0186c08d</ApplicationId>
  <ApplicationVersionId>ea39a1ab-f96c-4a58-aa19-8eb308594c20</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>be176508-f6d7-4342-b4ee-e5aaf424d2dc</DeviceGroupId>
  <DeviceId>7378d588-8529-4f83-b252-d9a4d90572af</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>a40ec07e-ed78-4859-8af5-4ff31d3ccfcd</NodeId>
  <NodeRouteId>f9f4a79e-d404-4978-bb36-f7f220a26d5b</NodeRouteId>
  <TenantId>cbe75c06-febc-48a6-8237-0d2dd7e24a75</TenantId>
  <UserGroupId>da8ddce0-ab90-4d34-9bf2-c2595e811850</UserGroupId>
  <UserId>4c8a7c14-faf1-4431-9104-8dfc0d303bd7</UserId>
</NodeRouteRepresentation>