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": "d64933c5-92a2-4ddf-bbc8-bc10fa6fa59b",
  "tenantId": "86e7ab6d-fde4-45aa-89e2-0a525b8c4683",
  "userId": "de70c495-b895-41c8-af49-2943a8beb02a",
  "userGroupId": "6b40190c-dfc3-48d7-86ae-a9a74c0bb198",
  "deviceId": "0814879f-2e4e-4ffe-9783-6fb2cc669561",
  "deviceGroupId": "d4169f99-9ed3-496a-bca6-7d6effc0b54c",
  "applicationId": "610951ce-2360-481d-9c63-f000088b24d3",
  "applicationVersionId": "eb6c40c9-96d6-44e2-8f20-b6c19342b911",
  "nodeId": "83bc4bee-7d77-43dc-97eb-aad5216f2bbe",
  "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-02-01T08:33:07.2932577+00:00",
  "updatedDateUtc": "2026-02-01T08:33:07.2932577+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-02-01T08:33:07.2932577+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-01T08:33:07.2932577+00:00</UpdatedDateUtc>
  <ApplicationId>610951ce-2360-481d-9c63-f000088b24d3</ApplicationId>
  <ApplicationVersionId>eb6c40c9-96d6-44e2-8f20-b6c19342b911</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>d4169f99-9ed3-496a-bca6-7d6effc0b54c</DeviceGroupId>
  <DeviceId>0814879f-2e4e-4ffe-9783-6fb2cc669561</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>83bc4bee-7d77-43dc-97eb-aad5216f2bbe</NodeId>
  <NodeRouteId>d64933c5-92a2-4ddf-bbc8-bc10fa6fa59b</NodeRouteId>
  <TenantId>86e7ab6d-fde4-45aa-89e2-0a525b8c4683</TenantId>
  <UserGroupId>6b40190c-dfc3-48d7-86ae-a9a74c0bb198</UserGroupId>
  <UserId>de70c495-b895-41c8-af49-2943a8beb02a</UserId>
</NodeRouteRepresentation>