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": "fadf3ab3-3f80-46ac-b1b1-666e0501a873",
  "tenantId": "bac02b1f-b502-4755-917b-9fdb78508278",
  "userId": "95bcf787-64c5-4195-87c4-fc6323e1a6ea",
  "userGroupId": "2b6aed83-fd60-4bb1-9583-2f5e7a0cfd8d",
  "deviceId": "2ac5c487-b782-4e38-a079-0f95652f21f7",
  "deviceGroupId": "4d834f55-5423-4ee5-8315-79e0a9e12678",
  "applicationId": "2891bdef-0fea-42ad-ac48-dd3a949200d5",
  "applicationVersionId": "6727146e-e530-4cc7-8e32-b1c4c6a4238c",
  "nodeId": "b4d454aa-a96f-482a-bc7b-585512738e79",
  "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-06-08T15:31:55.166407+00:00",
  "updatedDateUtc": "2026-06-08T15:31:55.166407+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-06-08T15:31:55.166407+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-08T15:31:55.166407+00:00</UpdatedDateUtc>
  <ApplicationId>2891bdef-0fea-42ad-ac48-dd3a949200d5</ApplicationId>
  <ApplicationVersionId>6727146e-e530-4cc7-8e32-b1c4c6a4238c</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>4d834f55-5423-4ee5-8315-79e0a9e12678</DeviceGroupId>
  <DeviceId>2ac5c487-b782-4e38-a079-0f95652f21f7</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>b4d454aa-a96f-482a-bc7b-585512738e79</NodeId>
  <NodeRouteId>fadf3ab3-3f80-46ac-b1b1-666e0501a873</NodeRouteId>
  <TenantId>bac02b1f-b502-4755-917b-9fdb78508278</TenantId>
  <UserGroupId>2b6aed83-fd60-4bb1-9583-2f5e7a0cfd8d</UserGroupId>
  <UserId>95bcf787-64c5-4195-87c4-fc6323e1a6ea</UserId>
</NodeRouteRepresentation>