Contents:
URL
https://jqhp2vtj5k.execute-api.ap-southeast-2.amazonaws.com/prod
New job (POST)
Submits a job for a given genomic sequence and range.
/submit
Parameters
| Field | Type | Description |
|---|---|---|
| genome | String | The reference genome (currently must be "GRCh37") |
| chromosome | String | The chromosome ["1"-"22", "X", "Y", "M"] |
| start | Number | The location of the start of the sequence in the chromosome. |
| fasta | String | The nucleotide sequence. Should only contain the DNA characters [ATCGN]. |
| cellLine | String | Should be of the format Exxx. See the New job page for more info. |
Success 200
| Field | Type | Description |
|---|---|---|
| JobID | String | The new Job-ID. |
Retrieve job (GET)
Reads the job information
/results/:id
Parameters
| Field | Type | Description |
|---|---|---|
| id | String | The Job-ID |
Success 200
| Field | Type | Description |
|---|---|---|
| id | String | The Job-ID. |
| time | Number | The datetime value of job submission. |
| genome | Number | The reference genome name. |
| chromosome | String | The chromosome name. |
| location | Number | The location of the sequence in the chromosome. |
| altlocation | Number | The location of the sequence in the chromosome (converted to GRCh38). |
| roadmap | String | Name of the roadmap. |
| intersects | Object | Intersects with the above roadmap. |
Retrieve job targets (GET)
Reads the targets for a specific job
/results/:id/targets
Parameters
| Field | Type | Description |
|---|---|---|
| id | String | The Job-ID |
Success 200
| Field | Type | Description |
|---|---|---|
| recordsTotal | Number | The total number of items matching the query. |
| data | Array | An array of objects, each representing a target. |
| position | Number | The position of the target in the input sequence. |
| location | Number | The location of the target in the chromosome. |
| strand | String | The strand [+, -] the target is present on. |
| sequence | String | The nucleotide sequence of the target. |
| gc | Number | The GC content of the target. |
| activity | String | The predicted activity [High, Low] of the target. |
| ot_zero | Number | The number of potential off-targets with no mismatches. |
| ot_one | Number | The number of potential off-targets with one mismatch. |
| ot_two | Number | The number of potential off-targets with two mismatches. |
| ot_three | Number | The number of potential off-targets with three mismatches. |