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": "d5d412e2-70b9-4aad-9a9e-142b6838fa4a",
  "tenantId": "34e06f81-db42-4937-a1ac-814c0e6aa714",
  "userId": "f800bfbd-8691-455c-98ea-db6631cc4752",
  "userGroupId": "664bb586-4c23-47da-8c08-277bac3a279f",
  "deviceId": "9a6214d8-d498-4048-96d9-03b477ca3559",
  "deviceGroupId": "b9f37897-a824-4713-b8e8-d3b7c1543c72",
  "applicationId": "d9e2b629-b76b-42e0-915e-ab2516ec7365",
  "applicationVersionId": "c06fb5e9-4b9d-4a1a-a751-18aa14b37a60",
  "nodeId": "d9e2537a-eb64-4e62-aa17-f3ca20bb856f",
  "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-08T04:02:30.6774053+00:00",
  "updatedDateUtc": "2026-06-08T04:02:30.6774053+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-08T04:02:30.6774053+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-08T04:02:30.6774053+00:00</UpdatedDateUtc>
  <ApplicationId>d9e2b629-b76b-42e0-915e-ab2516ec7365</ApplicationId>
  <ApplicationVersionId>c06fb5e9-4b9d-4a1a-a751-18aa14b37a60</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>b9f37897-a824-4713-b8e8-d3b7c1543c72</DeviceGroupId>
  <DeviceId>9a6214d8-d498-4048-96d9-03b477ca3559</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>d9e2537a-eb64-4e62-aa17-f3ca20bb856f</NodeId>
  <NodeRouteId>d5d412e2-70b9-4aad-9a9e-142b6838fa4a</NodeRouteId>
  <TenantId>34e06f81-db42-4937-a1ac-814c0e6aa714</TenantId>
  <UserGroupId>664bb586-4c23-47da-8c08-277bac3a279f</UserGroupId>
  <UserId>f800bfbd-8691-455c-98ea-db6631cc4752</UserId>
</NodeRouteRepresentation>