TUSCAN

Contents:


URL

https://rylyx4l7j3.execute-api.ap-southeast-2.amazonaws.com/prod

New job (POST)

Submits a job for a given genomic sequence and range.

/submit

Parameters

FieldTypeDescription
genomeStringThe reference genome (currently must be "GRCh37")
chromosomeStringThe chromosome ["1"-"22", "X", "Y", "M"]
proximalNumberThe location of the sequence in the chromosome.
fastaStringThe nucleotide sequence. Should only contain the DNA characters [ATCGN].

Success 200

FieldTypeDescription
JobIDStringThe new Job-ID.

Retrieve job (GET)

Reads the job information

/results/:id

Parameters

FieldTypeDescription
idStringThe Job-ID

Success 200

FieldTypeDescription
idStringThe Job-ID.
genomeNumberThe reference genome name.
chromosomeStringThe chromosome name.
locationNumberThe location of the sequence in the chromosome.
altlocationNumberThe location of the sequence in the chromosome (converted to GRCh38).

Retrieve job targets (GET)

Reads the targets for a specific job

/results/:id/targets

Parameters

FieldTypeDescription
idStringThe Job-ID

Success 200

FieldTypeDescription
recordsTotalNumberThe total number of items matching the query.
dataArrayAn array of objects, each representing a target.
positionNumberThe position of the target in the input sequence.
locationNumberThe location of the target in the chromosome.
strandStringThe strand [+, -] the target is present on.
sequenceStringThe nucleotide sequence of the target.
gcNumberThe GC content of the target.
tuscanNumberThe TUSCAN score.