Table

put

Update table

Authorizations

authenticationOIDC

sessionidstringRequired

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

Body

application/json

Responses

200

Success: updated table

application/json

idsany ofOptionalDefault: null

string · uuid[]Optional

or

nullOptional

statusstringRequired

503

Message: unable to fetch table from external service

put

/api/v1/table/

HTTPcURLJavaScriptPython

PUT /api/v1/table/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 312

{
  "tables": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "n_rows": 1,
      "n_rows_source": 1,
      "fk_scan": true,
      "is_excluded": true,
      "processing_config": {
        "type": "text"
      },
      "read_random_subset": true,
      "n_training_rows": 1,
      "max_sequence_length": 1,
      "long_sequence_threshold": 1,
      "adjust_n_rows_allowed": true,
      "order_by_columns": [
        "text"
      ]
    }
  ]
}

{
  "ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "status": "text"
}

put

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

database_idstringRequired

Query parameters

is_excludedbooleanRequired

Body

application/json

schema_namesany ofOptionalDefault: null

string[]Optional

or

nullOptional

table_idsany ofOptionalDefault: null

string · uuid[]Optional

or

nullOptional

not_table_idsany ofOptionalDefault: null

string · uuid[]Optional

or

nullOptional

table_keywordany ofOptionalDefault: null

stringOptional

or

nullOptional

column_keywordany ofOptionalDefault: null

stringOptional

or

nullOptional

schema_entitiesany ofOptionalDefault: null

or

nullOptional

Responses

204

No response body

put

/api/v1/table/{database_id}/exclude/

HTTPcURLJavaScriptPython

PUT /api/v1/table/{database_id}/exclude/?is_excluded=true HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 242

{
  "schema_names": [
    "text"
  ],
  "table_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "not_table_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "table_keyword": "text",
  "column_keyword": "text",
  "schema_entities": [
    {
      "schema_name": "text",
      "entity": "table"
    }
  ]
}

204

No response body

No content

get

Get single table

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

table_idstringRequired

Responses

200

Success: Single table

application/json

idstring · uuidRequired

n_rowsany ofOptionalDefault: null

integerOptional

or

nullOptional

n_rows_sourceany ofOptionalDefault: null

integerOptional

or

nullOptional

fk_scanany ofOptionalDefault: null

booleanOptional

or

nullOptional

is_excludedany ofOptionalDefault: null

booleanOptional

or

nullOptional

processing_configany ofOptionalDefault: null

or

or

nullOptional

read_random_subsetany ofOptionalDefault: null

booleanOptional

or

nullOptional

n_training_rowsany ofOptionalDefault: null

integerOptional

or

nullOptional

max_sequence_lengthany ofOptionalDefault: null

integerOptional

or

nullOptional

long_sequence_thresholdany ofOptionalDefault: null

integerOptional

or

nullOptional

adjust_n_rows_allowedany ofOptionalDefault: null

booleanOptional

or

nullOptional

order_by_columnsany ofOptionalDefault: null

string[]Optional

or

nullOptional

database_idstring · uuidRequired

namestringRequired

schema_name_sourcestringRequired

schema_name_targetstringRequired

primary_keysany ofOptionalDefault: null

or

nullOptional

unique_columnsany ofOptionalDefault: null

or

nullOptional

index_columnsany ofOptionalDefault: null

or

nullOptional

check_constraintsany ofOptionalDefault: null

object[]Optional

or

nullOptional

data_in_targetany ofOptionalDefault: null

booleanOptional

or

nullOptional

sample_noise_ratioany ofOptionalDefault: null

numberOptional

or

nullOptional

max_n_feat_per_modelany ofOptionalDefault: null

integerOptional

or

nullOptional

feat_model_train_orderany ofOptionalDefault: null

stringOptional

or

nullOptional

end_of_sequence_tokenany ofOptionalDefault: null

numberOptional

or

nullOptional

min_sample_sizeany ofOptionalDefault: null

integerOptional

or

nullOptional

columnsany ofOptionalDefault: null

or

nullOptional

n_columnsany ofOptionalDefault: null

integerOptional

or

nullOptional

subsetting_configany ofOptionalDefault: null

or

nullOptional

has_unprotected_piiany ofOptionalDefault: null

booleanOptional

or

nullOptional

sync_statusany ofOptionalDefault: null

string · enumOptionalPossible values:

or

nullOptional

sync_diffany ofOptionalDefault: null

or

nullOptional

warningsany ofOptionalDefault: null

or

nullOptional

indexany ofOptionalDefault: null

integerOptional

or

nullOptional

kindstringRequired

engine_idany ofOptionalDefault: null

string · uuidOptional

or

nullOptional

applied_stepsany ofOptionalDefault: null

or

nullOptional

foreign_keysany ofOptionalDefault: null

or

nullOptional

supported_table_processorsany ofOptionalDefault: null

or

nullOptional

has_data_learnerany ofOptionalDefault: null

booleanOptional

or

nullOptional

503

Message: unable to fetch table from external service

get

/api/v1/table/{table_id}/

