Cyan Web API - Version 1

GET api/nodeRoutes

            Gets all NodeRoutes for a tenant.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "nodeRouteId": "0fd6f259-d893-43f7-b253-585b6e5a96ec",
    "tenantId": "22975de0-aaeb-43a6-9bd0-16ccfc639db3",
    "userId": "2c210ecb-e32d-430e-9766-484e0450195d",
    "userGroupId": "2a06c839-2b8f-4d6b-a0e2-5f5a8a25a007",
    "deviceId": "2d44fd9e-5bfb-465c-a916-b4d1db9467b5",
    "deviceGroupId": "33533885-dcd3-4fe4-9a56-8db7a8158b42",
    "applicationId": "6ce8dfa8-3ef2-4174-b17b-dbd161eda258",
    "applicationVersionId": "a9d02c7f-7c0f-4d6e-a0d1-203cd98efbf3",
    "nodeId": "94657e10-8188-48a4-9908-2be84d332259",
    "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-07-05T15:48:47.4301951+00:00",
    "updatedDateUtc": "2025-07-05T15:48:47.4301951+00:00"
  },
  {
    "nodeRouteId": "0fd6f259-d893-43f7-b253-585b6e5a96ec",
    "tenantId": "22975de0-aaeb-43a6-9bd0-16ccfc639db3",
    "userId": "2c210ecb-e32d-430e-9766-484e0450195d",
    "userGroupId": "2a06c839-2b8f-4d6b-a0e2-5f5a8a25a007",
    "deviceId": "2d44fd9e-5bfb-465c-a916-b4d1db9467b5",
    "deviceGroupId": "33533885-dcd3-4fe4-9a56-8db7a8158b42",
    "applicationId": "6ce8dfa8-3ef2-4174-b17b-dbd161eda258",
    "applicationVersionId": "a9d02c7f-7c0f-4d6e-a0d1-203cd98efbf3",
    "nodeId": "94657e10-8188-48a4-9908-2be84d332259",
    "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-07-05T15:48:47.4301951+00:00",
    "updatedDateUtc": "2025-07-05T15:48:47.4301951+00:00"
  },
  {
    "nodeRouteId": "0fd6f259-d893-43f7-b253-585b6e5a96ec",
    "tenantId": "22975de0-aaeb-43a6-9bd0-16ccfc639db3",
    "userId": "2c210ecb-e32d-430e-9766-484e0450195d",
    "userGroupId": "2a06c839-2b8f-4d6b-a0e2-5f5a8a25a007",
    "deviceId": "2d44fd9e-5bfb-465c-a916-b4d1db9467b5",
    "deviceGroupId": "33533885-dcd3-4fe4-9a56-8db7a8158b42",
    "applicationId": "6ce8dfa8-3ef2-4174-b17b-dbd161eda258",
    "applicationVersionId": "a9d02c7f-7c0f-4d6e-a0d1-203cd98efbf3",
    "nodeId": "94657e10-8188-48a4-9908-2be84d332259",
    "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-07-05T15:48:47.4301951+00:00",
    "updatedDateUtc": "2025-07-05T15:48:47.4301951+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-07-05T15:48:47.4301951+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T15:48:47.4301951+00:00</UpdatedDateUtc>
    <ApplicationId>6ce8dfa8-3ef2-4174-b17b-dbd161eda258</ApplicationId>
    <ApplicationVersionId>a9d02c7f-7c0f-4d6e-a0d1-203cd98efbf3</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>33533885-dcd3-4fe4-9a56-8db7a8158b42</DeviceGroupId>
    <DeviceId>2d44fd9e-5bfb-465c-a916-b4d1db9467b5</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>94657e10-8188-48a4-9908-2be84d332259</NodeId>
    <NodeRouteId>0fd6f259-d893-43f7-b253-585b6e5a96ec</NodeRouteId>
    <TenantId>22975de0-aaeb-43a6-9bd0-16ccfc639db3</TenantId>
    <UserGroupId>2a06c839-2b8f-4d6b-a0e2-5f5a8a25a007</UserGroupId>
    <UserId>2c210ecb-e32d-430e-9766-484e0450195d</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-07-05T15:48:47.4301951+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T15:48:47.4301951+00:00</UpdatedDateUtc>
    <ApplicationId>6ce8dfa8-3ef2-4174-b17b-dbd161eda258</ApplicationId>
    <ApplicationVersionId>a9d02c7f-7c0f-4d6e-a0d1-203cd98efbf3</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>33533885-dcd3-4fe4-9a56-8db7a8158b42</DeviceGroupId>
    <DeviceId>2d44fd9e-5bfb-465c-a916-b4d1db9467b5</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>94657e10-8188-48a4-9908-2be84d332259</NodeId>
    <NodeRouteId>0fd6f259-d893-43f7-b253-585b6e5a96ec</NodeRouteId>
    <TenantId>22975de0-aaeb-43a6-9bd0-16ccfc639db3</TenantId>
    <UserGroupId>2a06c839-2b8f-4d6b-a0e2-5f5a8a25a007</UserGroupId>
    <UserId>2c210ecb-e32d-430e-9766-484e0450195d</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-07-05T15:48:47.4301951+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T15:48:47.4301951+00:00</UpdatedDateUtc>
    <ApplicationId>6ce8dfa8-3ef2-4174-b17b-dbd161eda258</ApplicationId>
    <ApplicationVersionId>a9d02c7f-7c0f-4d6e-a0d1-203cd98efbf3</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>33533885-dcd3-4fe4-9a56-8db7a8158b42</DeviceGroupId>
    <DeviceId>2d44fd9e-5bfb-465c-a916-b4d1db9467b5</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>94657e10-8188-48a4-9908-2be84d332259</NodeId>
    <NodeRouteId>0fd6f259-d893-43f7-b253-585b6e5a96ec</NodeRouteId>
    <TenantId>22975de0-aaeb-43a6-9bd0-16ccfc639db3</TenantId>
    <UserGroupId>2a06c839-2b8f-4d6b-a0e2-5f5a8a25a007</UserGroupId>
    <UserId>2c210ecb-e32d-430e-9766-484e0450195d</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>