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": "f9e63cb8-dc92-4870-ac2d-6868d56686d3",
  "tenantId": "2275783a-03dd-4fcb-a015-4cf04c53c251",
  "userId": "3afd6a77-a8c3-4709-88b3-e0a178b310ba",
  "userGroupId": "b68b81ca-2ece-40a0-8ac8-00d9bfbc8c34",
  "deviceId": "8c433a44-7acb-41d1-a007-a6d8c7d1d7f1",
  "deviceGroupId": "1f83df68-e229-4b03-8d7c-2ddf9857c7b0",
  "applicationId": "3dd852bc-fdd8-49f3-a641-8de86d66ab29",
  "applicationVersionId": "47231f72-98b2-4b4b-84be-95c370c3bfca",
  "nodeId": "f833ea01-3f79-49e6-9b52-d49e3268d47f",
  "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": "2025-12-18T10:24:30.2883419+00:00",
  "updatedDateUtc": "2025-12-18T10:24:30.2883419+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>2025-12-18T10:24:30.2883419+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-18T10:24:30.2883419+00:00</UpdatedDateUtc>
  <ApplicationId>3dd852bc-fdd8-49f3-a641-8de86d66ab29</ApplicationId>
  <ApplicationVersionId>47231f72-98b2-4b4b-84be-95c370c3bfca</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>1f83df68-e229-4b03-8d7c-2ddf9857c7b0</DeviceGroupId>
  <DeviceId>8c433a44-7acb-41d1-a007-a6d8c7d1d7f1</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>f833ea01-3f79-49e6-9b52-d49e3268d47f</NodeId>
  <NodeRouteId>f9e63cb8-dc92-4870-ac2d-6868d56686d3</NodeRouteId>
  <TenantId>2275783a-03dd-4fcb-a015-4cf04c53c251</TenantId>
  <UserGroupId>b68b81ca-2ece-40a0-8ac8-00d9bfbc8c34</UserGroupId>
  <UserId>3afd6a77-a8c3-4709-88b3-e0a178b310ba</UserId>
</NodeRouteRepresentation>