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": "cdab83cd-2235-4ba8-8dcc-5547e50ba6a5",
    "tenantId": "5f7c15a1-3987-4a1c-8a10-a2719d3a6da6",
    "userId": "ca12237f-b65a-4e09-a7f4-463b75571f8a",
    "userGroupId": "2d94aba6-26cf-4d87-8fdb-ce82ef98e5d9",
    "deviceId": "d056135c-bbd5-43f5-bcef-c5d542208b55",
    "deviceGroupId": "a8535ead-f23d-4f27-9560-cd979e6a5e68",
    "applicationId": "f63c71e4-43e1-4de2-958d-9c8707752522",
    "applicationVersionId": "4fec30d5-539a-4649-9684-29f493b5471a",
    "nodeId": "47712932-0575-4254-8969-4767afdff39e",
    "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-10-17T04:11:55.0981567+00:00",
    "updatedDateUtc": "2024-10-17T04:11:55.0981567+00:00"
  },
  {
    "nodeRouteId": "cdab83cd-2235-4ba8-8dcc-5547e50ba6a5",
    "tenantId": "5f7c15a1-3987-4a1c-8a10-a2719d3a6da6",
    "userId": "ca12237f-b65a-4e09-a7f4-463b75571f8a",
    "userGroupId": "2d94aba6-26cf-4d87-8fdb-ce82ef98e5d9",
    "deviceId": "d056135c-bbd5-43f5-bcef-c5d542208b55",
    "deviceGroupId": "a8535ead-f23d-4f27-9560-cd979e6a5e68",
    "applicationId": "f63c71e4-43e1-4de2-958d-9c8707752522",
    "applicationVersionId": "4fec30d5-539a-4649-9684-29f493b5471a",
    "nodeId": "47712932-0575-4254-8969-4767afdff39e",
    "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-10-17T04:11:55.0981567+00:00",
    "updatedDateUtc": "2024-10-17T04:11:55.0981567+00:00"
  },
  {
    "nodeRouteId": "cdab83cd-2235-4ba8-8dcc-5547e50ba6a5",
    "tenantId": "5f7c15a1-3987-4a1c-8a10-a2719d3a6da6",
    "userId": "ca12237f-b65a-4e09-a7f4-463b75571f8a",
    "userGroupId": "2d94aba6-26cf-4d87-8fdb-ce82ef98e5d9",
    "deviceId": "d056135c-bbd5-43f5-bcef-c5d542208b55",
    "deviceGroupId": "a8535ead-f23d-4f27-9560-cd979e6a5e68",
    "applicationId": "f63c71e4-43e1-4de2-958d-9c8707752522",
    "applicationVersionId": "4fec30d5-539a-4649-9684-29f493b5471a",
    "nodeId": "47712932-0575-4254-8969-4767afdff39e",
    "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-10-17T04:11:55.0981567+00:00",
    "updatedDateUtc": "2024-10-17T04:11:55.0981567+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>2024-10-17T04:11:55.0981567+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2024-10-17T04:11:55.0981567+00:00</UpdatedDateUtc>
    <ApplicationId>f63c71e4-43e1-4de2-958d-9c8707752522</ApplicationId>
    <ApplicationVersionId>4fec30d5-539a-4649-9684-29f493b5471a</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>a8535ead-f23d-4f27-9560-cd979e6a5e68</DeviceGroupId>
    <DeviceId>d056135c-bbd5-43f5-bcef-c5d542208b55</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>47712932-0575-4254-8969-4767afdff39e</NodeId>
    <NodeRouteId>cdab83cd-2235-4ba8-8dcc-5547e50ba6a5</NodeRouteId>
    <TenantId>5f7c15a1-3987-4a1c-8a10-a2719d3a6da6</TenantId>
    <UserGroupId>2d94aba6-26cf-4d87-8fdb-ce82ef98e5d9</UserGroupId>
    <UserId>ca12237f-b65a-4e09-a7f4-463b75571f8a</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2024-10-17T04:11:55.0981567+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2024-10-17T04:11:55.0981567+00:00</UpdatedDateUtc>
    <ApplicationId>f63c71e4-43e1-4de2-958d-9c8707752522</ApplicationId>
    <ApplicationVersionId>4fec30d5-539a-4649-9684-29f493b5471a</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>a8535ead-f23d-4f27-9560-cd979e6a5e68</DeviceGroupId>
    <DeviceId>d056135c-bbd5-43f5-bcef-c5d542208b55</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>47712932-0575-4254-8969-4767afdff39e</NodeId>
    <NodeRouteId>cdab83cd-2235-4ba8-8dcc-5547e50ba6a5</NodeRouteId>
    <TenantId>5f7c15a1-3987-4a1c-8a10-a2719d3a6da6</TenantId>
    <UserGroupId>2d94aba6-26cf-4d87-8fdb-ce82ef98e5d9</UserGroupId>
    <UserId>ca12237f-b65a-4e09-a7f4-463b75571f8a</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2024-10-17T04:11:55.0981567+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2024-10-17T04:11:55.0981567+00:00</UpdatedDateUtc>
    <ApplicationId>f63c71e4-43e1-4de2-958d-9c8707752522</ApplicationId>
    <ApplicationVersionId>4fec30d5-539a-4649-9684-29f493b5471a</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>a8535ead-f23d-4f27-9560-cd979e6a5e68</DeviceGroupId>
    <DeviceId>d056135c-bbd5-43f5-bcef-c5d542208b55</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>47712932-0575-4254-8969-4767afdff39e</NodeId>
    <NodeRouteId>cdab83cd-2235-4ba8-8dcc-5547e50ba6a5</NodeRouteId>
    <TenantId>5f7c15a1-3987-4a1c-8a10-a2719d3a6da6</TenantId>
    <UserGroupId>2d94aba6-26cf-4d87-8fdb-ce82ef98e5d9</UserGroupId>
    <UserId>ca12237f-b65a-4e09-a7f4-463b75571f8a</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>