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": "78282253-07fd-4377-b243-ac0964dd4783",
  "tenantId": "112b1200-6cd1-4bef-8cb6-322bb62316dd",
  "userId": "ce364538-daab-4e67-9447-0f468b749d8c",
  "userGroupId": "b5f95fa4-10c5-4dcc-a045-51fa81ed4092",
  "deviceId": "f73be232-32d0-4270-b99d-979b6d61f5b9",
  "deviceGroupId": "4131acb7-a3d9-4c12-901d-5f64333f2fdb",
  "applicationId": "810c3fb5-221f-4bfb-a72c-f1054d5de18a",
  "applicationVersionId": "e0a36f18-91f7-4bc3-994c-e1d2242968fc",
  "nodeId": "2b70414a-6982-4ada-88b1-30f2b7fc2aad",
  "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-22T16:38:26.5233329+00:00",
  "updatedDateUtc": "2026-06-22T16:38:26.5233329+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-22T16:38:26.5233329+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-22T16:38:26.5233329+00:00</UpdatedDateUtc>
  <ApplicationId>810c3fb5-221f-4bfb-a72c-f1054d5de18a</ApplicationId>
  <ApplicationVersionId>e0a36f18-91f7-4bc3-994c-e1d2242968fc</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>4131acb7-a3d9-4c12-901d-5f64333f2fdb</DeviceGroupId>
  <DeviceId>f73be232-32d0-4270-b99d-979b6d61f5b9</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>2b70414a-6982-4ada-88b1-30f2b7fc2aad</NodeId>
  <NodeRouteId>78282253-07fd-4377-b243-ac0964dd4783</NodeRouteId>
  <TenantId>112b1200-6cd1-4bef-8cb6-322bb62316dd</TenantId>
  <UserGroupId>b5f95fa4-10c5-4dcc-a045-51fa81ed4092</UserGroupId>
  <UserId>ce364538-daab-4e67-9447-0f468b749d8c</UserId>
</NodeRouteRepresentation>