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": "667ce93f-21c7-40c0-85fa-2d72dacfbecd",
  "tenantId": "cf84a867-1295-490b-b43b-3bb98a2e8395",
  "userId": "2c899890-a61f-45ab-86d0-e5dfa74bc7f8",
  "userGroupId": "9a4ad2d8-52fc-4825-9085-f8307fa03b2d",
  "deviceId": "2f1a1b03-ba23-4416-8832-c50ceedf7bb6",
  "deviceGroupId": "aa01a934-470e-4f75-84d2-ae4199b7d8b2",
  "applicationId": "6e4be009-d887-43d4-a02d-2d6e0aeb7be3",
  "applicationVersionId": "ebbc5e79-b987-4dce-815d-86d2f4f0b18e",
  "nodeId": "012703f6-0011-4c20-ac87-624c4572d9db",
  "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": "2025-11-22T07:05:01.8351184+00:00",
  "updatedDateUtc": "2025-11-22T07:05:01.8351184+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>2025-11-22T07:05:01.8351184+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-22T07:05:01.8351184+00:00</UpdatedDateUtc>
  <ApplicationId>6e4be009-d887-43d4-a02d-2d6e0aeb7be3</ApplicationId>
  <ApplicationVersionId>ebbc5e79-b987-4dce-815d-86d2f4f0b18e</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>aa01a934-470e-4f75-84d2-ae4199b7d8b2</DeviceGroupId>
  <DeviceId>2f1a1b03-ba23-4416-8832-c50ceedf7bb6</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>012703f6-0011-4c20-ac87-624c4572d9db</NodeId>
  <NodeRouteId>667ce93f-21c7-40c0-85fa-2d72dacfbecd</NodeRouteId>
  <TenantId>cf84a867-1295-490b-b43b-3bb98a2e8395</TenantId>
  <UserGroupId>9a4ad2d8-52fc-4825-9085-f8307fa03b2d</UserGroupId>
  <UserId>2c899890-a61f-45ab-86d0-e5dfa74bc7f8</UserId>
</NodeRouteRepresentation>