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

idstring · nullableOptionalDefault: null

codestringRequired

titlestringRequired

bodystring[]Required

durabilitystring · enum · nullableOptionalDefault: temporaryPossible values:

durationinteger · nullableOptionalDefault: 5000

kindstring · enum · nullableOptionalDefault: infoPossible values:

payloadanyOptionalDefault: null

actionobject · Action · nullableOptionalDefault: null

displaystring · enum · nullableOptionalDefault: notificationPossible values:

created_atstring · nullableOptionalDefault: null

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: 234

{
  "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"
      ]
    }
  ]
}

{
  "id": "text",
  "code": "text",
  "title": "text",
  "body": [
    "text"
  ],
  "durability": "temporary",
  "duration": 5000,
  "kind": "info",
  "details": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "payload": null,
  "action": {},
  "display": "notification",
  "created_at": "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_namesstring[] · nullableOptionalDefault: null

table_idsstring · uuid[] · nullableOptionalDefault: null

not_table_idsstring · uuid[] · nullableOptionalDefault: null

table_keywordstring · nullableOptionalDefault: null

column_keywordstring · nullableOptionalDefault: null

Responses

204

No response body

No content

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_rowsinteger · nullableOptionalDefault: null

n_rows_sourceinteger · nullableOptionalDefault: null

fk_scanboolean · nullableOptionalDefault: null

is_excludedboolean · nullableOptionalDefault: null

n_training_rowsinteger · nullableOptionalDefault: null

adjust_n_rows_allowedboolean · nullableOptionalDefault: null

order_by_columnsstring[] · nullableOptionalDefault: null

database_idstring · uuidRequired

namestringRequired

schema_name_sourcestringRequired

schema_name_targetstring · nullableOptionalDefault: null

check_constraintsobject[] · nullableOptionalDefault: null

data_in_targetboolean · nullableOptionalDefault: null

sample_noise_rationumber · nullableOptionalDefault: null

max_n_feat_per_modelinteger · nullableOptionalDefault: null

feat_model_train_orderstring · nullableOptionalDefault: null

min_sample_sizeinteger · nullableOptionalDefault: null

n_columnsinteger · nullableOptionalDefault: null

has_unprotected_piiboolean · nullableOptionalDefault: null

sync_statusstring · enum · nullableOptionalDefault: nullPossible values:

indexinteger · nullableOptionalDefault: null

kindstringRequired

engine_idstring · uuid · nullableOptionalDefault: null

has_data_learnerboolean · nullableOptionalDefault: null

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"
  },
  "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",
  "engine_id": "123e4567-e89b-12d3-a456-426614174000",
  "applied_steps": [
    {
      "column_id": "123e4567-e89b-12d3-a456-426614174000",
      "column_name": "text",
      "generator_name": "text",
      "generator_display_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

resultsobject[] · nullableOptionalDefault: null

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": [
    {}
  ]
}