Cyan Web API - Version 1

GET api/nodeRoutes?{nodeId}

            Gets all of the NodeRoutes for a Node

Request Information

Parameters

Name	Description	Additional information
nodeId		Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "nodeRouteId": "5a1a8a5e-4a75-4ee0-9ca4-f9ea5bbf9552",
    "tenantId": "20a18b3c-b145-4b9b-b6da-d46be205e7ce",
    "userId": "045038ed-1005-4067-b3bd-d349ef072e0b",
    "userGroupId": "f4b101d7-02b0-4725-8abf-045824934d7f",
    "deviceId": "3e65ee25-3535-4064-9852-3ecd72820c3a",
    "deviceGroupId": "cc1e6626-f175-4864-9534-6db16b9db0ba",
    "applicationId": "f8495ec0-c233-4425-a570-e0eaea6cf6ca",
    "applicationVersionId": "f08a21b1-e088-4fb2-9a40-51c1e309d665",
    "nodeId": "bee0fff2-5a22-4405-b600-59349dda6dd4",
    "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:43:27.5568001+00:00",
    "updatedDateUtc": "2025-04-21T01:43:27.5568001+00:00"
  },
  {
    "nodeRouteId": "5a1a8a5e-4a75-4ee0-9ca4-f9ea5bbf9552",
    "tenantId": "20a18b3c-b145-4b9b-b6da-d46be205e7ce",
    "userId": "045038ed-1005-4067-b3bd-d349ef072e0b",
    "userGroupId": "f4b101d7-02b0-4725-8abf-045824934d7f",
    "deviceId": "3e65ee25-3535-4064-9852-3ecd72820c3a",
    "deviceGroupId": "cc1e6626-f175-4864-9534-6db16b9db0ba",
    "applicationId": "f8495ec0-c233-4425-a570-e0eaea6cf6ca",
    "applicationVersionId": "f08a21b1-e088-4fb2-9a40-51c1e309d665",
    "nodeId": "bee0fff2-5a22-4405-b600-59349dda6dd4",
    "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:43:27.5568001+00:00",
    "updatedDateUtc": "2025-04-21T01:43:27.5568001+00:00"
  },
  {
    "nodeRouteId": "5a1a8a5e-4a75-4ee0-9ca4-f9ea5bbf9552",
    "tenantId": "20a18b3c-b145-4b9b-b6da-d46be205e7ce",
    "userId": "045038ed-1005-4067-b3bd-d349ef072e0b",
    "userGroupId": "f4b101d7-02b0-4725-8abf-045824934d7f",
    "deviceId": "3e65ee25-3535-4064-9852-3ecd72820c3a",
    "deviceGroupId": "cc1e6626-f175-4864-9534-6db16b9db0ba",
    "applicationId": "f8495ec0-c233-4425-a570-e0eaea6cf6ca",
    "applicationVersionId": "f08a21b1-e088-4fb2-9a40-51c1e309d665",
    "nodeId": "bee0fff2-5a22-4405-b600-59349dda6dd4",
    "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:43:27.5568001+00:00",
    "updatedDateUtc": "2025-04-21T01:43:27.5568001+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-04-21T01:43:27.5568001+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-04-21T01:43:27.5568001+00:00</UpdatedDateUtc>
    <ApplicationId>f8495ec0-c233-4425-a570-e0eaea6cf6ca</ApplicationId>
    <ApplicationVersionId>f08a21b1-e088-4fb2-9a40-51c1e309d665</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>cc1e6626-f175-4864-9534-6db16b9db0ba</DeviceGroupId>
    <DeviceId>3e65ee25-3535-4064-9852-3ecd72820c3a</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>bee0fff2-5a22-4405-b600-59349dda6dd4</NodeId>
    <NodeRouteId>5a1a8a5e-4a75-4ee0-9ca4-f9ea5bbf9552</NodeRouteId>
    <TenantId>20a18b3c-b145-4b9b-b6da-d46be205e7ce</TenantId>
    <UserGroupId>f4b101d7-02b0-4725-8abf-045824934d7f</UserGroupId>
    <UserId>045038ed-1005-4067-b3bd-d349ef072e0b</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-04-21T01:43:27.5568001+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-04-21T01:43:27.5568001+00:00</UpdatedDateUtc>
    <ApplicationId>f8495ec0-c233-4425-a570-e0eaea6cf6ca</ApplicationId>
    <ApplicationVersionId>f08a21b1-e088-4fb2-9a40-51c1e309d665</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>cc1e6626-f175-4864-9534-6db16b9db0ba</DeviceGroupId>
    <DeviceId>3e65ee25-3535-4064-9852-3ecd72820c3a</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>bee0fff2-5a22-4405-b600-59349dda6dd4</NodeId>
    <NodeRouteId>5a1a8a5e-4a75-4ee0-9ca4-f9ea5bbf9552</NodeRouteId>
    <TenantId>20a18b3c-b145-4b9b-b6da-d46be205e7ce</TenantId>
    <UserGroupId>f4b101d7-02b0-4725-8abf-045824934d7f</UserGroupId>
    <UserId>045038ed-1005-4067-b3bd-d349ef072e0b</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-04-21T01:43:27.5568001+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-04-21T01:43:27.5568001+00:00</UpdatedDateUtc>
    <ApplicationId>f8495ec0-c233-4425-a570-e0eaea6cf6ca</ApplicationId>
    <ApplicationVersionId>f08a21b1-e088-4fb2-9a40-51c1e309d665</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>cc1e6626-f175-4864-9534-6db16b9db0ba</DeviceGroupId>
    <DeviceId>3e65ee25-3535-4064-9852-3ecd72820c3a</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>bee0fff2-5a22-4405-b600-59349dda6dd4</NodeId>
    <NodeRouteId>5a1a8a5e-4a75-4ee0-9ca4-f9ea5bbf9552</NodeRouteId>
    <TenantId>20a18b3c-b145-4b9b-b6da-d46be205e7ce</TenantId>
    <UserGroupId>f4b101d7-02b0-4725-8abf-045824934d7f</UserGroupId>
    <UserId>045038ed-1005-4067-b3bd-d349ef072e0b</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>