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": "bb28b496-0944-44a4-a8d9-77ae205a7479",
  "tenantId": "6b9c6594-ae4b-43ad-93e0-192d5ccb8838",
  "userId": "e6522153-12bd-453d-99f2-447d72a7ebf4",
  "userGroupId": "d9f034bc-61d3-4471-bf22-04c80cd13167",
  "deviceId": "8fbed25d-c849-424e-b7f3-ebde25a5fde1",
  "deviceGroupId": "97f0f74c-2d21-4968-bc2e-08e4944b1132",
  "applicationId": "2a9ee76f-b5e7-444d-876f-9fc792c178bd",
  "applicationVersionId": "0dfde244-c2fe-4b9e-add6-9b7268858a18",
  "nodeId": "39639d44-d2d8-41bc-8116-e983a4b698c4",
  "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": "2025-11-30T19:03:29.6788532+00:00",
  "updatedDateUtc": "2025-11-30T19:03:29.6788532+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>2025-11-30T19:03:29.6788532+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-30T19:03:29.6788532+00:00</UpdatedDateUtc>
  <ApplicationId>2a9ee76f-b5e7-444d-876f-9fc792c178bd</ApplicationId>
  <ApplicationVersionId>0dfde244-c2fe-4b9e-add6-9b7268858a18</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>97f0f74c-2d21-4968-bc2e-08e4944b1132</DeviceGroupId>
  <DeviceId>8fbed25d-c849-424e-b7f3-ebde25a5fde1</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>39639d44-d2d8-41bc-8116-e983a4b698c4</NodeId>
  <NodeRouteId>bb28b496-0944-44a4-a8d9-77ae205a7479</NodeRouteId>
  <TenantId>6b9c6594-ae4b-43ad-93e0-192d5ccb8838</TenantId>
  <UserGroupId>d9f034bc-61d3-4471-bf22-04c80cd13167</UserGroupId>
  <UserId>e6522153-12bd-453d-99f2-447d72a7ebf4</UserId>
</NodeRouteRepresentation>