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": "6c1ac41f-d0f7-45c3-b678-d4e2f956fd8f",
  "tenantId": "dcb1c519-dced-4a8a-b94e-e7ff9005943b",
  "userId": "44f7df08-3c1b-4834-ad94-c40119b74a3c",
  "userGroupId": "e4203ff3-39d2-4ed8-8e44-723ec6a3af1d",
  "deviceId": "69660097-8c96-4b7e-a9cb-ab470b8ce453",
  "deviceGroupId": "892b6d27-3bd0-4a8e-a960-aa4b519ecc56",
  "applicationId": "4df87d92-4314-403b-b41a-4e2f1ac58c57",
  "applicationVersionId": "125b482d-0cd4-4fd7-9a20-8b33406c20fe",
  "nodeId": "306d0221-5ada-483d-aade-8300a79deb47",
  "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-11T18:04:50.06788+00:00",
  "updatedDateUtc": "2025-12-11T18:04:50.06788+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-11T18:04:50.06788+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-11T18:04:50.06788+00:00</UpdatedDateUtc>
  <ApplicationId>4df87d92-4314-403b-b41a-4e2f1ac58c57</ApplicationId>
  <ApplicationVersionId>125b482d-0cd4-4fd7-9a20-8b33406c20fe</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>892b6d27-3bd0-4a8e-a960-aa4b519ecc56</DeviceGroupId>
  <DeviceId>69660097-8c96-4b7e-a9cb-ab470b8ce453</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>306d0221-5ada-483d-aade-8300a79deb47</NodeId>
  <NodeRouteId>6c1ac41f-d0f7-45c3-b678-d4e2f956fd8f</NodeRouteId>
  <TenantId>dcb1c519-dced-4a8a-b94e-e7ff9005943b</TenantId>
  <UserGroupId>e4203ff3-39d2-4ed8-8e44-723ec6a3af1d</UserGroupId>
  <UserId>44f7df08-3c1b-4834-ad94-c40119b74a3c</UserId>
</NodeRouteRepresentation>