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": "fc7717a3-801b-495c-9fd8-a563eb5087ed",
  "tenantId": "c03e9b7b-3ea1-4170-b27e-b7a75558ebad",
  "userId": "7f051c81-9dd4-49ff-abd0-591ddee01db0",
  "userGroupId": "4e12aa07-fafa-466b-aa59-3a54a41adbcb",
  "deviceId": "96452e0b-552e-4078-9c87-3412825b7d5e",
  "deviceGroupId": "0c5fda57-61cb-4c0a-8a8e-90ac6df7c9c3",
  "applicationId": "6bf183a4-c76d-484e-9ac4-1457ffcfa755",
  "applicationVersionId": "54f1f181-17bb-40f7-acd4-ec30c249acee",
  "nodeId": "2de28de9-00c0-490a-889a-5204bf6974ad",
  "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": "2025-12-23T18:21:43.7931467+00:00",
  "updatedDateUtc": "2025-12-23T18:21:43.7931467+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>2025-12-23T18:21:43.7931467+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-23T18:21:43.7931467+00:00</UpdatedDateUtc>
  <ApplicationId>6bf183a4-c76d-484e-9ac4-1457ffcfa755</ApplicationId>
  <ApplicationVersionId>54f1f181-17bb-40f7-acd4-ec30c249acee</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>0c5fda57-61cb-4c0a-8a8e-90ac6df7c9c3</DeviceGroupId>
  <DeviceId>96452e0b-552e-4078-9c87-3412825b7d5e</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>2de28de9-00c0-490a-889a-5204bf6974ad</NodeId>
  <NodeRouteId>fc7717a3-801b-495c-9fd8-a563eb5087ed</NodeRouteId>
  <TenantId>c03e9b7b-3ea1-4170-b27e-b7a75558ebad</TenantId>
  <UserGroupId>4e12aa07-fafa-466b-aa59-3a54a41adbcb</UserGroupId>
  <UserId>7f051c81-9dd4-49ff-abd0-591ddee01db0</UserId>
</NodeRouteRepresentation>