Subsetting

post

Start Subsetting

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

database_idstringRequired

Query parameters

n_connectionsintegerOptionalDefault: 1

read_batch_sizeintegerOptionalDefault: 10000

write_batch_sizeintegerOptionalDefault: 10000

Responses

200

Success: Job status

application/json

422

Validation error

application/json

503

Message: unable to fetch engine from external service

post

/api/v1/subsetting/{database_id}/start/

HTTPcURLJavaScriptPython

POST /api/v1/subsetting/{database_id}/start/ HTTP/1.1
Host: /
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "STARTED",
  "reason": "text"
}

post

Reset Subsetting

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

engine_idstringRequired

Responses

200

Success: Engine status

application/json

422

Validation error

application/json

503

Message: unable to fetch engine from external service

post

/api/v1/subsetting/{engine_id}/reset/

HTTPcURLJavaScriptPython

POST /api/v1/subsetting/{engine_id}/reset/ HTTP/1.1
Host: /
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "text"
}

post

Set Table Subsetting

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: Table schema

application/json

422

Validation error

application/json

503

Message: unable to fetch engine from external service

post

/api/v1/subsetting/{table_id}/set/

HTTPcURLJavaScriptPython

POST /api/v1/subsetting/{table_id}/set/ HTTP/1.1
Host: /
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": "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": {}
          }
        ]
      },
      "default_generator_config": {
        "name": "text",
        "params": {},
        "links": [
          {
            "association": "text",
            "params": {},
            "generator": {}
          }
        ]
      },
      "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"
}