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": "6173689a-8ef1-47aa-9a06-0905350b34f8",
  "tenantId": "b7e2579f-f93d-4649-93c1-1587d66eea63",
  "userId": "13ff2c36-72d3-4e46-9462-9487a415515a",
  "userGroupId": "c248365d-bc4b-4597-85c3-3a532c94eec0",
  "deviceId": "ad1bc0f5-c213-46cc-b577-cc417bdf747a",
  "deviceGroupId": "127e0451-41ea-4474-a246-7fc474e8f79b",
  "applicationId": "b3ec9ba8-f347-40ca-9f54-92a44d97f984",
  "applicationVersionId": "ae8a0c60-b27d-4b98-aecd-871170340cea",
  "nodeId": "ae80a2d4-6b26-4e8d-9303-b47f8a1bcfbc",
  "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-08-02T04:10:21.0702995+00:00",
  "updatedDateUtc": "2026-08-02T04:10:21.0702995+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-08-02T04:10:21.0702995+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-02T04:10:21.0702995+00:00</UpdatedDateUtc>
  <ApplicationId>b3ec9ba8-f347-40ca-9f54-92a44d97f984</ApplicationId>
  <ApplicationVersionId>ae8a0c60-b27d-4b98-aecd-871170340cea</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>127e0451-41ea-4474-a246-7fc474e8f79b</DeviceGroupId>
  <DeviceId>ad1bc0f5-c213-46cc-b577-cc417bdf747a</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>ae80a2d4-6b26-4e8d-9303-b47f8a1bcfbc</NodeId>
  <NodeRouteId>6173689a-8ef1-47aa-9a06-0905350b34f8</NodeRouteId>
  <TenantId>b7e2579f-f93d-4649-93c1-1587d66eea63</TenantId>
  <UserGroupId>c248365d-bc4b-4597-85c3-3a532c94eec0</UserGroupId>
  <UserId>13ff2c36-72d3-4e46-9462-9487a415515a</UserId>
</NodeRouteRepresentation>