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": "dcd94576-9064-4cd1-84a6-2446d34ab637",
  "tenantId": "6da195f0-d06c-4d75-a909-e98bcc3c756b",
  "userId": "ddf1bb6a-8808-47aa-a1b5-b39b0fdaa9de",
  "userGroupId": "9398c90d-9d76-4571-9f54-51b9a6aafbe8",
  "deviceId": "62550c32-5850-4640-b661-9f587de1887f",
  "deviceGroupId": "e55f0204-38d6-4666-9b08-fb80e222d67a",
  "applicationId": "2689622c-c6fc-46df-9d02-d685eeca0747",
  "applicationVersionId": "132b2dfa-e4db-467c-b35d-364e649fc2b9",
  "nodeId": "df5c6952-eb44-46e9-8984-42c16f277499",
  "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-07-17T09:02:20.7145897+00:00",
  "updatedDateUtc": "2025-07-17T09:02:20.7145897+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-07-17T09:02:20.7145897+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-07-17T09:02:20.7145897+00:00</UpdatedDateUtc>
  <ApplicationId>2689622c-c6fc-46df-9d02-d685eeca0747</ApplicationId>
  <ApplicationVersionId>132b2dfa-e4db-467c-b35d-364e649fc2b9</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>e55f0204-38d6-4666-9b08-fb80e222d67a</DeviceGroupId>
  <DeviceId>62550c32-5850-4640-b661-9f587de1887f</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>df5c6952-eb44-46e9-8984-42c16f277499</NodeId>
  <NodeRouteId>dcd94576-9064-4cd1-84a6-2446d34ab637</NodeRouteId>
  <TenantId>6da195f0-d06c-4d75-a909-e98bcc3c756b</TenantId>
  <UserGroupId>9398c90d-9d76-4571-9f54-51b9a6aafbe8</UserGroupId>
  <UserId>ddf1bb6a-8808-47aa-a1b5-b39b0fdaa9de</UserId>
</NodeRouteRepresentation>