Cyan Web API - Version 1

GET api/nodes

            Gets node resources.
             Calling this method with no query string parameters will return all nodes for a Tenant (not recommended).
             If you call this method with query string parameters, these will be used to query for Nodes using the NodeIndex table,
             or other special query mechanisms.
            
             For example, if you have created a Node with a property like "assignedTo" = "DGOOD" in the props bag, and also inserted
             a NodeIndex record with PropertyKey="assignedTo", and PropertyValue="DGOOD", you can issue a GET request to
             
             api/nodes?assignedTo=DGOOD
             
             This will run a query against the NodeIndex table to locate nodes that are indexed by the specified query parameters.
            
             In addition to searching the NodeIndex table to locate nodes, you can also pass special search keys to search based
             on other node-related properties:
             
             Special search keys:
             
             nodeNodeId - serach by the Node's "NodeId" (exact match).  Note: this is the NodeId GUID column, not the Node "Id" string.
             nodeType - search by the Node's "Type" (exact match)
             nodeId - search by the Node's "Id" (exact match)
             nodeParentType - search by the Node's "ParentType" (exact match)
             nodeParentId - search by the Node's "ParentId" (exact match)
             nodeTitle - search by the Node's "Title" (partial match or exact match with = modifier)
             nodeBody - search by the Node's raw "Body" JSON string (partial match) (this is not recommended, as the Node Body may not be in a predictable or easily-queryable format)
             nodeCreatedBeforeUtc - find all nodes that were created, or have NodeIndices that were created before the given UTC date time (non-inclusive)
             nodeCreatedAfterUtc - find all nodes that were created, or have NodeIndices that were created at or after the given UTC date time (inclusive)
             nodeUpdatedBeforeUtc - find all nodes that were last updated, or have NodeIndices that were last updated before the given UTC date time (non-inclusive)
             nodeUpdatedAfterUtc - find all nodes that were last updated, or have NodeIndices that were last updated at or after the given UTC date time (inclusive)
             nodeHasRoutes - "true": find nodes that have one or more routes, "false": find nodes that have no routes
             nodeRouteApplicationId - find nodes that have a route which matches this ApplicationId, or the route has null for ApplicationId
             nodeRouteApplicationVersionId - find nodes that have a route which matches this ApplicationVersionId, or the route has null for ApplicationVersionId
             nodeRouteUserId - find nodes that have a route which matches this UserId, or the route has null for UserId
             nodeRouteUserGroupId - find nodes that have a route which matches this UserGroupId, or the route has null for UserGroupId
             nodeRouteDeviceId - find nodes that have a route which matches this DeviceId, or the route has null for DeviceId
             nodeRouteDeviceGroupId - find nodes that have a route which matches this DeviceGroupId, or the route has null for DeviceGroupId
             nodeSkip - an integer that defines the number of records to skip (for paging)
             nodeTake - in integer that defines the number of records to take (for paging)

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "tenantId": "83d6b686-e616-4ba8-aa82-b35422317e61",
    "nodeId": "352e9fab-366c-4b8a-be62-59f3b58ea1b3",
    "type": "sample string 3",
    "id": "sample string 4",
    "parentType": "sample string 5",
    "parentId": "sample string 6",
    "title": "sample string 7",
    "props": {
      "sample string 1": {},
      "sample string 3": {},
      "sample string 5": {}
    },
    "refs": {
      "sample string 1": {
        "type": "sample string 1",
        "id": "sample string 2"
      },
      "sample string 2": {
        "type": "sample string 1",
        "id": "sample string 2"
      },
      "sample string 3": {
        "type": "sample string 1",
        "id": "sample string 2"
      }
    },
    "cyanId": 8,
    "subjectToCleanup": true,
    "createdDateUtc": "2025-04-21T01:37:14.7301566+00:00",
    "updatedDateUtc": "2025-04-21T01:37:14.7301566+00:00"
  },
  {
    "tenantId": "83d6b686-e616-4ba8-aa82-b35422317e61",
    "nodeId": "352e9fab-366c-4b8a-be62-59f3b58ea1b3",
    "type": "sample string 3",
    "id": "sample string 4",
    "parentType": "sample string 5",
    "parentId": "sample string 6",
    "title": "sample string 7",
    "props": {
      "sample string 1": {},
      "sample string 3": {},
      "sample string 5": {}
    },
    "refs": {
      "sample string 1": {
        "type": "sample string 1",
        "id": "sample string 2"
      },
      "sample string 2": {
        "type": "sample string 1",
        "id": "sample string 2"
      },
      "sample string 3": {
        "type": "sample string 1",
        "id": "sample string 2"
      }
    },
    "cyanId": 8,
    "subjectToCleanup": true,
    "createdDateUtc": "2025-04-21T01:37:14.7301566+00:00",
    "updatedDateUtc": "2025-04-21T01:37:14.7301566+00:00"
  },
  {
    "tenantId": "83d6b686-e616-4ba8-aa82-b35422317e61",
    "nodeId": "352e9fab-366c-4b8a-be62-59f3b58ea1b3",
    "type": "sample string 3",
    "id": "sample string 4",
    "parentType": "sample string 5",
    "parentId": "sample string 6",
    "title": "sample string 7",
    "props": {
      "sample string 1": {},
      "sample string 3": {},
      "sample string 5": {}
    },
    "refs": {
      "sample string 1": {
        "type": "sample string 1",
        "id": "sample string 2"
      },
      "sample string 2": {
        "type": "sample string 1",
        "id": "sample string 2"
      },
      "sample string 3": {
        "type": "sample string 1",
        "id": "sample string 2"
      }
    },
    "cyanId": 8,
    "subjectToCleanup": true,
    "createdDateUtc": "2025-04-21T01:37:14.7301566+00:00",
    "updatedDateUtc": "2025-04-21T01:37:14.7301566+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfNodeRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <NodeRepresentation>
    <CreatedDateUtc>2025-04-21T01:37:14.7301566+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-04-21T01:37:14.7301566+00:00</UpdatedDateUtc>
    <CyanId>8</CyanId>
    <Id>sample string 4</Id>
    <NodeId>352e9fab-366c-4b8a-be62-59f3b58ea1b3</NodeId>
    <ParentId>sample string 6</ParentId>
    <ParentType>sample string 5</ParentType>
    <Props xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 5</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Props>
    <Refs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>
          <Id>sample string 2</Id>
          <Type>sample string 1</Type>
        </d3p1:Value>
      </d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
      <d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d3p1:Key>sample string 2</d3p1:Key>
        <d3p1:Value>
          <Id>sample string 2</Id>
          <Type>sample string 1</Type>
        </d3p1:Value>
      </d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
      <d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>
          <Id>sample string 2</Id>
          <Type>sample string 1</Type>
        </d3p1:Value>
      </d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
    </Refs>
    <SubjectToCleanup>true</SubjectToCleanup>
    <TenantId>83d6b686-e616-4ba8-aa82-b35422317e61</TenantId>
    <Title>sample string 7</Title>
    <Type>sample string 3</Type>
  </NodeRepresentation>
  <NodeRepresentation>
    <CreatedDateUtc>2025-04-21T01:37:14.7301566+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-04-21T01:37:14.7301566+00:00</UpdatedDateUtc>
    <CyanId>8</CyanId>
    <Id>sample string 4</Id>
    <NodeId>352e9fab-366c-4b8a-be62-59f3b58ea1b3</NodeId>
    <ParentId>sample string 6</ParentId>
    <ParentType>sample string 5</ParentType>
    <Props xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 5</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Props>
    <Refs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>
          <Id>sample string 2</Id>
          <Type>sample string 1</Type>
        </d3p1:Value>
      </d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
      <d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d3p1:Key>sample string 2</d3p1:Key>
        <d3p1:Value>
          <Id>sample string 2</Id>
          <Type>sample string 1</Type>
        </d3p1:Value>
      </d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
      <d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>
          <Id>sample string 2</Id>
          <Type>sample string 1</Type>
        </d3p1:Value>
      </d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
    </Refs>
    <SubjectToCleanup>true</SubjectToCleanup>
    <TenantId>83d6b686-e616-4ba8-aa82-b35422317e61</TenantId>
    <Title>sample string 7</Title>
    <Type>sample string 3</Type>
  </NodeRepresentation>
  <NodeRepresentation>
    <CreatedDateUtc>2025-04-21T01:37:14.7301566+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-04-21T01:37:14.7301566+00:00</UpdatedDateUtc>
    <CyanId>8</CyanId>
    <Id>sample string 4</Id>
    <NodeId>352e9fab-366c-4b8a-be62-59f3b58ea1b3</NodeId>
    <ParentId>sample string 6</ParentId>
    <ParentType>sample string 5</ParentType>
    <Props xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>sample string 5</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Props>
    <Refs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>
          <Id>sample string 2</Id>
          <Type>sample string 1</Type>
        </d3p1:Value>
      </d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
      <d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d3p1:Key>sample string 2</d3p1:Key>
        <d3p1:Value>
          <Id>sample string 2</Id>
          <Type>sample string 1</Type>
        </d3p1:Value>
      </d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
      <d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>
          <Id>sample string 2</Id>
          <Type>sample string 1</Type>
        </d3p1:Value>
      </d3p1:KeyValueOfstringNodeRefRepresentationPuhFCfmt>
    </Refs>
    <SubjectToCleanup>true</SubjectToCleanup>
    <TenantId>83d6b686-e616-4ba8-aa82-b35422317e61</TenantId>
    <Title>sample string 7</Title>
    <Type>sample string 3</Type>
  </NodeRepresentation>
</ArrayOfNodeRepresentation>