Cyan Web API - Version 1


GET api/nodeRoutes?{nodeId}

            Gets all of the NodeRoutes for a Node
            

Request Information

Parameters

NameDescriptionAdditional information
nodeId

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
[
  {
    "nodeRouteId": "65aeeead-6164-4149-98e1-66049037ab78",
    "tenantId": "45b32499-58c1-4fea-912b-8c13487957f5",
    "userId": "32da01c8-7af7-4335-b5b3-bfd959561b53",
    "userGroupId": "c623bd49-5a9b-460a-bf51-50bfca6f96fc",
    "deviceId": "4229bffe-7c29-4b79-a6d6-83a99f64c0b9",
    "deviceGroupId": "f852dde9-2b9d-4257-a80e-854be4d8c541",
    "applicationId": "9c895ac4-df7e-43e0-87f8-8da151090902",
    "applicationVersionId": "e0ff0889-e20e-4440-bf81-b99c32ef68df",
    "nodeId": "f32c0ae1-a3fc-4467-b3e6-78a7ccde619f",
    "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-12-12T18:47:29.5062883+00:00",
    "updatedDateUtc": "2025-12-12T18:47:29.5062883+00:00"
  },
  {
    "nodeRouteId": "65aeeead-6164-4149-98e1-66049037ab78",
    "tenantId": "45b32499-58c1-4fea-912b-8c13487957f5",
    "userId": "32da01c8-7af7-4335-b5b3-bfd959561b53",
    "userGroupId": "c623bd49-5a9b-460a-bf51-50bfca6f96fc",
    "deviceId": "4229bffe-7c29-4b79-a6d6-83a99f64c0b9",
    "deviceGroupId": "f852dde9-2b9d-4257-a80e-854be4d8c541",
    "applicationId": "9c895ac4-df7e-43e0-87f8-8da151090902",
    "applicationVersionId": "e0ff0889-e20e-4440-bf81-b99c32ef68df",
    "nodeId": "f32c0ae1-a3fc-4467-b3e6-78a7ccde619f",
    "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-12-12T18:47:29.5062883+00:00",
    "updatedDateUtc": "2025-12-12T18:47:29.5062883+00:00"
  },
  {
    "nodeRouteId": "65aeeead-6164-4149-98e1-66049037ab78",
    "tenantId": "45b32499-58c1-4fea-912b-8c13487957f5",
    "userId": "32da01c8-7af7-4335-b5b3-bfd959561b53",
    "userGroupId": "c623bd49-5a9b-460a-bf51-50bfca6f96fc",
    "deviceId": "4229bffe-7c29-4b79-a6d6-83a99f64c0b9",
    "deviceGroupId": "f852dde9-2b9d-4257-a80e-854be4d8c541",
    "applicationId": "9c895ac4-df7e-43e0-87f8-8da151090902",
    "applicationVersionId": "e0ff0889-e20e-4440-bf81-b99c32ef68df",
    "nodeId": "f32c0ae1-a3fc-4467-b3e6-78a7ccde619f",
    "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-12-12T18:47:29.5062883+00:00",
    "updatedDateUtc": "2025-12-12T18:47:29.5062883+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfNodeRouteRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-12T18:47:29.5062883+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-12T18:47:29.5062883+00:00</UpdatedDateUtc>
    <ApplicationId>9c895ac4-df7e-43e0-87f8-8da151090902</ApplicationId>
    <ApplicationVersionId>e0ff0889-e20e-4440-bf81-b99c32ef68df</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>f852dde9-2b9d-4257-a80e-854be4d8c541</DeviceGroupId>
    <DeviceId>4229bffe-7c29-4b79-a6d6-83a99f64c0b9</DeviceId>
    <IgnoreNodeIdsInRouting xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </IgnoreNodeIdsInRouting>
    <Name>sample string 4</Name>
    <NodeCyanId>6</NodeCyanId>
    <NodeId>f32c0ae1-a3fc-4467-b3e6-78a7ccde619f</NodeId>
    <NodeRouteId>65aeeead-6164-4149-98e1-66049037ab78</NodeRouteId>
    <TenantId>45b32499-58c1-4fea-912b-8c13487957f5</TenantId>
    <UserGroupId>c623bd49-5a9b-460a-bf51-50bfca6f96fc</UserGroupId>
    <UserId>32da01c8-7af7-4335-b5b3-bfd959561b53</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-12T18:47:29.5062883+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-12T18:47:29.5062883+00:00</UpdatedDateUtc>
    <ApplicationId>9c895ac4-df7e-43e0-87f8-8da151090902</ApplicationId>
    <ApplicationVersionId>e0ff0889-e20e-4440-bf81-b99c32ef68df</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>f852dde9-2b9d-4257-a80e-854be4d8c541</DeviceGroupId>
    <DeviceId>4229bffe-7c29-4b79-a6d6-83a99f64c0b9</DeviceId>
    <IgnoreNodeIdsInRouting xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </IgnoreNodeIdsInRouting>
    <Name>sample string 4</Name>
    <NodeCyanId>6</NodeCyanId>
    <NodeId>f32c0ae1-a3fc-4467-b3e6-78a7ccde619f</NodeId>
    <NodeRouteId>65aeeead-6164-4149-98e1-66049037ab78</NodeRouteId>
    <TenantId>45b32499-58c1-4fea-912b-8c13487957f5</TenantId>
    <UserGroupId>c623bd49-5a9b-460a-bf51-50bfca6f96fc</UserGroupId>
    <UserId>32da01c8-7af7-4335-b5b3-bfd959561b53</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-12T18:47:29.5062883+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-12T18:47:29.5062883+00:00</UpdatedDateUtc>
    <ApplicationId>9c895ac4-df7e-43e0-87f8-8da151090902</ApplicationId>
    <ApplicationVersionId>e0ff0889-e20e-4440-bf81-b99c32ef68df</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>f852dde9-2b9d-4257-a80e-854be4d8c541</DeviceGroupId>
    <DeviceId>4229bffe-7c29-4b79-a6d6-83a99f64c0b9</DeviceId>
    <IgnoreNodeIdsInRouting xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
      <d3p1:string>sample string 3</d3p1:string>
    </IgnoreNodeIdsInRouting>
    <Name>sample string 4</Name>
    <NodeCyanId>6</NodeCyanId>
    <NodeId>f32c0ae1-a3fc-4467-b3e6-78a7ccde619f</NodeId>
    <NodeRouteId>65aeeead-6164-4149-98e1-66049037ab78</NodeRouteId>
    <TenantId>45b32499-58c1-4fea-912b-8c13487957f5</TenantId>
    <UserGroupId>c623bd49-5a9b-460a-bf51-50bfca6f96fc</UserGroupId>
    <UserId>32da01c8-7af7-4335-b5b3-bfd959561b53</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>