Table List

get

List tables

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

database_idstringRequired

Query parameters

column_keywordstringOptional

elements_per_pageintegerOptional

from_pageintegerOptional

is_excludedbooleanOptional

requested_pageintegerOptional

schema_namesstringOptional

start_indexintegerOptional

sync_statusbooleanOptional

table_keywordstringOptional

to_pageintegerOptional

Responses

200

Success: List of tables

application/json

n_excludedinteger · nullableOptionalDefault: null

503

Message: unable to fetch database from external service

get/api/v1/table/{database_id}/filter/

HTTPcURLJavaScriptPython

GET /api/v1/table/{database_id}/filter/ HTTP/1.1
Accept: */*

{
  "tables": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "n_rows": 1,
      "n_rows_source": 1,
      "fk_scan": true,
      "is_excluded": true,
      "processing_config": {
        "type": "text"
      },
      "n_training_rows": 1,
      "adjust_n_rows_allowed": true,
      "order_by_columns": [
        "text"
      ],
      "database_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "schema_name_source": "text",
      "schema_name_target": "text",
      "primary_keys": [],
      "unique_columns": [
        [
          "text"
        ]
      ],
      "index_columns": [
        [
          "text"
        ]
      ],
      "check_constraints": [
        {}
      ],
      "data_in_target": true,
      "sample_noise_ratio": 1,
      "max_n_feat_per_model": 1,
      "feat_model_train_order": "text",
      "min_sample_size": 1,
      "columns": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "table_id": "123e4567-e89b-12d3-a456-426614174000",
          "generator_id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "idx": 1,
          "dtype": "text",
          "col_dtype": "categorical",
          "sql_type": "text",
          "unique": true,
          "nullable": true,
          "autoincrement": true,
          "pii_scan": true,
          "has_pii": true,
          "has_unprotected_pii": true,
          "min_value": "text",
          "max_value": "text",
          "pii": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "column_id": "123e4567-e89b-12d3-a456-426614174000",
              "pii_type": "text",
              "confidence_score": 1,
              "scan_type": "text",
              "explanation": {},
              "generation_method": "text"
            }
          ],
          "cardinality_threshold": 1,
          "rare_category_replacement": "text",
          "clip_threshold": 1,
          "locale": "text",
          "pii_mock_replace": true,
          "pii_deselected_entities": [
            "text"
          ],
          "generator_config": {
            "name": "text",
            "display_name": "AI synthesize",
            "params": {},
            "links": [
              {
                "association": "text",
                "params": {},
                "generator": {}
              }
            ],
            "is_default": false,
            "is_applied": true
          },
          "default_generator_config": {
            "name": "text",
            "display_name": "AI synthesize",
            "params": {},
            "links": [
              {
                "association": "text",
                "params": {},
                "generator": {}
              }
            ],
            "is_default": false,
            "is_applied": true
          },
          "is_rejected": true,
          "is_key": true,
          "is_pk": true,
          "is_fk": true,
          "is_uk": true,
          "is_referred": true,
          "database_exclude_from_write": true,
          "sync_status": "new",
          "sync_diff": [
            "DATA_TYPE_UPDATE"
          ]
        }
      ],
      "n_columns": 1,
      "subsetting_config": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "table_id": "123e4567-e89b-12d3-a456-426614174000",
        "processing_type": "text",
        "percentage": 1,
        "is_linked": true,
        "where_clause": "text"
      },
      "has_unprotected_pii": true,
      "sync_status": "new",
      "sync_diff": [
        "PRIMARY_KEY_UPDATE"
      ],
      "warnings": [
        "HAS_EXCLUDED_REFERENCES"
      ],
      "index": 1,
      "kind": "text"
    }
  ],
  "n_excluded": 1,
  "pagination": {
    "total_elements": 1,
    "total_pages": 1,
    "current_page": 1,
    "returned_elements": 1,
    "is_last_page": true
  }
}