Create Specimens

POST

/v3/ingest/specimens/

const url = 'https://example.com/v3/ingest/specimens/';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '[{"percent_tumour_cells_measurement_method":"Genomics","percent_tumour_cells_range":"0-19%","program_id":"example","reference_pathology_confirmed_diagnosis":"Yes","reference_pathology_confirmed_tumour_presence":"Yes","specimen_anatomic_location":"example","specimen_collection_date":{},"specimen_laterality":"Left","specimen_processing":"Cryopreservation in liquid nitrogen (dead tissue)","specimen_storage":"Cut slide","submitter_donor_id":"example","submitter_primary_diagnosis_id":"example","submitter_specimen_id":"example","submitter_treatment_id":"example","tumour_grade":"Low grade","tumour_grading_system":"FNCLCC grading system","tumour_histological_type":"example","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/specimens/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "percent_tumour_cells_measurement_method": "Genomics", "percent_tumour_cells_range": "0-19%", "program_id": "example", "reference_pathology_confirmed_diagnosis": "Yes", "reference_pathology_confirmed_tumour_presence": "Yes", "specimen_anatomic_location": "example", "specimen_collection_date": {}, "specimen_laterality": "Left", "specimen_processing": "Cryopreservation in liquid nitrogen (dead tissue)", "specimen_storage": "Cut slide", "submitter_donor_id": "example", "submitter_primary_diagnosis_id": "example", "submitter_specimen_id": "example", "submitter_treatment_id": "example", "tumour_grade": "Low grade", "tumour_grading_system": "FNCLCC grading system", "tumour_histological_type": "example", "uuid": "example" } ]'

Authorizations

IngestAuth
ServiceTokenAuth

Request Body^required

application/json

Payload

Array<object>

SpecimenIngestSchema

object

percent_tumour_cells_measurement_method

Any of:

CellsMeasureMethodEnum
null

CellsMeasureMethodEnum

string

Allowed values: Genomics Image analysis Pathology estimate by percent nuclei Other Not available

percent_tumour_cells_range

Any of:

PercentCellsRangeEnum
null

PercentCellsRangeEnum

string

Allowed values: 0-19% 20-50% 51-100% Not available

program_id

required

Program Id

string

reference_pathology_confirmed_diagnosis

Any of:

ConfirmedDiagnosisTumourEnum
null

ConfirmedDiagnosisTumourEnum

string

Allowed values: Yes No Not done Not available

reference_pathology_confirmed_tumour_presence

Any of:

ConfirmedDiagnosisTumourEnum
null

ConfirmedDiagnosisTumourEnum

string

Allowed values: Yes No Not done Not available

specimen_anatomic_location

Any of:

string
null

string

<= 32 characters /^[C][0-9]{2}(.[0-9]{1})?$|^Not available$/

specimen_collection_date

Any of:

object
null

object

specimen_laterality

Any of:

SpecimenLateralityEnum
null

SpecimenLateralityEnum

string

Allowed values: Left Not applicable Right Not available

specimen_processing

Any of:

SpecimenProcessingEnum
null

SpecimenProcessingEnum

string

Allowed values: Cryopreservation in liquid nitrogen (dead tissue) Cryopreservation in dry ice (dead tissue) Cryopreservation of live cells in liquid nitrogen Cryopreservation - other Formalin fixed & paraffin embedded Formalin fixed - buffered Formalin fixed - unbuffered Fresh Other Not available

specimen_storage

Any of:

StorageEnum
null

StorageEnum

string

Allowed values: Cut slide Frozen in -70 freezer Frozen in liquid nitrogen Frozen in vapour phase Not Applicable OCT embedded Other Paraffin block RNA later frozen Not available

submitter_donor_id

required

Submitter Donor Id

string

submitter_primary_diagnosis_id

required

Submitter Primary Diagnosis Id

string

submitter_specimen_id

required

Submitter Specimen Id

string

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

submitter_treatment_id

Any of:

string
null

string

<= 64 characters

tumour_grade

Any of:

TumourGradeEnum
null

TumourGradeEnum

string

Allowed values: Low grade High grade GX G1 G2 G3 G4 Low High Grade 1 Grade 2 Grade 3 Grade 4 Grade I Grade II Grade III Grade IV Grade Group 1 Grade Group 2 Grade Group 3 Grade Group 4 Grade Group 5 Not available

tumour_grading_system

Any of:

TumourGradingSystemEnum
null

TumourGradingSystemEnum

string

Allowed values: FNCLCC grading system Four-tier grading system Gleason grade group system Grading system for GISTs Grading system for GNETs IASLC grading system ISUP grading system Nottingham grading system Nuclear grading system for DCIS Scarff-Bloom-Richardson grading system Three-tier grading system Two-tier grading system WHO grading system for CNS tumours Not available

tumour_histological_type

Any of:

string
null

string

<= 128 characters /^[8,9]{1}[0-9]{3}/[0,1,2,3,6,9]{1}[1-9]{0,1}$|^Not available$/

uuid

Any of:

string
null

string

Create Specimens

Authorizations

Request Body^required

Responses

200

Create Specimens

Authorizations

Request Body required

Responses

200

Request Body^required