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": "03afa048-f7bc-4e31-8210-d292a16dc84a",
  "tenantId": "0c081802-be91-4583-933b-6a70ee08806b",
  "userId": "eb6c72f6-f18a-42dc-911d-231512e5466a",
  "userGroupId": "6871ccea-8042-4603-8cde-39d29aac3b5e",
  "deviceId": "3db2e05d-a89f-4a7d-8e99-116ae1c15f98",
  "deviceGroupId": "36e370fd-0d59-46dd-a804-a4706690bd06",
  "applicationId": "40c30a1c-ec96-49ee-a183-cf558654d7a8",
  "applicationVersionId": "522809b1-75a6-441a-8412-077527a937f1",
  "nodeId": "58c0678e-7aa8-4e44-b765-56760af048a0",
  "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-04T21:10:30.963946+00:00",
  "updatedDateUtc": "2026-03-04T21:10:30.963946+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-04T21:10:30.963946+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-04T21:10:30.963946+00:00</UpdatedDateUtc>
  <ApplicationId>40c30a1c-ec96-49ee-a183-cf558654d7a8</ApplicationId>
  <ApplicationVersionId>522809b1-75a6-441a-8412-077527a937f1</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>36e370fd-0d59-46dd-a804-a4706690bd06</DeviceGroupId>
  <DeviceId>3db2e05d-a89f-4a7d-8e99-116ae1c15f98</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>58c0678e-7aa8-4e44-b765-56760af048a0</NodeId>
  <NodeRouteId>03afa048-f7bc-4e31-8210-d292a16dc84a</NodeRouteId>
  <TenantId>0c081802-be91-4583-933b-6a70ee08806b</TenantId>
  <UserGroupId>6871ccea-8042-4603-8cde-39d29aac3b5e</UserGroupId>
  <UserId>eb6c72f6-f18a-42dc-911d-231512e5466a</UserId>
</NodeRouteRepresentation>