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": "198062c4-959d-4cba-8b5c-453e0690e478",
  "tenantId": "3b45daa2-4f95-4f91-9b04-b1820f437de8",
  "userId": "fa2b58e3-6292-4e83-a16b-f7a5893b7e4f",
  "userGroupId": "f577cda7-060f-4f1a-9ab3-857a419d41ea",
  "deviceId": "2dbe92af-aae4-4bd4-bcd5-c9030c29aab4",
  "deviceGroupId": "ff8199e0-cb4b-41c4-a58d-c6c43d86c479",
  "applicationId": "85e68e03-a3ac-4699-9d36-2ec64a3d7533",
  "applicationVersionId": "f2eaa295-f6c0-41a1-b4be-de30a94e2519",
  "nodeId": "d0e6c65b-ea75-42af-8cbe-efb959a7b72a",
  "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-06-13T10:27:33.1007211+00:00",
  "updatedDateUtc": "2025-06-13T10:27:33.1007211+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-06-13T10:27:33.1007211+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-06-13T10:27:33.1007211+00:00</UpdatedDateUtc>
  <ApplicationId>85e68e03-a3ac-4699-9d36-2ec64a3d7533</ApplicationId>
  <ApplicationVersionId>f2eaa295-f6c0-41a1-b4be-de30a94e2519</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>ff8199e0-cb4b-41c4-a58d-c6c43d86c479</DeviceGroupId>
  <DeviceId>2dbe92af-aae4-4bd4-bcd5-c9030c29aab4</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>d0e6c65b-ea75-42af-8cbe-efb959a7b72a</NodeId>
  <NodeRouteId>198062c4-959d-4cba-8b5c-453e0690e478</NodeRouteId>
  <TenantId>3b45daa2-4f95-4f91-9b04-b1820f437de8</TenantId>
  <UserGroupId>f577cda7-060f-4f1a-9ab3-857a419d41ea</UserGroupId>
  <UserId>fa2b58e3-6292-4e83-a16b-f7a5893b7e4f</UserId>
</NodeRouteRepresentation>