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": "35f5e691-9538-486e-b59c-4eafd0e9130a",
  "tenantId": "acae3cac-8511-42d6-8848-45db068dc1b4",
  "userId": "3625e378-0000-4b36-b9e4-0e622f328b81",
  "userGroupId": "33efa436-bda4-4919-aa85-818868d655d4",
  "deviceId": "7f118a5f-072c-4585-a567-1c79409499c3",
  "deviceGroupId": "9c972245-ff03-4d56-b3ef-e835184509a5",
  "applicationId": "6b8d8900-a400-4d54-b48a-a0bc45acabf9",
  "applicationVersionId": "8cd989e3-e0e2-4447-b51f-47d763711ab7",
  "nodeId": "49ff6085-723e-452d-9c6d-0b8a631bd9df",
  "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-04-24T23:47:17.5580777+00:00",
  "updatedDateUtc": "2026-04-24T23:47:17.5580777+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-04-24T23:47:17.5580777+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-24T23:47:17.5580777+00:00</UpdatedDateUtc>
  <ApplicationId>6b8d8900-a400-4d54-b48a-a0bc45acabf9</ApplicationId>
  <ApplicationVersionId>8cd989e3-e0e2-4447-b51f-47d763711ab7</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>9c972245-ff03-4d56-b3ef-e835184509a5</DeviceGroupId>
  <DeviceId>7f118a5f-072c-4585-a567-1c79409499c3</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>49ff6085-723e-452d-9c6d-0b8a631bd9df</NodeId>
  <NodeRouteId>35f5e691-9538-486e-b59c-4eafd0e9130a</NodeRouteId>
  <TenantId>acae3cac-8511-42d6-8848-45db068dc1b4</TenantId>
  <UserGroupId>33efa436-bda4-4919-aa85-818868d655d4</UserGroupId>
  <UserId>3625e378-0000-4b36-b9e4-0e622f328b81</UserId>
</NodeRouteRepresentation>