Cyan Web API - Version 1

GET api/nodeRoutes/{nodeRouteId}

            Gets a NodeRoute by NodeRouteId

Request Information

Parameters

Name	Description	Additional information
nodeRouteId		Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "nodeRouteId": "cd305169-7a65-4d96-8c44-79d03b3643a3",
  "tenantId": "8dd7dca8-40d0-47d4-86e5-c01e96b62b72",
  "userId": "bc13922a-3bbd-4751-9212-47fdc0778661",
  "userGroupId": "ea27b507-77b6-4d23-909a-bd82807e60f4",
  "deviceId": "121240a3-cde2-4267-bc70-c0d3434c24a6",
  "deviceGroupId": "4370c141-d174-4af2-9216-efcb4b473d85",
  "applicationId": "bf50b46a-3cfe-4964-aaca-e7c45b32b57d",
  "applicationVersionId": "5332589e-9cc9-494c-992f-de450d6d71aa",
  "nodeId": "42152246-99e3-4f49-9ae3-da9f8037ffa0",
  "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-11-29T06:25:09.5045584+00:00",
  "updatedDateUtc": "2025-11-29T06:25:09.5045584+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-11-29T06:25:09.5045584+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-29T06:25:09.5045584+00:00</UpdatedDateUtc>
  <ApplicationId>bf50b46a-3cfe-4964-aaca-e7c45b32b57d</ApplicationId>
  <ApplicationVersionId>5332589e-9cc9-494c-992f-de450d6d71aa</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>4370c141-d174-4af2-9216-efcb4b473d85</DeviceGroupId>
  <DeviceId>121240a3-cde2-4267-bc70-c0d3434c24a6</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>42152246-99e3-4f49-9ae3-da9f8037ffa0</NodeId>
  <NodeRouteId>cd305169-7a65-4d96-8c44-79d03b3643a3</NodeRouteId>
  <TenantId>8dd7dca8-40d0-47d4-86e5-c01e96b62b72</TenantId>
  <UserGroupId>ea27b507-77b6-4d23-909a-bd82807e60f4</UserGroupId>
  <UserId>bc13922a-3bbd-4751-9212-47fdc0778661</UserId>
</NodeRouteRepresentation>