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": "ff03d116-1614-44e1-8ad5-e37a356d6c86",
  "tenantId": "5029a624-932c-4ef0-9110-4794a3bd1652",
  "userId": "936eac20-97fe-43d3-be3b-4956e3314a48",
  "userGroupId": "d43be835-a3de-4b32-9675-87a41c4e6a62",
  "deviceId": "883d8704-c620-49d8-9a94-5ac3c936e262",
  "deviceGroupId": "c814906c-11f3-493f-aabe-ead6f14c0c56",
  "applicationId": "25fa7050-8472-4e75-805f-b92e14bc27c2",
  "applicationVersionId": "f8cfcacb-3166-46e5-9aac-63e2ea8967a1",
  "nodeId": "1e13f52b-fea7-44d2-993f-24060f1aa603",
  "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-29T16:32:32.8493917+00:00",
  "updatedDateUtc": "2026-06-29T16:32:32.8493917+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-29T16:32:32.8493917+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-29T16:32:32.8493917+00:00</UpdatedDateUtc>
  <ApplicationId>25fa7050-8472-4e75-805f-b92e14bc27c2</ApplicationId>
  <ApplicationVersionId>f8cfcacb-3166-46e5-9aac-63e2ea8967a1</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>c814906c-11f3-493f-aabe-ead6f14c0c56</DeviceGroupId>
  <DeviceId>883d8704-c620-49d8-9a94-5ac3c936e262</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>1e13f52b-fea7-44d2-993f-24060f1aa603</NodeId>
  <NodeRouteId>ff03d116-1614-44e1-8ad5-e37a356d6c86</NodeRouteId>
  <TenantId>5029a624-932c-4ef0-9110-4794a3bd1652</TenantId>
  <UserGroupId>d43be835-a3de-4b32-9675-87a41c4e6a62</UserGroupId>
  <UserId>936eac20-97fe-43d3-be3b-4956e3314a48</UserId>
</NodeRouteRepresentation>