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": "e60d0546-8678-4a9f-b104-c7c61e76f357",
  "tenantId": "3e0f5e68-8476-4c39-baa8-9b9da3889447",
  "userId": "f0bf45df-feb9-43e7-b899-003b854f31a8",
  "userGroupId": "bc3bec10-8920-4cc7-90bf-a9ac9053f92c",
  "deviceId": "dee4635a-60e2-481a-a734-82e34d55c798",
  "deviceGroupId": "ee61ee26-0f29-41c4-9220-5c1a92c8dc5e",
  "applicationId": "5cea26a7-9d25-4635-a11c-dba457a5a3cd",
  "applicationVersionId": "ef465fec-001e-4e4e-b9d7-de7da3734460",
  "nodeId": "3ec49bff-218e-4f83-a6fb-9f1e74c9bb95",
  "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-04-03T03:56:54.5964328+00:00",
  "updatedDateUtc": "2026-04-03T03:56:54.5964328+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-04-03T03:56:54.5964328+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-03T03:56:54.5964328+00:00</UpdatedDateUtc>
  <ApplicationId>5cea26a7-9d25-4635-a11c-dba457a5a3cd</ApplicationId>
  <ApplicationVersionId>ef465fec-001e-4e4e-b9d7-de7da3734460</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>ee61ee26-0f29-41c4-9220-5c1a92c8dc5e</DeviceGroupId>
  <DeviceId>dee4635a-60e2-481a-a734-82e34d55c798</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>3ec49bff-218e-4f83-a6fb-9f1e74c9bb95</NodeId>
  <NodeRouteId>e60d0546-8678-4a9f-b104-c7c61e76f357</NodeRouteId>
  <TenantId>3e0f5e68-8476-4c39-baa8-9b9da3889447</TenantId>
  <UserGroupId>bc3bec10-8920-4cc7-90bf-a9ac9053f92c</UserGroupId>
  <UserId>f0bf45df-feb9-43e7-b899-003b854f31a8</UserId>
</NodeRouteRepresentation>