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": "6018d3ec-250f-409b-8da8-8a2ea79cbc9e",
  "tenantId": "7472a5c4-0b93-440f-bba1-8305385dec70",
  "userId": "a3b5b703-03a6-4fe4-8284-8f473b571b84",
  "userGroupId": "36c46b7a-167e-4b36-bcdb-f830e902546d",
  "deviceId": "5162d50b-5658-44f4-ac74-e26d1a29709c",
  "deviceGroupId": "8ce8aa7e-d71f-4c58-989d-79f52ebbe1d9",
  "applicationId": "b11aa4bb-1ed5-481e-8732-e7317838cc3f",
  "applicationVersionId": "2c9e3728-cdca-425d-bf34-ce221aad8d23",
  "nodeId": "b52cf7de-7c6d-4c34-9044-b6f84ffee738",
  "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-10-06T11:17:37.1803106+00:00",
  "updatedDateUtc": "2026-10-06T11:17:37.1803106+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-10-06T11:17:37.1803106+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-10-06T11:17:37.1803106+00:00</UpdatedDateUtc>
  <ApplicationId>b11aa4bb-1ed5-481e-8732-e7317838cc3f</ApplicationId>
  <ApplicationVersionId>2c9e3728-cdca-425d-bf34-ce221aad8d23</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>8ce8aa7e-d71f-4c58-989d-79f52ebbe1d9</DeviceGroupId>
  <DeviceId>5162d50b-5658-44f4-ac74-e26d1a29709c</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>b52cf7de-7c6d-4c34-9044-b6f84ffee738</NodeId>
  <NodeRouteId>6018d3ec-250f-409b-8da8-8a2ea79cbc9e</NodeRouteId>
  <TenantId>7472a5c4-0b93-440f-bba1-8305385dec70</TenantId>
  <UserGroupId>36c46b7a-167e-4b36-bcdb-f830e902546d</UserGroupId>
  <UserId>a3b5b703-03a6-4fe4-8284-8f473b571b84</UserId>
</NodeRouteRepresentation>