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": "12c65f04-d8cb-45fb-92b6-09da27c7d234",
  "tenantId": "298a86f6-c7cb-4aeb-bba5-25cc5a88bda9",
  "userId": "2a5e1da0-7e65-434d-9ab2-2aa568c4fe81",
  "userGroupId": "0cd76a50-a065-44cc-af42-b25e0a1f617c",
  "deviceId": "51000293-a69c-4d1e-8739-1b5ffae40d43",
  "deviceGroupId": "dd68669e-b590-4016-a9d8-0a1461adb00c",
  "applicationId": "2a13a774-5e9e-484e-9ef9-2023bf09ad7f",
  "applicationVersionId": "50b03e34-1c6b-4281-bc51-1b6a9709f8df",
  "nodeId": "155c7618-a85f-42b6-b79b-6b763364bc90",
  "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-04T17:47:20.7897406+00:00",
  "updatedDateUtc": "2026-06-04T17:47:20.7897406+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-04T17:47:20.7897406+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-04T17:47:20.7897406+00:00</UpdatedDateUtc>
  <ApplicationId>2a13a774-5e9e-484e-9ef9-2023bf09ad7f</ApplicationId>
  <ApplicationVersionId>50b03e34-1c6b-4281-bc51-1b6a9709f8df</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>dd68669e-b590-4016-a9d8-0a1461adb00c</DeviceGroupId>
  <DeviceId>51000293-a69c-4d1e-8739-1b5ffae40d43</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>155c7618-a85f-42b6-b79b-6b763364bc90</NodeId>
  <NodeRouteId>12c65f04-d8cb-45fb-92b6-09da27c7d234</NodeRouteId>
  <TenantId>298a86f6-c7cb-4aeb-bba5-25cc5a88bda9</TenantId>
  <UserGroupId>0cd76a50-a065-44cc-af42-b25e0a1f617c</UserGroupId>
  <UserId>2a5e1da0-7e65-434d-9ab2-2aa568c4fe81</UserId>
</NodeRouteRepresentation>