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": "461a3cd3-5b08-4d65-a522-97ab327b9194",
    "tenantId": "afc43864-93aa-481a-8748-8ff834ea5955",
    "userId": "d259d5fe-dbf1-41b8-b148-02084afbc1b1",
    "userGroupId": "d990f6c3-7245-4081-aa38-a74c88bf45a2",
    "deviceId": "55a0d201-87d0-4d05-bd71-4c5211f512a0",
    "deviceGroupId": "221cb522-639e-4f8a-ac1f-8855a6670bda",
    "applicationId": "a34f2679-f469-477f-a3ef-6d3f8b2672d0",
    "applicationVersionId": "f1ecfc92-11bf-42cd-83b9-25596a36eab3",
    "nodeId": "a3000295-e88c-4fe4-b0cc-c71dd6d79c34",
    "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-11T17:29:46.4600558+00:00",
    "updatedDateUtc": "2025-12-11T17:29:46.4600558+00:00"
  },
  {
    "nodeRouteId": "461a3cd3-5b08-4d65-a522-97ab327b9194",
    "tenantId": "afc43864-93aa-481a-8748-8ff834ea5955",
    "userId": "d259d5fe-dbf1-41b8-b148-02084afbc1b1",
    "userGroupId": "d990f6c3-7245-4081-aa38-a74c88bf45a2",
    "deviceId": "55a0d201-87d0-4d05-bd71-4c5211f512a0",
    "deviceGroupId": "221cb522-639e-4f8a-ac1f-8855a6670bda",
    "applicationId": "a34f2679-f469-477f-a3ef-6d3f8b2672d0",
    "applicationVersionId": "f1ecfc92-11bf-42cd-83b9-25596a36eab3",
    "nodeId": "a3000295-e88c-4fe4-b0cc-c71dd6d79c34",
    "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-11T17:29:46.4600558+00:00",
    "updatedDateUtc": "2025-12-11T17:29:46.4600558+00:00"
  },
  {
    "nodeRouteId": "461a3cd3-5b08-4d65-a522-97ab327b9194",
    "tenantId": "afc43864-93aa-481a-8748-8ff834ea5955",
    "userId": "d259d5fe-dbf1-41b8-b148-02084afbc1b1",
    "userGroupId": "d990f6c3-7245-4081-aa38-a74c88bf45a2",
    "deviceId": "55a0d201-87d0-4d05-bd71-4c5211f512a0",
    "deviceGroupId": "221cb522-639e-4f8a-ac1f-8855a6670bda",
    "applicationId": "a34f2679-f469-477f-a3ef-6d3f8b2672d0",
    "applicationVersionId": "f1ecfc92-11bf-42cd-83b9-25596a36eab3",
    "nodeId": "a3000295-e88c-4fe4-b0cc-c71dd6d79c34",
    "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-11T17:29:46.4600558+00:00",
    "updatedDateUtc": "2025-12-11T17:29:46.4600558+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-11T17:29:46.4600558+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-11T17:29:46.4600558+00:00</UpdatedDateUtc>
    <ApplicationId>a34f2679-f469-477f-a3ef-6d3f8b2672d0</ApplicationId>
    <ApplicationVersionId>f1ecfc92-11bf-42cd-83b9-25596a36eab3</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>221cb522-639e-4f8a-ac1f-8855a6670bda</DeviceGroupId>
    <DeviceId>55a0d201-87d0-4d05-bd71-4c5211f512a0</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>a3000295-e88c-4fe4-b0cc-c71dd6d79c34</NodeId>
    <NodeRouteId>461a3cd3-5b08-4d65-a522-97ab327b9194</NodeRouteId>
    <TenantId>afc43864-93aa-481a-8748-8ff834ea5955</TenantId>
    <UserGroupId>d990f6c3-7245-4081-aa38-a74c88bf45a2</UserGroupId>
    <UserId>d259d5fe-dbf1-41b8-b148-02084afbc1b1</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-11T17:29:46.4600558+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-11T17:29:46.4600558+00:00</UpdatedDateUtc>
    <ApplicationId>a34f2679-f469-477f-a3ef-6d3f8b2672d0</ApplicationId>
    <ApplicationVersionId>f1ecfc92-11bf-42cd-83b9-25596a36eab3</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>221cb522-639e-4f8a-ac1f-8855a6670bda</DeviceGroupId>
    <DeviceId>55a0d201-87d0-4d05-bd71-4c5211f512a0</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>a3000295-e88c-4fe4-b0cc-c71dd6d79c34</NodeId>
    <NodeRouteId>461a3cd3-5b08-4d65-a522-97ab327b9194</NodeRouteId>
    <TenantId>afc43864-93aa-481a-8748-8ff834ea5955</TenantId>
    <UserGroupId>d990f6c3-7245-4081-aa38-a74c88bf45a2</UserGroupId>
    <UserId>d259d5fe-dbf1-41b8-b148-02084afbc1b1</UserId>
  </NodeRouteRepresentation>
  <NodeRouteRepresentation>
    <CreatedDateUtc>2025-12-11T17:29:46.4600558+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-11T17:29:46.4600558+00:00</UpdatedDateUtc>
    <ApplicationId>a34f2679-f469-477f-a3ef-6d3f8b2672d0</ApplicationId>
    <ApplicationVersionId>f1ecfc92-11bf-42cd-83b9-25596a36eab3</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>221cb522-639e-4f8a-ac1f-8855a6670bda</DeviceGroupId>
    <DeviceId>55a0d201-87d0-4d05-bd71-4c5211f512a0</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>a3000295-e88c-4fe4-b0cc-c71dd6d79c34</NodeId>
    <NodeRouteId>461a3cd3-5b08-4d65-a522-97ab327b9194</NodeRouteId>
    <TenantId>afc43864-93aa-481a-8748-8ff834ea5955</TenantId>
    <UserGroupId>d990f6c3-7245-4081-aa38-a74c88bf45a2</UserGroupId>
    <UserId>d259d5fe-dbf1-41b8-b148-02084afbc1b1</UserId>
  </NodeRouteRepresentation>
</ArrayOfNodeRouteRepresentation>