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": "bfebc51f-2328-468a-896a-c9ddc8fee6ca",
    "tenantId": "001f8031-730e-48ce-95a2-5425ec5f8d45",
    "userId": "867247a9-f195-43fa-b852-043ed34e8fde",
    "userGroupId": "1a57a18c-c2da-4624-88cd-8a14982ac02b",
    "deviceId": "963622f0-db87-4785-8b96-f3bc7e23429a",
    "deviceGroupId": "d405ef16-57f8-4b83-80ce-811be8a55555",
    "applicationId": "e5fcdd33-1658-4b39-92ab-b2f6d2a90a92",
    "applicationVersionId": "ca878e47-e3f7-4f5c-91ca-749dc698602c",
    "nodeId": "d2ee39c0-39e6-433a-9ede-8ecc92478d6b",
    "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-30T09:42:53.5777025+00:00",
    "updatedDateUtc": "2024-08-30T09:42:53.5777025+00:00"
  },
  {
    "nodeRouteId": "bfebc51f-2328-468a-896a-c9ddc8fee6ca",
    "tenantId": "001f8031-730e-48ce-95a2-5425ec5f8d45",
    "userId": "867247a9-f195-43fa-b852-043ed34e8fde",
    "userGroupId": "1a57a18c-c2da-4624-88cd-8a14982ac02b",
    "deviceId": "963622f0-db87-4785-8b96-f3bc7e23429a",
    "deviceGroupId": "d405ef16-57f8-4b83-80ce-811be8a55555",
    "applicationId": "e5fcdd33-1658-4b39-92ab-b2f6d2a90a92",
    "applicationVersionId": "ca878e47-e3f7-4f5c-91ca-749dc698602c",
    "nodeId": "d2ee39c0-39e6-433a-9ede-8ecc92478d6b",
    "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-30T09:42:53.5777025+00:00",
    "updatedDateUtc": "2024-08-30T09:42:53.5777025+00:00"
  },
  {
    "nodeRouteId": "bfebc51f-2328-468a-896a-c9ddc8fee6ca",
    "tenantId": "001f8031-730e-48ce-95a2-5425ec5f8d45",
    "userId": "867247a9-f195-43fa-b852-043ed34e8fde",
    "userGroupId": "1a57a18c-c2da-4624-88cd-8a14982ac02b",
    "deviceId": "963622f0-db87-4785-8b96-f3bc7e23429a",
    "deviceGroupId": "d405ef16-57f8-4b83-80ce-811be8a55555",
    "applicationId": "e5fcdd33-1658-4b39-92ab-b2f6d2a90a92",
    "applicationVersionId": "ca878e47-e3f7-4f5c-91ca-749dc698602c",
    "nodeId": "d2ee39c0-39e6-433a-9ede-8ecc92478d6b",
    "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-30T09:42:53.5777025+00:00",
    "updatedDateUtc": "2024-08-30T09:42:53.5777025+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-08-30T09:42:53.5777025+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2024-08-30T09:42:53.5777025+00:00</UpdatedDateUtc>
    <ApplicationId>e5fcdd33-1658-4b39-92ab-b2f6d2a90a92</ApplicationId>
    <ApplicationVersionId>ca878e47-e3f7-4f5c-91ca-749dc698602c</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>d405ef16-57f8-4b83-80ce-811be8a55555</DeviceGroupId>
    <DeviceId>963622f0-db87-4785-8b96-f3bc7e23429a</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>d2ee39c0-39e6-433a-9ede-8ecc92478d6b</NodeId>
    <NodeRouteId>bfebc51f-2328-468a-896a-c9ddc8fee6ca</NodeRouteId>
    <TenantId>001f8031-730e-48ce-95a2-5425ec5f8d45</TenantId>
    <UserGroupId>1a57a18c-c2da-4624-88cd-8a14982ac02b</UserGroupId>
    <UserId>867247a9-f195-43fa-b852-043ed34e8fde</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2024-08-30T09:42:53.5777025+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2024-08-30T09:42:53.5777025+00:00</UpdatedDateUtc>
    <ApplicationId>e5fcdd33-1658-4b39-92ab-b2f6d2a90a92</ApplicationId>
    <ApplicationVersionId>ca878e47-e3f7-4f5c-91ca-749dc698602c</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>d405ef16-57f8-4b83-80ce-811be8a55555</DeviceGroupId>
    <DeviceId>963622f0-db87-4785-8b96-f3bc7e23429a</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>d2ee39c0-39e6-433a-9ede-8ecc92478d6b</NodeId>
    <NodeRouteId>bfebc51f-2328-468a-896a-c9ddc8fee6ca</NodeRouteId>
    <TenantId>001f8031-730e-48ce-95a2-5425ec5f8d45</TenantId>
    <UserGroupId>1a57a18c-c2da-4624-88cd-8a14982ac02b</UserGroupId>
    <UserId>867247a9-f195-43fa-b852-043ed34e8fde</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2024-08-30T09:42:53.5777025+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2024-08-30T09:42:53.5777025+00:00</UpdatedDateUtc>
    <ApplicationId>e5fcdd33-1658-4b39-92ab-b2f6d2a90a92</ApplicationId>
    <ApplicationVersionId>ca878e47-e3f7-4f5c-91ca-749dc698602c</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>d405ef16-57f8-4b83-80ce-811be8a55555</DeviceGroupId>
    <DeviceId>963622f0-db87-4785-8b96-f3bc7e23429a</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>d2ee39c0-39e6-433a-9ede-8ecc92478d6b</NodeId>
    <NodeRouteId>bfebc51f-2328-468a-896a-c9ddc8fee6ca</NodeRouteId>
    <TenantId>001f8031-730e-48ce-95a2-5425ec5f8d45</TenantId>
    <UserGroupId>1a57a18c-c2da-4624-88cd-8a14982ac02b</UserGroupId>
    <UserId>867247a9-f195-43fa-b852-043ed34e8fde</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>