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": "43cb9705-c366-4b47-a023-d1eb6a2eab7f",
  "tenantId": "07b75ccc-4cac-4888-9b88-eb050cb1fa25",
  "userId": "8ae8a2ee-2a12-485e-8868-f32edc064a40",
  "userGroupId": "15c9c2f6-dbf9-480f-9f1a-adf11c2f10d9",
  "deviceId": "0d151abc-de23-4d11-91a5-71da14428ba7",
  "deviceGroupId": "4bbfe9df-c3ef-46e3-82e1-cca1708f9bc0",
  "applicationId": "a7eaaef9-5a17-41da-9e3a-2a737ff28416",
  "applicationVersionId": "3cbd0350-4353-40ba-b331-f85855d68c26",
  "nodeId": "de87e91d-c680-4907-b808-65df6f4556de",
  "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-27T04:31:49.0947123+00:00",
  "updatedDateUtc": "2026-08-27T04:31:49.0947123+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-27T04:31:49.0947123+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-27T04:31:49.0947123+00:00</UpdatedDateUtc>
  <ApplicationId>a7eaaef9-5a17-41da-9e3a-2a737ff28416</ApplicationId>
  <ApplicationVersionId>3cbd0350-4353-40ba-b331-f85855d68c26</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>4bbfe9df-c3ef-46e3-82e1-cca1708f9bc0</DeviceGroupId>
  <DeviceId>0d151abc-de23-4d11-91a5-71da14428ba7</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>de87e91d-c680-4907-b808-65df6f4556de</NodeId>
  <NodeRouteId>43cb9705-c366-4b47-a023-d1eb6a2eab7f</NodeRouteId>
  <TenantId>07b75ccc-4cac-4888-9b88-eb050cb1fa25</TenantId>
  <UserGroupId>15c9c2f6-dbf9-480f-9f1a-adf11c2f10d9</UserGroupId>
  <UserId>8ae8a2ee-2a12-485e-8868-f32edc064a40</UserId>
</NodeRouteRepresentation>