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": "18b1feb4-ff9c-454a-b91f-273577093e00",
  "tenantId": "0c02a51e-bbc0-4dcf-a74a-f9ee7741635e",
  "userId": "66247f4a-00e7-4c81-a5f3-a1de077dfb60",
  "userGroupId": "2c719f22-fa15-41d9-bee8-177e111552dd",
  "deviceId": "8e55fc9b-6c56-45e3-873f-0543e92eabb4",
  "deviceGroupId": "48eed602-4110-401b-ad74-1ac94ae568c8",
  "applicationId": "c7d0c8a4-7b7b-43a2-a99b-dbebc531aac7",
  "applicationVersionId": "11d6eb37-f4e8-4184-9747-82836fb4fddf",
  "nodeId": "6615bde3-8fd9-481d-98b5-a549d715e751",
  "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-10T07:51:54.7961048+00:00",
  "updatedDateUtc": "2026-04-10T07:51:54.7961048+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-10T07:51:54.7961048+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-10T07:51:54.7961048+00:00</UpdatedDateUtc>
  <ApplicationId>c7d0c8a4-7b7b-43a2-a99b-dbebc531aac7</ApplicationId>
  <ApplicationVersionId>11d6eb37-f4e8-4184-9747-82836fb4fddf</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>48eed602-4110-401b-ad74-1ac94ae568c8</DeviceGroupId>
  <DeviceId>8e55fc9b-6c56-45e3-873f-0543e92eabb4</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>6615bde3-8fd9-481d-98b5-a549d715e751</NodeId>
  <NodeRouteId>18b1feb4-ff9c-454a-b91f-273577093e00</NodeRouteId>
  <TenantId>0c02a51e-bbc0-4dcf-a74a-f9ee7741635e</TenantId>
  <UserGroupId>2c719f22-fa15-41d9-bee8-177e111552dd</UserGroupId>
  <UserId>66247f4a-00e7-4c81-a5f3-a1de077dfb60</UserId>
</NodeRouteRepresentation>