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": "77dd507a-4246-40bb-b467-658333376007",
  "tenantId": "316ac113-67a5-4bdf-9704-69c6c34a065f",
  "userId": "e7c45d4d-b9f6-4bc1-84d5-5f5ed07f8e81",
  "userGroupId": "34573cbc-ae7d-41ad-a0d7-73182fbce266",
  "deviceId": "431de013-644f-4292-a8a0-f3cb10184562",
  "deviceGroupId": "07108634-d160-4d55-a0a4-b01543389606",
  "applicationId": "e05305cc-fe64-45c9-9d00-6803e19b4e97",
  "applicationVersionId": "107d94d7-e493-4977-a3ab-96c61e826843",
  "nodeId": "dbddc9cc-d4f2-4eeb-9ffd-6ea0b9f3d031",
  "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-07-06T16:58:06.7901253+00:00",
  "updatedDateUtc": "2026-07-06T16:58:06.7901253+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-07-06T16:58:06.7901253+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-07-06T16:58:06.7901253+00:00</UpdatedDateUtc>
  <ApplicationId>e05305cc-fe64-45c9-9d00-6803e19b4e97</ApplicationId>
  <ApplicationVersionId>107d94d7-e493-4977-a3ab-96c61e826843</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>07108634-d160-4d55-a0a4-b01543389606</DeviceGroupId>
  <DeviceId>431de013-644f-4292-a8a0-f3cb10184562</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>dbddc9cc-d4f2-4eeb-9ffd-6ea0b9f3d031</NodeId>
  <NodeRouteId>77dd507a-4246-40bb-b467-658333376007</NodeRouteId>
  <TenantId>316ac113-67a5-4bdf-9704-69c6c34a065f</TenantId>
  <UserGroupId>34573cbc-ae7d-41ad-a0d7-73182fbce266</UserGroupId>
  <UserId>e7c45d4d-b9f6-4bc1-84d5-5f5ed07f8e81</UserId>
</NodeRouteRepresentation>