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": "46aaf43d-1b8d-491a-ad84-1aed903e684d",
  "tenantId": "dbacd7a8-cda7-4c4e-964b-38232e8ff88d",
  "userId": "1f48c713-e95a-4682-b179-cdda6fe87ad4",
  "userGroupId": "49b5e8d4-b928-4dd7-88b5-e981969996b1",
  "deviceId": "598f219c-7f2f-4920-9dab-b898105faaf8",
  "deviceGroupId": "213e45ef-6d9e-49f2-bdec-c7e2e734efcf",
  "applicationId": "47126a2c-c249-40ce-9cbe-2056e19c0698",
  "applicationVersionId": "7cffd0e8-5546-468c-8137-d0c701f3fd2a",
  "nodeId": "2e664c48-b78e-4edc-9184-494e60008842",
  "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-09-02T03:13:58.3432963+00:00",
  "updatedDateUtc": "2025-09-02T03:13:58.3432963+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-09-02T03:13:58.3432963+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-09-02T03:13:58.3432963+00:00</UpdatedDateUtc>
  <ApplicationId>47126a2c-c249-40ce-9cbe-2056e19c0698</ApplicationId>
  <ApplicationVersionId>7cffd0e8-5546-468c-8137-d0c701f3fd2a</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>213e45ef-6d9e-49f2-bdec-c7e2e734efcf</DeviceGroupId>
  <DeviceId>598f219c-7f2f-4920-9dab-b898105faaf8</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>2e664c48-b78e-4edc-9184-494e60008842</NodeId>
  <NodeRouteId>46aaf43d-1b8d-491a-ad84-1aed903e684d</NodeRouteId>
  <TenantId>dbacd7a8-cda7-4c4e-964b-38232e8ff88d</TenantId>
  <UserGroupId>49b5e8d4-b928-4dd7-88b5-e981969996b1</UserGroupId>
  <UserId>1f48c713-e95a-4682-b179-cdda6fe87ad4</UserId>
</NodeRouteRepresentation>