GeneratorDataPreview

post

Get preview data

Authorizations

authenticationOIDC

sessionidstringRequired

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

Path parameters

column_idstringRequired

Body

application/json

idany ofOptionalDefault: null

string · uuidOptional

or

nullOptional

cardinality_thresholdany ofOptionalDefault: null

integerOptional

or

nullOptional

rare_category_replacementany ofOptionalDefault: null

stringOptional

or

nullOptional

clip_thresholdany ofOptionalDefault: null

integerOptional

or

nullOptional

localeany ofOptionalDefault: null

stringOptional

or

nullOptional

pii_mock_replaceany ofOptionalDefault: null

booleanOptional

or

nullOptional

has_piiany ofOptionalDefault: null

booleanOptional

or

nullOptional

generator_configany ofOptionalDefault: null

one ofOptional

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

or

nullOptional

pii_deselected_entitiesany ofOptionalDefault: null

string[]Optional

or

nullOptional

Responses

200

Success: Preview data

application/json

400

Message: unable to generate preview data using the settings provided

application/json

503

Message: unable to fetch preview data from external service

post

/api/v1/generators/{column_id}/data_preview/

HTTPcURLJavaScriptPython

POST /api/v1/generators/{column_id}/data_preview/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "cardinality_threshold": 1,
  "rare_category_replacement": "text",
  "clip_threshold": 1,
  "locale": "text",
  "pii_mock_replace": true,
  "has_pii": true,
  "generator_config": {
    "name": "text",
    "params": {},
    "links": [
      {
        "association": "text",
        "params": {},
        "generator": {}
      }
    ]
  },
  "pii_deselected_entities": [
    "text"
  ]
}

{
  "data": []
}