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": "06cc10e8-6b63-4b31-a41b-800be2be2234",
  "tenantId": "c4421844-48fd-4afc-a4c1-455fe2a6201d",
  "userId": "4211c2bf-3f03-40c9-9104-3162b4485c9a",
  "userGroupId": "002b43cc-5455-459a-adfc-b81ef717c54d",
  "deviceId": "776e2f85-526a-4205-a5af-acf3446b8888",
  "deviceGroupId": "d2daf5db-84e8-4c7d-aa03-7c4631a46129",
  "applicationId": "f7647feb-657d-4e39-b461-9faaaf841d5c",
  "applicationVersionId": "0764189f-e8d1-4b1c-bb7b-a45980d8707b",
  "nodeId": "7012c224-f199-459b-974e-b3ed2dfcfcd1",
  "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-04-21T01:25:06.4948632+00:00",
  "updatedDateUtc": "2025-04-21T01:25:06.4948632+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-04-21T01:25:06.4948632+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-04-21T01:25:06.4948632+00:00</UpdatedDateUtc>
  <ApplicationId>f7647feb-657d-4e39-b461-9faaaf841d5c</ApplicationId>
  <ApplicationVersionId>0764189f-e8d1-4b1c-bb7b-a45980d8707b</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>d2daf5db-84e8-4c7d-aa03-7c4631a46129</DeviceGroupId>
  <DeviceId>776e2f85-526a-4205-a5af-acf3446b8888</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>7012c224-f199-459b-974e-b3ed2dfcfcd1</NodeId>
  <NodeRouteId>06cc10e8-6b63-4b31-a41b-800be2be2234</NodeRouteId>
  <TenantId>c4421844-48fd-4afc-a4c1-455fe2a6201d</TenantId>
  <UserGroupId>002b43cc-5455-459a-adfc-b81ef717c54d</UserGroupId>
  <UserId>4211c2bf-3f03-40c9-9104-3162b4485c9a</UserId>
</NodeRouteRepresentation>