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": "ba69b6ad-5473-4617-96cc-66b79286ef4e",
  "tenantId": "f424e16d-c2cf-44dc-9340-b25a8e0474af",
  "userId": "8860ef9b-9db1-4b6c-b978-b43244c27e30",
  "userGroupId": "c5d248a5-c709-4057-82fd-685c979246c9",
  "deviceId": "6b188dfc-c510-4c9a-bed2-06f65d5fc26f",
  "deviceGroupId": "3744b92d-022b-41f5-855c-dc3e377986b7",
  "applicationId": "ec221329-47eb-44e2-90e0-a110c8f66a6f",
  "applicationVersionId": "2dbd2352-478b-4704-8c50-ff4243f2a09b",
  "nodeId": "cac372a9-2f41-4807-af56-89698538bfec",
  "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-12-06T09:10:35.3099485+00:00",
  "updatedDateUtc": "2025-12-06T09:10:35.3099485+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-12-06T09:10:35.3099485+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-06T09:10:35.3099485+00:00</UpdatedDateUtc>
  <ApplicationId>ec221329-47eb-44e2-90e0-a110c8f66a6f</ApplicationId>
  <ApplicationVersionId>2dbd2352-478b-4704-8c50-ff4243f2a09b</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>3744b92d-022b-41f5-855c-dc3e377986b7</DeviceGroupId>
  <DeviceId>6b188dfc-c510-4c9a-bed2-06f65d5fc26f</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>cac372a9-2f41-4807-af56-89698538bfec</NodeId>
  <NodeRouteId>ba69b6ad-5473-4617-96cc-66b79286ef4e</NodeRouteId>
  <TenantId>f424e16d-c2cf-44dc-9340-b25a8e0474af</TenantId>
  <UserGroupId>c5d248a5-c709-4057-82fd-685c979246c9</UserGroupId>
  <UserId>8860ef9b-9db1-4b6c-b978-b43244c27e30</UserId>
</NodeRouteRepresentation>