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": "970264a4-fb28-4d0f-b291-cd5ae33ee9bf",
  "tenantId": "30313d40-3774-4b23-9803-63d7cd6e4a2d",
  "userId": "c3bce515-36e7-4aac-853f-e3091de067fc",
  "userGroupId": "351b5c2f-eabe-4ec4-9071-ff41fd11affe",
  "deviceId": "9a42d1f4-eee3-48db-856f-36e1680cab55",
  "deviceGroupId": "460c7a2b-9b0d-45cb-9a78-5ded7f716fe7",
  "applicationId": "2a094528-303f-4598-937a-1a87d871c7c2",
  "applicationVersionId": "8336529b-8109-4c50-b5c4-252b5d4ca2f2",
  "nodeId": "9ac4aa4b-5714-44c1-9350-27776cb0e665",
  "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-03-19T05:10:14.9237904+00:00",
  "updatedDateUtc": "2026-03-19T05:10:14.9237904+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-03-19T05:10:14.9237904+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-19T05:10:14.9237904+00:00</UpdatedDateUtc>
  <ApplicationId>2a094528-303f-4598-937a-1a87d871c7c2</ApplicationId>
  <ApplicationVersionId>8336529b-8109-4c50-b5c4-252b5d4ca2f2</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>460c7a2b-9b0d-45cb-9a78-5ded7f716fe7</DeviceGroupId>
  <DeviceId>9a42d1f4-eee3-48db-856f-36e1680cab55</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>9ac4aa4b-5714-44c1-9350-27776cb0e665</NodeId>
  <NodeRouteId>970264a4-fb28-4d0f-b291-cd5ae33ee9bf</NodeRouteId>
  <TenantId>30313d40-3774-4b23-9803-63d7cd6e4a2d</TenantId>
  <UserGroupId>351b5c2f-eabe-4ec4-9071-ff41fd11affe</UserGroupId>
  <UserId>c3bce515-36e7-4aac-853f-e3091de067fc</UserId>
</NodeRouteRepresentation>