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": "a1247301-4b53-48f2-bec9-95fa6ace5ee6",
  "tenantId": "eb8af3b6-7fb4-49a6-badd-4cf94cc1767d",
  "userId": "d47aaa8b-e4f3-4f20-ac61-9a5e51f845ab",
  "userGroupId": "a9889189-fb96-44b5-8ad0-bcb2b424ce19",
  "deviceId": "696342c4-961a-463f-92a2-9fefa488578b",
  "deviceGroupId": "37be6b17-649e-4dfa-ab83-8b30b9bdb375",
  "applicationId": "f70147e1-9674-432a-a666-44e8221a89f2",
  "applicationVersionId": "75a9a647-570c-4be7-a4d5-e858ff7daf2a",
  "nodeId": "512b21e8-7f7f-4159-a6ae-2eb9107d37d7",
  "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-07-15T09:19:22.9411539+00:00",
  "updatedDateUtc": "2026-07-15T09:19:22.9411539+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-07-15T09:19:22.9411539+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-07-15T09:19:22.9411539+00:00</UpdatedDateUtc>
  <ApplicationId>f70147e1-9674-432a-a666-44e8221a89f2</ApplicationId>
  <ApplicationVersionId>75a9a647-570c-4be7-a4d5-e858ff7daf2a</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>37be6b17-649e-4dfa-ab83-8b30b9bdb375</DeviceGroupId>
  <DeviceId>696342c4-961a-463f-92a2-9fefa488578b</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>512b21e8-7f7f-4159-a6ae-2eb9107d37d7</NodeId>
  <NodeRouteId>a1247301-4b53-48f2-bec9-95fa6ace5ee6</NodeRouteId>
  <TenantId>eb8af3b6-7fb4-49a6-badd-4cf94cc1767d</TenantId>
  <UserGroupId>a9889189-fb96-44b5-8ad0-bcb2b424ce19</UserGroupId>
  <UserId>d47aaa8b-e4f3-4f20-ac61-9a5e51f845ab</UserId>
</NodeRouteRepresentation>