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": "31c9efec-5a95-424f-9f03-71018ea339d8",
  "tenantId": "92d7f1f7-e2d2-4ca6-a3f0-b10e95da71a3",
  "userId": "a480d707-c5dc-46fb-adb9-62a67cea8a6d",
  "userGroupId": "38e70b98-8d82-4c8b-b47c-0525d7d6dc71",
  "deviceId": "44914208-6328-444c-a120-d2aaaecbdb45",
  "deviceGroupId": "98739a35-a740-414c-90b7-e446616e3c37",
  "applicationId": "1b6f4f2a-1ea3-4b7e-8e7d-3f6396aa4051",
  "applicationVersionId": "729fb833-54cd-4400-a478-814abc157ea2",
  "nodeId": "da5063fb-53a4-4c49-87e0-ceedaafa662c",
  "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-01-09T11:08:14.197071+00:00",
  "updatedDateUtc": "2026-01-09T11:08:14.197071+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-01-09T11:08:14.197071+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-01-09T11:08:14.197071+00:00</UpdatedDateUtc>
  <ApplicationId>1b6f4f2a-1ea3-4b7e-8e7d-3f6396aa4051</ApplicationId>
  <ApplicationVersionId>729fb833-54cd-4400-a478-814abc157ea2</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>98739a35-a740-414c-90b7-e446616e3c37</DeviceGroupId>
  <DeviceId>44914208-6328-444c-a120-d2aaaecbdb45</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>da5063fb-53a4-4c49-87e0-ceedaafa662c</NodeId>
  <NodeRouteId>31c9efec-5a95-424f-9f03-71018ea339d8</NodeRouteId>
  <TenantId>92d7f1f7-e2d2-4ca6-a3f0-b10e95da71a3</TenantId>
  <UserGroupId>38e70b98-8d82-4c8b-b47c-0525d7d6dc71</UserGroupId>
  <UserId>a480d707-c5dc-46fb-adb9-62a67cea8a6d</UserId>
</NodeRouteRepresentation>