Create Sample Registrations

POST

/v3/ingest/sample_registrations/

const url = 'https://example.com/v3/ingest/sample_registrations/';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '[{"program_id":"example","sample_type":"Amplified DNA","specimen_tissue_source":"Abdominal fluid","specimen_type":"Cell line - derived from normal","submitter_donor_id":"example","submitter_sample_id":"example","submitter_specimen_id":"example","tumour_normal_designation":"Normal","uuid":"example"}]'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v3/ingest/sample_registrations/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "program_id": "example", "sample_type": "Amplified DNA", "specimen_tissue_source": "Abdominal fluid", "specimen_type": "Cell line - derived from normal", "submitter_donor_id": "example", "submitter_sample_id": "example", "submitter_specimen_id": "example", "tumour_normal_designation": "Normal", "uuid": "example" } ]'

Authorizations

IngestAuth
ServiceTokenAuth

Request Body^required

application/json

Payload

Array<object>

SampleRegistrationIngestSchema

object

program_id

required

Program Id

string

sample_type

Any of:

SampleTypeEnum
null

SampleTypeEnum

string

Allowed values: Amplified DNA ctDNA Other DNA enrichments Other RNA fractions polyA+ RNA Protein rRNA-depleted RNA Total DNA Total RNA

specimen_tissue_source

Any of:

SpecimenTissueSourceEnum
null

SpecimenTissueSourceEnum

string

Allowed values: Abdominal fluid Amniotic fluid Arterial blood Bile Blood derived - bone marrow Blood derived - peripheral blood Bone marrow fluid Bone marrow derived mononuclear cells Buccal cell Buffy coat Cerebrospinal fluid Cervical mucus Convalescent plasma Cord blood Duodenal fluid Female genital fluid Fetal blood Hydrocele fluid Male genital fluid Other Pancreatic fluid Pericardial effusion Pleural fluid Renal cyst fluid Saliva Seminal fluid Serum Solid tissue Sputum Synovial fluid Urine Venous blood Vitreous fluid Whole blood Wound

specimen_type

Any of:

SpecimenTypeEnum
null

SpecimenTypeEnum

string

Allowed values: Cell line - derived from normal Cell line - derived from primary tumour Cell line - derived from metastatic tumour Cell line - derived from xenograft tumour Metastatic tumour - additional metastatic Metastatic tumour - metastasis local to lymph node Metastatic tumour - metastasis to distant location Metastatic tumour Normal - tissue adjacent to primary tumour Normal Primary tumour - additional new primary Primary tumour - adjacent to normal Primary tumour Recurrent tumour Tumour - unknown if derived from primary or metastatic tumour Xenograft - derived from primary tumour Xenograft - derived from metastatic tumour Xenograft - derived from tumour cell line

submitter_donor_id

required

Submitter Donor Id

string

submitter_sample_id

required

Submitter Sample Id

string

<= 64 characters /^[A-Za-z0-9\-\._]{1,64}$/

submitter_specimen_id

required

Submitter Specimen Id

string

tumour_normal_designation

Any of:

TumourDesginationEnum
null

TumourDesginationEnum

string

Allowed values: Normal Tumour

uuid

Any of:

string
null

string

Create Sample Registrations

Authorizations

Request Body^required

Responses

200

Create Sample Registrations

Authorizations

Request Body required

Responses

200

Request Body^required