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": "8506ae79-14f5-4bbf-9982-eb5d9350a93b",
  "tenantId": "d6358892-0352-49c6-b8d4-d8a2fc015916",
  "userId": "4a37d1bd-aa8f-4bd2-9174-4ffe0c37f71a",
  "userGroupId": "dc69e7cc-fd11-4543-b176-f4f074a7d017",
  "deviceId": "cba37d13-87cd-492c-9265-9311f0202f23",
  "deviceGroupId": "9432a10e-e7fb-4c25-b7d3-8e49ecd6c618",
  "applicationId": "806e6e0b-cdaa-4b41-bfe9-66681850bb4d",
  "applicationVersionId": "64985774-763d-4580-9aa5-278391a1cb6a",
  "nodeId": "86b7ed13-2935-42c7-8e08-b8a5782fef5e",
  "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-09-08T07:19:05.2909873+00:00",
  "updatedDateUtc": "2026-09-08T07:19:05.2909873+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-09-08T07:19:05.2909873+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-08T07:19:05.2909873+00:00</UpdatedDateUtc>
  <ApplicationId>806e6e0b-cdaa-4b41-bfe9-66681850bb4d</ApplicationId>
  <ApplicationVersionId>64985774-763d-4580-9aa5-278391a1cb6a</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>9432a10e-e7fb-4c25-b7d3-8e49ecd6c618</DeviceGroupId>
  <DeviceId>cba37d13-87cd-492c-9265-9311f0202f23</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>86b7ed13-2935-42c7-8e08-b8a5782fef5e</NodeId>
  <NodeRouteId>8506ae79-14f5-4bbf-9982-eb5d9350a93b</NodeRouteId>
  <TenantId>d6358892-0352-49c6-b8d4-d8a2fc015916</TenantId>
  <UserGroupId>dc69e7cc-fd11-4543-b176-f4f074a7d017</UserGroupId>
  <UserId>4a37d1bd-aa8f-4bd2-9174-4ffe0c37f71a</UserId>
</NodeRouteRepresentation>