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": "e5891e81-bd5d-4c24-864a-9bdee625a99b",
  "tenantId": "666c3681-f629-4700-b983-97d211476c20",
  "userId": "4f3fea4e-5dda-4914-9077-0a4fceee2e6b",
  "userGroupId": "47dd1aa9-1bde-4336-b722-49d50e8bb48c",
  "deviceId": "5b3f982d-ef2e-4bca-a61e-2d6a380d2f79",
  "deviceGroupId": "41ed3921-9daf-4c97-bab1-a633ef7eaa9c",
  "applicationId": "310fc4b3-0928-4aa1-8fef-06ae7026a591",
  "applicationVersionId": "3bbf5ed3-94a6-4387-bb7b-76ded0814cf3",
  "nodeId": "32311b77-8630-4a8c-9ceb-51691022c814",
  "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-03-09T14:04:16.7080554+00:00",
  "updatedDateUtc": "2026-03-09T14:04:16.7080554+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-03-09T14:04:16.7080554+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-09T14:04:16.7080554+00:00</UpdatedDateUtc>
  <ApplicationId>310fc4b3-0928-4aa1-8fef-06ae7026a591</ApplicationId>
  <ApplicationVersionId>3bbf5ed3-94a6-4387-bb7b-76ded0814cf3</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>41ed3921-9daf-4c97-bab1-a633ef7eaa9c</DeviceGroupId>
  <DeviceId>5b3f982d-ef2e-4bca-a61e-2d6a380d2f79</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>32311b77-8630-4a8c-9ceb-51691022c814</NodeId>
  <NodeRouteId>e5891e81-bd5d-4c24-864a-9bdee625a99b</NodeRouteId>
  <TenantId>666c3681-f629-4700-b983-97d211476c20</TenantId>
  <UserGroupId>47dd1aa9-1bde-4336-b722-49d50e8bb48c</UserGroupId>
  <UserId>4f3fea4e-5dda-4914-9077-0a4fceee2e6b</UserId>
</NodeRouteRepresentation>