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": "a0473eb5-d145-4fd6-8f32-742220d7a91b",
  "tenantId": "9625312a-5c11-4a8e-9ed5-b3735291b6a5",
  "userId": "1a48410c-e15b-41fc-8d34-754f7d37bf2b",
  "userGroupId": "965bc618-4fc4-49d7-9d51-e745ba367d0d",
  "deviceId": "2aa303a2-c247-4bd8-96f1-1848bdf15c42",
  "deviceGroupId": "461029c7-c48b-4fd8-bbdc-0dc8df79464f",
  "applicationId": "55d30d36-0c22-4d6c-9f4f-292a54bc8073",
  "applicationVersionId": "d7faf725-77dc-408c-a76a-89e144893ab9",
  "nodeId": "89cbfeee-cfee-4842-9c69-ef5fe66f1db2",
  "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-08T22:46:51.0720184+00:00",
  "updatedDateUtc": "2026-06-08T22:46:51.0720184+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-08T22:46:51.0720184+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-08T22:46:51.0720184+00:00</UpdatedDateUtc>
  <ApplicationId>55d30d36-0c22-4d6c-9f4f-292a54bc8073</ApplicationId>
  <ApplicationVersionId>d7faf725-77dc-408c-a76a-89e144893ab9</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>461029c7-c48b-4fd8-bbdc-0dc8df79464f</DeviceGroupId>
  <DeviceId>2aa303a2-c247-4bd8-96f1-1848bdf15c42</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>89cbfeee-cfee-4842-9c69-ef5fe66f1db2</NodeId>
  <NodeRouteId>a0473eb5-d145-4fd6-8f32-742220d7a91b</NodeRouteId>
  <TenantId>9625312a-5c11-4a8e-9ed5-b3735291b6a5</TenantId>
  <UserGroupId>965bc618-4fc4-49d7-9d51-e745ba367d0d</UserGroupId>
  <UserId>1a48410c-e15b-41fc-8d34-754f7d37bf2b</UserId>
</NodeRouteRepresentation>