Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Data Structure Filters

List data structure filters

get

Returns available data structure filters based on the caller's permissions and provided parameters.

Responses
200

Data structure filters

application/json
get/api/data_structure_filters
GET /api/data_structure_filters HTTP/1.1
Accept: */*

{
  "data": {
    "system_id": [
      "1"
    ],
    "type": [
      "TABLE"
    ]
  }
}

Get bucket paths

post

Retrieves bucket paths for the given filters using the caller's permissions.

Body
bucketstringOptional

Bucket name

prefixstringOptional

Prefix to filter paths

Other propertiesanyOptional
Responses
200

Bucket paths response

application/json
post/api/buckets/paths
POST /api/buckets/paths HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "bucket": "some-bucket",
  "prefix": "data/"
}
{
  "filtered_children": {
    "1": [
      2,
      3
    ],
    "4": []
  },
  "forest": {
    "1": {
      "2": {},
      "3": {}
    },
    "4": {}
  }
}

Search data structure filters

post

Searches data structure filters using the provided filter payload and the caller's permissions.

Body
link_structuresbooleanOptional

If true, filter by structures that can be linked

my_grant_requestsbooleanOptional

If true, filter by grant requests for current user

pageintegerOptional

Page number

Default: 0
querystringOptional

Full-text search query

scrollstringOptional

Scroll timeout

scroll_idstringOptional

Scroll ID for pagination

sizeintegerOptional

Page size

Default: 50
Other propertiesanyOptional
Responses
200

Filtered results

application/json
post/api/data_structure_filters/search
POST /api/data_structure_filters/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "filters": {
    "system_id": 1
  },
  "my_grant_requests": true,
  "page": 0,
  "query": "name",
  "size": 20
}
{
  "data": {
    "system_id": [
      "1"
    ],
    "type": [
      "TABLE"
    ]
  }
}

Last updated