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": "ad725fa1-97f4-48ed-9aeb-8830cc18219c",
  "tenantId": "62a55668-187f-425d-a1b6-eaf54152c867",
  "userId": "5e41278f-6136-4a24-8223-a3f1fc05fd5d",
  "userGroupId": "35744691-a00a-4e41-b24d-10bc2cdb6945",
  "deviceId": "e84b62e6-3e8e-4e5b-956a-21e7ef1a122b",
  "deviceGroupId": "7e121d79-ac98-43da-a1e0-f8d207d9d7a2",
  "applicationId": "a2c2abab-6428-4298-b335-bc1f72400b12",
  "applicationVersionId": "9444669a-0adc-478d-b6c6-d12446308d82",
  "nodeId": "e5f5b5cf-dfea-46ef-9738-89116ec8317c",
  "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-31T04:33:20.861641+00:00",
  "updatedDateUtc": "2025-12-31T04:33:20.861641+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-31T04:33:20.861641+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-31T04:33:20.861641+00:00</UpdatedDateUtc>
  <ApplicationId>a2c2abab-6428-4298-b335-bc1f72400b12</ApplicationId>
  <ApplicationVersionId>9444669a-0adc-478d-b6c6-d12446308d82</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>7e121d79-ac98-43da-a1e0-f8d207d9d7a2</DeviceGroupId>
  <DeviceId>e84b62e6-3e8e-4e5b-956a-21e7ef1a122b</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>e5f5b5cf-dfea-46ef-9738-89116ec8317c</NodeId>
  <NodeRouteId>ad725fa1-97f4-48ed-9aeb-8830cc18219c</NodeRouteId>
  <TenantId>62a55668-187f-425d-a1b6-eaf54152c867</TenantId>
  <UserGroupId>35744691-a00a-4e41-b24d-10bc2cdb6945</UserGroupId>
  <UserId>5e41278f-6136-4a24-8223-a3f1fc05fd5d</UserId>
</NodeRouteRepresentation>