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": "50ab18ee-d213-4718-b3c8-ebb4d48db46c",
  "tenantId": "1a306fe3-2e0b-4b9b-a044-c2b9fa67c917",
  "userId": "89ab6fc9-af5c-4f3d-810e-5ead496efbaa",
  "userGroupId": "25af9aa4-eee3-405a-8bb5-d3d729cfc075",
  "deviceId": "38fd3921-3ad4-4084-999d-a29cea6c8476",
  "deviceGroupId": "5d1d83d7-3494-484d-b455-5a7ece95ff14",
  "applicationId": "383a60df-57a1-48e2-86d2-034451a85496",
  "applicationVersionId": "bf70de64-d2ff-4780-a7b3-4fe8b2ea3f79",
  "nodeId": "8216219d-554c-4e27-a1cf-6c55b7845fdc",
  "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-31T04:00:18.4435588+00:00",
  "updatedDateUtc": "2026-03-31T04:00:18.4435588+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-31T04:00:18.4435588+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-31T04:00:18.4435588+00:00</UpdatedDateUtc>
  <ApplicationId>383a60df-57a1-48e2-86d2-034451a85496</ApplicationId>
  <ApplicationVersionId>bf70de64-d2ff-4780-a7b3-4fe8b2ea3f79</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>5d1d83d7-3494-484d-b455-5a7ece95ff14</DeviceGroupId>
  <DeviceId>38fd3921-3ad4-4084-999d-a29cea6c8476</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>8216219d-554c-4e27-a1cf-6c55b7845fdc</NodeId>
  <NodeRouteId>50ab18ee-d213-4718-b3c8-ebb4d48db46c</NodeRouteId>
  <TenantId>1a306fe3-2e0b-4b9b-a044-c2b9fa67c917</TenantId>
  <UserGroupId>25af9aa4-eee3-405a-8bb5-d3d729cfc075</UserGroupId>
  <UserId>89ab6fc9-af5c-4f3d-810e-5ead496efbaa</UserId>
</NodeRouteRepresentation>