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": "334a51f7-da0d-42a4-856e-58aa198d0ead",
  "tenantId": "d7db3fc2-1eee-4042-8260-74e7a55b36c9",
  "userId": "fe140db1-47f1-4b9e-88bb-d1ffe764b04c",
  "userGroupId": "6488aa72-4926-4559-b829-175923411615",
  "deviceId": "f321a399-8515-4fce-8c86-69e41fe7deaf",
  "deviceGroupId": "fd88277c-46da-400b-8bf7-0b5792e34541",
  "applicationId": "0c78fac3-0b6e-44ed-aab4-6d1fbf7973b9",
  "applicationVersionId": "743d4783-cb67-4996-9d0b-2cd320c0d83a",
  "nodeId": "3d34e21a-99fe-48da-b37e-bdd3aa4d79f5",
  "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-12T13:20:25.9936021+00:00",
  "updatedDateUtc": "2025-11-12T13:20:25.9936021+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-12T13:20:25.9936021+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-12T13:20:25.9936021+00:00</UpdatedDateUtc>
  <ApplicationId>0c78fac3-0b6e-44ed-aab4-6d1fbf7973b9</ApplicationId>
  <ApplicationVersionId>743d4783-cb67-4996-9d0b-2cd320c0d83a</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>fd88277c-46da-400b-8bf7-0b5792e34541</DeviceGroupId>
  <DeviceId>f321a399-8515-4fce-8c86-69e41fe7deaf</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>3d34e21a-99fe-48da-b37e-bdd3aa4d79f5</NodeId>
  <NodeRouteId>334a51f7-da0d-42a4-856e-58aa198d0ead</NodeRouteId>
  <TenantId>d7db3fc2-1eee-4042-8260-74e7a55b36c9</TenantId>
  <UserGroupId>6488aa72-4926-4559-b829-175923411615</UserGroupId>
  <UserId>fe140db1-47f1-4b9e-88bb-d1ffe764b04c</UserId>
</NodeRouteRepresentation>