HTTPcURLJavaScriptPython

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "n_rows": 1,
  "n_rows_source": 1,
  "fk_scan": true,
  "is_excluded": true,
  "processing_config": {
    "type": "text"
  },
  "read_random_subset": true,
  "n_training_rows": 1,
  "max_sequence_length": 1,
  "long_sequence_threshold": 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",
  "end_of_sequence_token": 1,
  "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",
        "params": {},
        "links": [
          {
            "association": "text",
            "params": {},
            "generator": {}
          }
        ],
        "is_default": false
      },
      "default_generator_config": {
        "name": "text",
        "params": {},
        "links": [
          {
            "association": "text",
            "params": {},
            "generator": {}
          }
        ],
        "is_default": false
      },
      "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",
  "engine_id": "123e4567-e89b-12d3-a456-426614174000",
  "applied_steps": [
    {
      "column_id": "123e4567-e89b-12d3-a456-426614174000",
      "column_name": "text",
      "generator_name": "text",
      "cardinality_threshold": 1,
      "rare_category_replacement": "text",
      "clip_threshold": 1,
      "generator_type": "Ai_generation"
    }
  ],
  "foreign_keys": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "table_id": "123e4567-e89b-12d3-a456-426614174000",
      "references_table_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "apply": true,
      "is_virtual": true,
      "scan_result": 1,
      "fk_columns": [
        "text"
      ],
      "fk_schema": "text",
      "fk_table": "text",
      "pk_columns": [
        "text"
      ],
      "pk_schema": "text",
      "pk_table": "text",
      "sync_status": "new"
    }
  ],
  "supported_table_processors": [
    {
      "type": "SingleTableModel",
      "fields": [
        {
          "type": "text",
          "text": "text",
          "default": "text"
        }
      ],
      "enabled": true,
      "messages": [
        "OVERSAMPLING_DISABLED"
      ]
    }
  ],
  "has_data_learner": true
}

get

List first 100 rows of table

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

table_idstringRequired

Responses

200

Success: List of table rows

application/json

resultsany ofOptionalDefault: null

object[]Optional

or

nullOptional

400

Error: could not validate data returned by external service

503

Message: unable to fetch table preview from external service

get

/api/v1/table/{table_id}/preview/

HTTPcURLJavaScriptPython

GET /api/v1/table/{table_id}/preview/ HTTP/1.1
Accept: */*

{
  "results": [
    {}
  ]
}

post

Update table subsetting config

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

table_idstringRequired

Body

application/json

processing_typestringRequired

percentageany ofOptionalDefault: null

integerOptional

or

nullOptional

where_clauseany ofOptionalDefault: null

stringOptional

or

nullOptional

Responses

200

Success: set subject table config

application/json

idstring · uuidRequired

n_rowsany ofOptionalDefault: null

integerOptional

or

nullOptional

n_rows_sourceany ofOptionalDefault: null

integerOptional

or

nullOptional

fk_scanany ofOptionalDefault: null

booleanOptional

or

nullOptional

is_excludedany ofOptionalDefault: null

booleanOptional

or

nullOptional

processing_configany ofOptionalDefault: null

or

or

nullOptional

read_random_subsetany ofOptionalDefault: null

booleanOptional

or

nullOptional

n_training_rowsany ofOptionalDefault: null

integerOptional

or

nullOptional

max_sequence_lengthany ofOptionalDefault: null

integerOptional

or

nullOptional

long_sequence_thresholdany ofOptionalDefault: null

integerOptional

or

nullOptional

adjust_n_rows_allowedany ofOptionalDefault: null

booleanOptional

or

nullOptional

order_by_columnsany ofOptionalDefault: null

string[]Optional

or

nullOptional

database_idstring · uuidRequired

namestringRequired

schema_name_sourcestringRequired

schema_name_targetstringRequired

primary_keysany ofOptionalDefault: null

or

nullOptional

unique_columnsany ofOptionalDefault: null

or

nullOptional

index_columnsany ofOptionalDefault: null

or

nullOptional

check_constraintsany ofOptionalDefault: null

object[]Optional

or

nullOptional

data_in_targetany ofOptionalDefault: null

booleanOptional

or

nullOptional

sample_noise_ratioany ofOptionalDefault: null

numberOptional

or

nullOptional

max_n_feat_per_modelany ofOptionalDefault: null

integerOptional

or

nullOptional

feat_model_train_orderany ofOptionalDefault: null

stringOptional

or

nullOptional

end_of_sequence_tokenany ofOptionalDefault: null

numberOptional

or

nullOptional

min_sample_sizeany ofOptionalDefault: null

integerOptional

or

nullOptional

columnsany ofOptionalDefault: null

or

nullOptional

n_columnsany ofOptionalDefault: null

integerOptional

or

nullOptional

subsetting_configany ofOptionalDefault: null

or

nullOptional

has_unprotected_piiany ofOptionalDefault: null

booleanOptional

or

nullOptional

sync_statusany ofOptionalDefault: null

string · enumOptionalPossible values:

or

nullOptional

sync_diffany ofOptionalDefault: null

or

nullOptional

warningsany ofOptionalDefault: null

or

nullOptional

indexany ofOptionalDefault: null

integerOptional

or

nullOptional

kindstringRequired

503

Message: unable to fetch table from external service

post

/api/v1/table/{table_id}/set_subsetting/

HTTPcURLJavaScriptPython

POST /api/v1/table/{table_id}/set_subsetting/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "processing_type": "text",
  "percentage": 1,
  "where_clause": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "n_rows": 1,
  "n_rows_source": 1,
  "fk_scan": true,
  "is_excluded": true,
  "processing_config": {
    "type": "text"
  },
  "read_random_subset": true,
  "n_training_rows": 1,
  "max_sequence_length": 1,
  "long_sequence_threshold": 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",
  "end_of_sequence_token": 1,
  "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",
        "params": {},
        "links": [
          {
            "association": "text",
            "params": {},
            "generator": {}
          }
        ],
        "is_default": false
      },
      "default_generator_config": {
        "name": "text",
        "params": {},
        "links": [
          {
            "association": "text",
            "params": {},
            "generator": {}
          }
        ],
        "is_default": false
      },
      "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"
}