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": "79a9dc22-cd0f-4596-b707-da7000744620",
  "tenantId": "a32e0cd9-2a24-44e6-8ae7-d0aae822efe1",
  "userId": "cd1975fc-6ac8-46cb-8f02-95834654a416",
  "userGroupId": "0fb7f7d1-3700-4d1e-9349-e3418c1b972a",
  "deviceId": "0ec88e70-9023-4b4f-938a-78066eab095c",
  "deviceGroupId": "ee6364f2-780c-41a1-9ebd-f29a99858031",
  "applicationId": "ef69b319-5746-43be-bb13-a155a37a1205",
  "applicationVersionId": "f372368b-4b51-4b65-9414-97fe688d11b3",
  "nodeId": "6e5d72f9-e852-4e87-8373-c9e1b924af1a",
  "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-11-04T21:16:51.3260895+00:00",
  "updatedDateUtc": "2026-11-04T21:16:51.3260895+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-11-04T21:16:51.3260895+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-11-04T21:16:51.3260895+00:00</UpdatedDateUtc>
  <ApplicationId>ef69b319-5746-43be-bb13-a155a37a1205</ApplicationId>
  <ApplicationVersionId>f372368b-4b51-4b65-9414-97fe688d11b3</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>ee6364f2-780c-41a1-9ebd-f29a99858031</DeviceGroupId>
  <DeviceId>0ec88e70-9023-4b4f-938a-78066eab095c</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>6e5d72f9-e852-4e87-8373-c9e1b924af1a</NodeId>
  <NodeRouteId>79a9dc22-cd0f-4596-b707-da7000744620</NodeRouteId>
  <TenantId>a32e0cd9-2a24-44e6-8ae7-d0aae822efe1</TenantId>
  <UserGroupId>0fb7f7d1-3700-4d1e-9349-e3418c1b972a</UserGroupId>
  <UserId>cd1975fc-6ac8-46cb-8f02-95834654a416</UserId>
</NodeRouteRepresentation>