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": "8657c406-36e1-494a-8586-8826ea38ec81",
  "tenantId": "c977955f-8fd5-4369-964e-8bb65963e290",
  "userId": "54b10e21-cd38-441b-9923-5df2fcba0d3d",
  "userGroupId": "7a2a5be1-08cf-4f2e-ac7a-c9065667c004",
  "deviceId": "f80a2433-e17f-4368-a0b7-e3dd97e5d7cb",
  "deviceGroupId": "53af8167-0c60-4487-87ab-b0b4aa884e09",
  "applicationId": "db1d3794-55b5-4d70-b905-ae3e00084bef",
  "applicationVersionId": "439f3841-f3ca-4c5c-95af-f227775b6539",
  "nodeId": "8bfd59ca-7db6-4c21-a6bd-ff9abfde016b",
  "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-11-16T19:55:45.1436307+00:00",
  "updatedDateUtc": "2025-11-16T19:55:45.1436307+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-11-16T19:55:45.1436307+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-16T19:55:45.1436307+00:00</UpdatedDateUtc>
  <ApplicationId>db1d3794-55b5-4d70-b905-ae3e00084bef</ApplicationId>
  <ApplicationVersionId>439f3841-f3ca-4c5c-95af-f227775b6539</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>53af8167-0c60-4487-87ab-b0b4aa884e09</DeviceGroupId>
  <DeviceId>f80a2433-e17f-4368-a0b7-e3dd97e5d7cb</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>8bfd59ca-7db6-4c21-a6bd-ff9abfde016b</NodeId>
  <NodeRouteId>8657c406-36e1-494a-8586-8826ea38ec81</NodeRouteId>
  <TenantId>c977955f-8fd5-4369-964e-8bb65963e290</TenantId>
  <UserGroupId>7a2a5be1-08cf-4f2e-ac7a-c9065667c004</UserGroupId>
  <UserId>54b10e21-cd38-441b-9923-5df2fcba0d3d</UserId>
</NodeRouteRepresentation>