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": "bb31c73c-4260-4f45-99ac-b4b79ecc5af0",
  "tenantId": "1f57ea3e-04fb-4428-8ee1-3f2118249fba",
  "userId": "1fba13ef-7eda-42a3-99ae-66ed44ac92db",
  "userGroupId": "63731af9-199c-4075-9fa4-8f33c1f8774b",
  "deviceId": "d60d39c7-654e-448f-b347-d3e19fb7b627",
  "deviceGroupId": "9d7127c9-e4e9-4ee4-a1e6-51f440f61b15",
  "applicationId": "48d43708-4bb7-4a01-bc93-858d6ffd2309",
  "applicationVersionId": "ff3fb824-3134-451e-ac20-b3cf6b873aea",
  "nodeId": "3fd01e8e-5450-472d-a2fe-83f6235a9b01",
  "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-05-04T09:18:35.7287792+00:00",
  "updatedDateUtc": "2026-05-04T09:18:35.7287792+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-05-04T09:18:35.7287792+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-05-04T09:18:35.7287792+00:00</UpdatedDateUtc>
  <ApplicationId>48d43708-4bb7-4a01-bc93-858d6ffd2309</ApplicationId>
  <ApplicationVersionId>ff3fb824-3134-451e-ac20-b3cf6b873aea</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>9d7127c9-e4e9-4ee4-a1e6-51f440f61b15</DeviceGroupId>
  <DeviceId>d60d39c7-654e-448f-b347-d3e19fb7b627</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>3fd01e8e-5450-472d-a2fe-83f6235a9b01</NodeId>
  <NodeRouteId>bb31c73c-4260-4f45-99ac-b4b79ecc5af0</NodeRouteId>
  <TenantId>1f57ea3e-04fb-4428-8ee1-3f2118249fba</TenantId>
  <UserGroupId>63731af9-199c-4075-9fa4-8f33c1f8774b</UserGroupId>
  <UserId>1fba13ef-7eda-42a3-99ae-66ed44ac92db</UserId>
</NodeRouteRepresentation>