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": "34bbdc26-1d83-452e-9be7-0b52b106cc69",
  "tenantId": "aa8332af-0ff6-40d8-af9f-75404d24a72a",
  "userId": "497749fd-372e-434d-8146-200ff77773a7",
  "userGroupId": "9cb99dd4-1f97-4300-a35a-6f7ee7642af6",
  "deviceId": "abcf6e78-3c64-4496-9e3c-e4b3c374541d",
  "deviceGroupId": "edbd95a0-154c-41bb-bcff-5077dd931f59",
  "applicationId": "724bc097-11f4-4886-8ed2-798e7c921ebf",
  "applicationVersionId": "530a5d8e-5448-4814-bdc8-81e7b0f82295",
  "nodeId": "0a17862c-b014-4e63-a8c9-dc31189f2674",
  "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-07-21T02:29:47.6805564+00:00",
  "updatedDateUtc": "2026-07-21T02:29:47.6805564+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-07-21T02:29:47.6805564+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-07-21T02:29:47.6805564+00:00</UpdatedDateUtc>
  <ApplicationId>724bc097-11f4-4886-8ed2-798e7c921ebf</ApplicationId>
  <ApplicationVersionId>530a5d8e-5448-4814-bdc8-81e7b0f82295</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>edbd95a0-154c-41bb-bcff-5077dd931f59</DeviceGroupId>
  <DeviceId>abcf6e78-3c64-4496-9e3c-e4b3c374541d</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>0a17862c-b014-4e63-a8c9-dc31189f2674</NodeId>
  <NodeRouteId>34bbdc26-1d83-452e-9be7-0b52b106cc69</NodeRouteId>
  <TenantId>aa8332af-0ff6-40d8-af9f-75404d24a72a</TenantId>
  <UserGroupId>9cb99dd4-1f97-4300-a35a-6f7ee7642af6</UserGroupId>
  <UserId>497749fd-372e-434d-8146-200ff77773a7</UserId>
</NodeRouteRepresentation>