Skip to content

Ingest Clinical data

POST
/clinical

Add a list of donors with clinical data produced by the clinical ETL.

Parameters

Query Parameters

batch_size
integer

Number of items to be processed in one batch

Request Body

object
openapi_url

URL of schema used to generate this mapping

string
donors
Array<object>

A DonorWithClinicalData object, as specified in the schema in openapi_url

object
katsu_sha

The SHA of the version of Katsu used to generate the schema.

string
statistics
object
required_but_missing

For each schema, a count of required fields that are present vs missing

object
schemas_used

A list of schemas used in this dataset

Array<string>
cases_missing_data

A list of cases that have missing data

Array<string>
schemas_not_used

A list of schemas that are never used in this dataset

Array<string>
summary_cases

Overall completeness counts

object
complete_cases

How many cases have complete data

integer
total_cases

How many cases are in this dataset

integer

Responses

200

Success

object
queue_id

Queue ID to get status of ingest

string
warnings
Array<string>