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": "c310ae91-ef91-49d8-a98c-32dc1c0b2573",
  "tenantId": "c56c4f31-95fb-40e7-84b2-3b1280abfa3f",
  "userId": "a20d8226-b547-40c9-9478-b73bfcd3bbad",
  "userGroupId": "1da5b595-e397-4f6d-98d8-63e8087f3f37",
  "deviceId": "650871cb-67ce-49cf-84ef-dc5403e7f8c0",
  "deviceGroupId": "f51cdc6e-0776-49e3-8c77-e6bca7709879",
  "applicationId": "6eadd437-c8d9-435f-9a07-30e3b1a40eed",
  "applicationVersionId": "57c3c560-5f0b-4c1b-8f24-3b63920e0f0f",
  "nodeId": "8584e1a0-7e56-43fa-91a9-2ddce751ea69",
  "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-04-11T18:39:10.4197482+00:00",
  "updatedDateUtc": "2026-04-11T18:39:10.4197482+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-04-11T18:39:10.4197482+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-11T18:39:10.4197482+00:00</UpdatedDateUtc>
  <ApplicationId>6eadd437-c8d9-435f-9a07-30e3b1a40eed</ApplicationId>
  <ApplicationVersionId>57c3c560-5f0b-4c1b-8f24-3b63920e0f0f</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>f51cdc6e-0776-49e3-8c77-e6bca7709879</DeviceGroupId>
  <DeviceId>650871cb-67ce-49cf-84ef-dc5403e7f8c0</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>8584e1a0-7e56-43fa-91a9-2ddce751ea69</NodeId>
  <NodeRouteId>c310ae91-ef91-49d8-a98c-32dc1c0b2573</NodeRouteId>
  <TenantId>c56c4f31-95fb-40e7-84b2-3b1280abfa3f</TenantId>
  <UserGroupId>1da5b595-e397-4f6d-98d8-63e8087f3f37</UserGroupId>
  <UserId>a20d8226-b547-40c9-9478-b73bfcd3bbad</UserId>
</NodeRouteRepresentation>