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": "16ed9b03-de07-467d-92c2-37f88a14ef42",
  "tenantId": "7eac866d-f3aa-48c9-8447-f01e89772dd8",
  "userId": "6594b160-e610-4cda-904f-4fd16bd5a2b3",
  "userGroupId": "37d48de5-ea86-4cd1-95a3-8a8fe82863cf",
  "deviceId": "56095d00-80a3-492d-8429-228539080042",
  "deviceGroupId": "5bb694f5-308d-476b-9787-65296b630c21",
  "applicationId": "30c2e967-533f-4ec7-b52d-bd01c020bde9",
  "applicationVersionId": "abccacf7-1d3e-4693-ac10-ca6fbd1c29f5",
  "nodeId": "1b0ff867-7bbd-4834-8c23-d03c12b4719e",
  "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-16T11:08:02.6733738+00:00",
  "updatedDateUtc": "2025-12-16T11:08:02.6733738+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-16T11:08:02.6733738+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-16T11:08:02.6733738+00:00</UpdatedDateUtc>
  <ApplicationId>30c2e967-533f-4ec7-b52d-bd01c020bde9</ApplicationId>
  <ApplicationVersionId>abccacf7-1d3e-4693-ac10-ca6fbd1c29f5</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>5bb694f5-308d-476b-9787-65296b630c21</DeviceGroupId>
  <DeviceId>56095d00-80a3-492d-8429-228539080042</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>1b0ff867-7bbd-4834-8c23-d03c12b4719e</NodeId>
  <NodeRouteId>16ed9b03-de07-467d-92c2-37f88a14ef42</NodeRouteId>
  <TenantId>7eac866d-f3aa-48c9-8447-f01e89772dd8</TenantId>
  <UserGroupId>37d48de5-ea86-4cd1-95a3-8a8fe82863cf</UserGroupId>
  <UserId>6594b160-e610-4cda-904f-4fd16bd5a2b3</UserId>
</NodeRouteRepresentation>