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": "28d10c12-b66a-492d-b7a2-b3958923cc96",
  "tenantId": "070aa0de-8195-4ebc-af2b-d70656b75a73",
  "userId": "eca10a05-d1f4-474d-9eb9-aea6d101a67c",
  "userGroupId": "ca9a22fc-ca6d-4194-b107-1979b7a4e111",
  "deviceId": "13701455-8dda-46dc-aca4-1bcb99206a08",
  "deviceGroupId": "066c396f-555c-4dd1-b31d-6861c6803254",
  "applicationId": "3d655e89-b1c3-40a5-8387-c518006ee207",
  "applicationVersionId": "67fc031a-d04e-4423-909d-37113312e2bb",
  "nodeId": "cb71aba6-84cd-4744-9c8e-6deff80c6f4f",
  "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-09-05T13:36:15.9707606+00:00",
  "updatedDateUtc": "2025-09-05T13:36:15.9707606+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-09-05T13:36:15.9707606+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-09-05T13:36:15.9707606+00:00</UpdatedDateUtc>
  <ApplicationId>3d655e89-b1c3-40a5-8387-c518006ee207</ApplicationId>
  <ApplicationVersionId>67fc031a-d04e-4423-909d-37113312e2bb</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>066c396f-555c-4dd1-b31d-6861c6803254</DeviceGroupId>
  <DeviceId>13701455-8dda-46dc-aca4-1bcb99206a08</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>cb71aba6-84cd-4744-9c8e-6deff80c6f4f</NodeId>
  <NodeRouteId>28d10c12-b66a-492d-b7a2-b3958923cc96</NodeRouteId>
  <TenantId>070aa0de-8195-4ebc-af2b-d70656b75a73</TenantId>
  <UserGroupId>ca9a22fc-ca6d-4194-b107-1979b7a4e111</UserGroupId>
  <UserId>eca10a05-d1f4-474d-9eb9-aea6d101a67c</UserId>
</NodeRouteRepresentation>