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": "7e895aa8-b74a-4369-acfa-26ad4098ac95",
  "tenantId": "2c76668a-1250-47b4-9cc2-8e6e1c7b3786",
  "userId": "6a3cda88-0d60-41e8-b0a3-f19c2ce8a423",
  "userGroupId": "1edf7432-c558-4006-891a-d2efd571109b",
  "deviceId": "29c736e0-e574-4daf-ab91-72702fe5d21e",
  "deviceGroupId": "2c1e0d05-703d-4814-82c5-c43017edb8e3",
  "applicationId": "b9fee30a-7f2e-40c6-af2a-ff199eb80146",
  "applicationVersionId": "981f5ee6-aed1-44a2-a434-9dd63fd5ec16",
  "nodeId": "4a620cb5-6e30-4a32-b7d6-bcc30f5797bc",
  "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": "2024-08-30T00:26:56.2094176+00:00",
  "updatedDateUtc": "2024-08-30T00:26:56.2094176+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>2024-08-30T00:26:56.2094176+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2024-08-30T00:26:56.2094176+00:00</UpdatedDateUtc>
  <ApplicationId>b9fee30a-7f2e-40c6-af2a-ff199eb80146</ApplicationId>
  <ApplicationVersionId>981f5ee6-aed1-44a2-a434-9dd63fd5ec16</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>2c1e0d05-703d-4814-82c5-c43017edb8e3</DeviceGroupId>
  <DeviceId>29c736e0-e574-4daf-ab91-72702fe5d21e</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>4a620cb5-6e30-4a32-b7d6-bcc30f5797bc</NodeId>
  <NodeRouteId>7e895aa8-b74a-4369-acfa-26ad4098ac95</NodeRouteId>
  <TenantId>2c76668a-1250-47b4-9cc2-8e6e1c7b3786</TenantId>
  <UserGroupId>1edf7432-c558-4006-891a-d2efd571109b</UserGroupId>
  <UserId>6a3cda88-0d60-41e8-b0a3-f19c2ce8a423</UserId>
</NodeRouteRepresentation>