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": "add99e35-4520-4314-a350-ef68b8640a04",
  "tenantId": "16141b7d-938e-49d0-9038-6083aa8fbc05",
  "userId": "fda967a0-2e65-4c34-8fbb-857c0094a894",
  "userGroupId": "1d8af9a7-0c51-4497-9978-a36b740fc539",
  "deviceId": "7982d740-8df1-459d-92d4-e325e871ec81",
  "deviceGroupId": "16f6b251-4ad8-4ac8-ba4c-13aa8c023720",
  "applicationId": "38789eab-555e-472c-8a77-d786a7337281",
  "applicationVersionId": "a03c5862-c092-4078-af99-58ab9a4d3e24",
  "nodeId": "eef7ead4-10dd-4048-a304-7ef51ffe8e52",
  "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": "2026-02-02T21:03:34.2721342+00:00",
  "updatedDateUtc": "2026-02-02T21:03:34.2721342+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>2026-02-02T21:03:34.2721342+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-02T21:03:34.2721342+00:00</UpdatedDateUtc>
  <ApplicationId>38789eab-555e-472c-8a77-d786a7337281</ApplicationId>
  <ApplicationVersionId>a03c5862-c092-4078-af99-58ab9a4d3e24</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>16f6b251-4ad8-4ac8-ba4c-13aa8c023720</DeviceGroupId>
  <DeviceId>7982d740-8df1-459d-92d4-e325e871ec81</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>eef7ead4-10dd-4048-a304-7ef51ffe8e52</NodeId>
  <NodeRouteId>add99e35-4520-4314-a350-ef68b8640a04</NodeRouteId>
  <TenantId>16141b7d-938e-49d0-9038-6083aa8fbc05</TenantId>
  <UserGroupId>1d8af9a7-0c51-4497-9978-a36b740fc539</UserGroupId>
  <UserId>fda967a0-2e65-4c34-8fbb-857c0094a894</UserId>
</NodeRouteRepresentation>