forked from ncbi/datasets
-
Notifications
You must be signed in to change notification settings - Fork 0
/
datasets.openapi.yaml
executable file
·12279 lines (12183 loc) · 398 KB
/
datasets.openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: NCBI Datasets API
version: v2
description: '### NCBI Datasets is a resource that lets you easily gather data from
NCBI.
The Datasets version 2 API is still in alpha, and we''re updating it often to add new functionality,
iron out bugs and enhance usability.
For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/),
and retrieve the individual data files at a later time.
'
servers:
- url: https://api.ncbi.nlm.nih.gov/datasets/v2
- url: https://dev.ncbi.nlm.nih.gov/datasets/v2
tags:
- name: Genome
description: '#### Options to explore, summarize and download assembled genomes,
including the associated sequence, metadata and annotation.
These genome services allow you to explore genome [assemblies](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/glossary/#assembly). For
a set of genomes of interest, identified by either assembly accession or taxonomic
subtree, you can generate a summary, determine the package size, and download.
'
- name: Gene
description: '#### Options to explore, summarize and download sequences and metadata
for genes and their associated transcripts and proteins.
These gene services allow you explore [NCBI Gene](https://www.ncbi.nlm.nih.gov/gene/),
and for genes of interest, identified by either gene-id, symbol or RefSeq sequence
accession, download a data package including metadata (tabular and [JSON Lines](https://jsonlines.org/)
formats), transcript and protein sequence in FASTA format.
'
- name: Prokaryote
description: '#### Options to explore, summarize and download sequences and metadata
for prokaryote genes and their associated proteins.
These gene services allow you to explore prokaryotic gene data by RefSeq protein
sequence accession and download a data package including metadata for the gene
including all genomic annotations as [JSON Lines](https://jsonlines.org/) format,
gene and protein sequences in FASTA format.
'
- name: Virus
description: '#### Get metadata or a zip archive containing a virus genome
or coronavirus protein dataset.
The following files are optionally available for virus genome and/or protein
datasets:
* genomic.fna (genomic sequences in FASTA format)
* cds.fna (nucleotide coding sequences in FASTA format)
* protein.faa (protein sequences in FASTA format)
* annotation_report.jsonl (annotation report in [JSON Lines](https://jsonlines.org/) format)
* biosample_report.jsonl (biosample report in [JSON Lines](https://jsonlines.org/) format)
The following files are always included in coronavirus genome and protein datasets:
* data_report.jsonl (data report with viral metadata in JSON lines format)
* virus_dataset.md (README containing details on sequence file data content and
other information)
* dataset_catalog.json (a list of files and file types included in the dataset)
You may also request a tab-delimited table of metadata that describes the available
virus genome and protein data.
Virus genome datasets are available for all viruses, including SARS-CoV-2.
Various parameters may be used for filtering and specifying the contents of the genome dataset.
Protein datasets are available for SARS-CoV-2 only.
'
- name: Version
description: "#### Retrieve the current version of all services. \nServices follow\
\ [Semantic Versioning 2.0.0 Schema](https://semver.org/spec/v2.0.0.html).\n"
- name: Taxonomy
description: '#### Options to explore taxonomic metadata and relationships.
These taxonomic services allow you to browse taxonomic metadata in addition to retrieving
parent lineages and filtered sets of child nodes for any given set of taxonomic identifiers.
'
externalDocs:
description: Interactively explore genome assembly datasets
url: https://www.ncbi.nlm.nih.gov/datasets/genomes/
security:
- ApiKeyAuthHeader: []
paths:
/genome/accession/{accessions}/download_summary:
get:
summary: Preview genome dataset download
description: 'Get a download summary by accession in a JSON output format.'
tags:
- Genome
operationId: genome_download_summary
responses:
default:
description: An unexpected error response.
content:
text/plain:
schema:
$ref: '#/components/schemas/rpcStatus'
'200':
description: A successful response
content:
application/json:
schema:
$ref: '#/components/schemas/v2DownloadSummary'
parameters:
- name: accessions
description: 'NCBI genome assembly accessions'
in: path
required: true
schema:
type: array
items:
type: string
examples:
example-0:
value: GCF_000001405.40
summary: Human
example-1:
value:
- GCF_000001405.40
- GCF_000001635.27
summary: Human and Mouse
- name: chromosomes
description: 'The default setting is all chromosome. Specify individual chromosome by string (1,2,MT or chr1,chr2.chrMT). Unplaced sequences are treated like their own chromosome (''Un''). The filter only applies to fasta sequence.'
in: query
required: false
schema:
type: array
items:
type: string
examples:
example-0:
value:
- 1
- 2
- 3
- X
- Y
- MT
summary: Selected chromosomes #1
example-1:
value:
- X
- Y
summary: Human sex chromosomes
- name: include_annotation_type
description: 'Select additional types of annotation to include in the data package. If unset, no annotation is provided.'
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/v2AnnotationForAssemblyType'
examples:
example-0:
value:
- GENOME_FASTA
- PROT_FASTA
- RNA_FASTA
summary: Genomic, Transcript & Protein Sequence
example-1:
value:
- GENOME_GFF
- GENOME_GBFF
- GENOME_GTF
- PROT_FASTA
- RNA_FASTA
- CDS_FASTA, SEQUENCE_REPORT
summary: All
/genome/download_summary:
post:
summary: Preview genome dataset download by POST
description: 'The ''GET'' version of download summary is limited by the size of the GET URL (2KB, which works out to about 140 genomic accessions). The POST operation is provided to allow users to supply a larger number of accessions in a single request.'
tags:
- Genome
operationId: genome_download_summary_by_post
responses:
default:
description: An unexpected error response.
content:
text/plain:
schema:
$ref: '#/components/schemas/rpcStatus'
'200':
description: A successful response
content:
application/json:
schema:
$ref: '#/components/schemas/v2DownloadSummary'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/v2AssemblyDatasetRequest'
examples:
Single GCF accession example:
description: GCF Accession (just one)
value:
accessions:
- GCF_000001405.40
/genome/accession/{accessions}/dataset_report:
get:
summary: Get dataset reports by accessions
description: 'Get dataset reports by accessions. By default, in paged JSON format, but also available as tabular (accept: text/tab-separated-values) or json-lines (accept: application/x-ndjson)'
tags:
- Genome
operationId: genome_dataset_report
responses:
default:
description: An unexpected error response.
content:
text/plain:
schema:
$ref: '#/components/schemas/rpcStatus'
'200':
description: A successful response
content:
application/json:
schema:
$ref: '#/components/schemas/v2reportsAssemblyDataReportPage'
application/x-ndjson:
schema:
$ref: '#/components/schemas/v2reportsAssemblyDataReportPage'
text/tab-separated-values:
schema:
type: string
parameters:
- name: accessions
in: path
required: true
schema:
type: array
items:
type: string
examples:
example-0:
value: GCF_000001405.40
summary: Human
example-1:
value:
- GCF_000001405.40
- GCF_000001635.27
summary: Human and Mouse
- name: filters.reference_only
description: 'If true, only return reference and representative (GCF_ and GCA_) genome assemblies.'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: true
summary: Limit to reference & representative genomes
example-1:
value: false
summary: Include reference and non-reference genomes
- name: filters.assembly_source
description: 'Return only RefSeq (GCF_) or GenBank (GCA_) genome assemblies'
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetDescriptorsFilterAssemblySource'
default: all
examples:
example-0:
value: refseq
summary: Limit to RefSeq genomes
example-1:
value: genbank
summary: Limit to GenBank genomes
example-2:
value: all
summary: All genomes
- name: filters.has_annotation
description: 'Return only annotated genome assemblies'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: true
summary: Limit to annotated assemblies
example-1:
value: false
summary: Return all assemblies
- name: filters.exclude_paired_reports
description: 'For paired (GCA/GCF) records, only return the primary record'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all assemblies
example-1:
value: true
summary: Only return single record for GCA/GCF pairs
- name: filters.exclude_atypical
description: 'If true, exclude atypical genomes, i.e. genomes that have assembly issues or are otherwise atypical'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all selected genomes, including ones that are atypical
example-1:
value: true
summary: Only return genomes that have not been classified as atypical
- name: filters.assembly_version
description: 'Return all assemblies, including replaced and suppressed, or only current assemblies'
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetDescriptorsFilterAssemblyVersion'
default: current
examples:
example-0:
value: current
summary: Only return current assemblies
example-1:
value: all_assemblies
summary: Return all assemblies, including suppressed and replaced
- name: filters.assembly_level
description: 'Only return genome assemblies that have one of the specified assembly levels. By default, do not filter.'
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/v2reportsAssemblyLevel'
examples:
example-0:
value:
- chromosome
- complete_genome
summary: Chromosome and complete genome
example-1:
value:
- scaffold
- chromosome
- complete_genome
summary: Scaffold and higher
- name: filters.first_release_date
description: 'Only return genome assemblies that were released on or after the specified date By default, do not filter.'
in: query
required: false
schema:
type: string
format: date-time
examples:
example-0:
value: 01/10/2015
summary: Jan 10, 2015
- name: filters.last_release_date
description: 'Only return genome assemblies that were released on or before to the specified date By default, do not filter.'
in: query
required: false
schema:
type: string
format: date-time
examples:
example-0:
value: 01/10/2021
summary: Jan 10, 2021
- name: filters.search_text
description: 'Only return results whose fields contain the specified search terms in their taxon, infraspecific, assembly name or submitter fields By default, do not filter'
in: query
required: false
schema:
type: array
items:
type: string
examples:
example-0:
value: Genome Reference Consortium
summary: Genome Reference Consortium
example-1:
value: GRCh38
summary: GRCh38
example-2:
value: C57BL/6J
summary: C57BL/6J
- name: filters.is_metagenome_derived
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetDescriptorsFilterMetagenomeDerivedFilter'
examples:
example-0:
value: metagenome_derived_exclude
summary: Exclude metagenome derived assemblies
example-1:
value: metagenome_derived_only
summary: Return only metagenome derived assemblies
- name: filters.is_type_material
description: 'If true, include only type materials'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all selected genomes, including ones of type materials
example-1:
value: true
summary: Only return genomes that are classified as type materials
- name: filters.is_ictv_exemplar
description: 'If true, include only ICTV Exemplars'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all selected genomes, including ones of type ICTV exemplar
example-1:
value: true
summary: Only return genomes that are classified as ICTV exemplar
- name: filters.exclude_multi_isolate
description: 'If true, exclude large multi-isolate projects'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all selected genomes, including ones of large multi-isolate projects
example-1:
value: true
summary: Exclude genomes that are classified as large multi-isolate projects
- name: filters.type_material_category
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetDescriptorsFilterTypeMaterialCategory'
examples:
example-0:
value: TYPE_MATERIAL
summary: A Type Material with no classification
example-1:
value: TYPE_MATERIAL_CLADE
summary: A Type Material of the Clade classification
example-2:
value: TYPE_MATERIAL_NEOTYPE
summary: A Type Material of the Neotype classification
- name: tax_exact_match
description: 'If true, only return assemblies with the given NCBI Taxonomy ID, or name. Otherwise, assemblies from taxonomy subtree are included, too.'
in: query
required: false
schema:
type: boolean
default: false
- name: table_fields
in: query
required: false
schema:
type: array
items:
type: string
examples:
example-0:
value:
- assminfo-accession
- assminfo-name
summary: Genome Accession and Name
example-1:
value: assminfo-accession
summary: Just accession
- name: returned_content
description: 'Return either assembly accessions, or complete assembly reports'
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetReportsRequestContentType'
- name: page_size
description: 'The maximum number of genome assembly reports to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.'
in: query
required: false
schema:
type: integer
default: 20
- name: page_token
description: 'A page token is returned from an `AssemblyDatasetReportsRequest` call with more than `page_size` results. Use this token, along with the previous `AssemblyDatasetReportsRequest` parameters, to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.'
in: query
required: false
schema:
type: string
- name: sort.field
in: query
required: false
schema:
type: string
- name: sort.direction
in: query
required: false
schema:
$ref: '#/components/schemas/v2SortDirection'
- name: include_tabular_header
description: 'Whether this request for tabular data should include the header row'
in: query
required: false
schema:
$ref: '#/components/schemas/v2IncludeTabularHeader'
/genome/taxon/{taxons}/dataset_report:
get:
summary: Get dataset reports by taxons
description: 'Get dataset reports by taxons. By default, in paged JSON format, but also available as tabular (accept: text/tab-separated-values) or json-lines (accept: application/x-ndjson)'
tags:
- Genome
operationId: genome_dataset_reports_by_taxon
responses:
default:
description: An unexpected error response.
content:
text/plain:
schema:
$ref: '#/components/schemas/rpcStatus'
'200':
description: A successful response
content:
application/json:
schema:
$ref: '#/components/schemas/v2reportsAssemblyDataReportPage'
application/x-ndjson:
schema:
$ref: '#/components/schemas/v2reportsAssemblyDataReportPage'
text/tab-separated-values:
schema:
type: string
parameters:
- name: taxons
description: 'NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank'
in: path
required: true
schema:
type: array
items:
type: string
examples:
example-0:
value: 9606
summary: NCBI Taxonomy Identifier
example-1:
value:
- chimpanzee
- eastern gorilla
summary: Common Names
example-2:
value: Homo sapiens
summary: Scientific Name
- name: filters.reference_only
description: 'If true, only return reference and representative (GCF_ and GCA_) genome assemblies.'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: true
summary: Limit to reference & representative genomes
example-1:
value: false
summary: Include reference and non-reference genomes
- name: filters.assembly_source
description: 'Return only RefSeq (GCF_) or GenBank (GCA_) genome assemblies'
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetDescriptorsFilterAssemblySource'
default: all
examples:
example-0:
value: refseq
summary: Limit to RefSeq genomes
example-1:
value: genbank
summary: Limit to GenBank genomes
example-2:
value: all
summary: All genomes
- name: filters.has_annotation
description: 'Return only annotated genome assemblies'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: true
summary: Limit to annotated assemblies
example-1:
value: false
summary: Return all assemblies
- name: filters.exclude_paired_reports
description: 'For paired (GCA/GCF) records, only return the primary record'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all assemblies
example-1:
value: true
summary: Only return single record for GCA/GCF pairs
- name: filters.exclude_atypical
description: 'If true, exclude atypical genomes, i.e. genomes that have assembly issues or are otherwise atypical'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all selected genomes, including ones that are atypical
example-1:
value: true
summary: Only return genomes that have not been classified as atypical
- name: filters.assembly_version
description: 'Return all assemblies, including replaced and suppressed, or only current assemblies'
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetDescriptorsFilterAssemblyVersion'
default: current
examples:
example-0:
value: current
summary: Only return current assemblies
example-1:
value: all_assemblies
summary: Return all assemblies, including suppressed and replaced
- name: filters.assembly_level
description: 'Only return genome assemblies that have one of the specified assembly levels. By default, do not filter.'
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/v2reportsAssemblyLevel'
examples:
example-0:
value:
- chromosome
- complete_genome
summary: Chromosome and complete genome
example-1:
value:
- scaffold
- chromosome
- complete_genome
summary: Scaffold and higher
- name: filters.first_release_date
description: 'Only return genome assemblies that were released on or after the specified date By default, do not filter.'
in: query
required: false
schema:
type: string
format: date-time
examples:
example-0:
value: 01/10/2015
summary: Jan 10, 2015
- name: filters.last_release_date
description: 'Only return genome assemblies that were released on or before to the specified date By default, do not filter.'
in: query
required: false
schema:
type: string
format: date-time
examples:
example-0:
value: 01/10/2021
summary: Jan 10, 2021
- name: filters.search_text
description: 'Only return results whose fields contain the specified search terms in their taxon, infraspecific, assembly name or submitter fields By default, do not filter'
in: query
required: false
schema:
type: array
items:
type: string
examples:
example-0:
value: Genome Reference Consortium
summary: Genome Reference Consortium
example-1:
value: GRCh38
summary: GRCh38
example-2:
value: C57BL/6J
summary: C57BL/6J
- name: filters.is_metagenome_derived
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetDescriptorsFilterMetagenomeDerivedFilter'
examples:
example-0:
value: metagenome_derived_exclude
summary: Exclude metagenome derived assemblies
example-1:
value: metagenome_derived_only
summary: Return only metagenome derived assemblies
- name: filters.is_type_material
description: 'If true, include only type materials'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all selected genomes, including ones of type materials
example-1:
value: true
summary: Only return genomes that are classified as type materials
- name: filters.is_ictv_exemplar
description: 'If true, include only ICTV Exemplars'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all selected genomes, including ones of type ICTV exemplar
example-1:
value: true
summary: Only return genomes that are classified as ICTV exemplar
- name: filters.exclude_multi_isolate
description: 'If true, exclude large multi-isolate projects'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all selected genomes, including ones of large multi-isolate projects
example-1:
value: true
summary: Exclude genomes that are classified as large multi-isolate projects
- name: filters.type_material_category
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetDescriptorsFilterTypeMaterialCategory'
examples:
example-0:
value: TYPE_MATERIAL
summary: A Type Material with no classification
example-1:
value: TYPE_MATERIAL_CLADE
summary: A Type Material of the Clade classification
example-2:
value: TYPE_MATERIAL_NEOTYPE
summary: A Type Material of the Neotype classification
- name: tax_exact_match
description: 'If true, only return assemblies with the given NCBI Taxonomy ID, or name. Otherwise, assemblies from taxonomy subtree are included, too.'
in: query
required: false
schema:
type: boolean
default: false
- name: table_fields
in: query
required: false
schema:
type: array
items:
type: string
examples:
example-0:
value:
- assminfo-accession
- assminfo-name
summary: Genome Accession and Name
example-1:
value: assminfo-accession
summary: Just accession
- name: returned_content
description: 'Return either assembly accessions, or complete assembly reports'
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetReportsRequestContentType'
- name: page_size
description: 'The maximum number of genome assembly reports to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.'
in: query
required: false
schema:
type: integer
default: 20
- name: page_token
description: 'A page token is returned from an `AssemblyDatasetReportsRequest` call with more than `page_size` results. Use this token, along with the previous `AssemblyDatasetReportsRequest` parameters, to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.'
in: query
required: false
schema:
type: string
- name: sort.field
in: query
required: false
schema:
type: string
- name: sort.direction
in: query
required: false
schema:
$ref: '#/components/schemas/v2SortDirection'
- name: include_tabular_header
description: 'Whether this request for tabular data should include the header row'
in: query
required: false
schema:
$ref: '#/components/schemas/v2IncludeTabularHeader'
/genome/bioproject/{bioprojects}/dataset_report:
get:
summary: Get dataset reports by bioproject
description: 'Get dataset reports by bioprojects. By default, in paged JSON format, but also available as tabular (accept: text/tab-separated-values) or json-lines (accept: application/x-ndjson)'
tags:
- Genome
operationId: genome_dataset_reports_by_bioproject
responses:
default:
description: An unexpected error response.
content:
text/plain:
schema:
$ref: '#/components/schemas/rpcStatus'
'200':
description: A successful response
content:
application/json:
schema:
$ref: '#/components/schemas/v2reportsAssemblyDataReportPage'
application/x-ndjson:
schema:
$ref: '#/components/schemas/v2reportsAssemblyDataReportPage'
text/tab-separated-values:
schema:
type: string
parameters:
- name: bioprojects
in: path
required: true
schema:
type: array
items:
type: string
examples:
example-0:
value: PRJNA489243
summary: Vertebrate Genomes Project
example-1:
value: PRJNA31257
summary: Human Genome Project
- name: filters.reference_only
description: 'If true, only return reference and representative (GCF_ and GCA_) genome assemblies.'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: true
summary: Limit to reference & representative genomes
example-1:
value: false
summary: Include reference and non-reference genomes
- name: filters.assembly_source
description: 'Return only RefSeq (GCF_) or GenBank (GCA_) genome assemblies'
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetDescriptorsFilterAssemblySource'
default: all
examples:
example-0:
value: refseq
summary: Limit to RefSeq genomes
example-1:
value: genbank
summary: Limit to GenBank genomes
example-2:
value: all
summary: All genomes
- name: filters.has_annotation
description: 'Return only annotated genome assemblies'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: true
summary: Limit to annotated assemblies
example-1:
value: false
summary: Return all assemblies
- name: filters.exclude_paired_reports
description: 'For paired (GCA/GCF) records, only return the primary record'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all assemblies
example-1:
value: true
summary: Only return single record for GCA/GCF pairs
- name: filters.exclude_atypical
description: 'If true, exclude atypical genomes, i.e. genomes that have assembly issues or are otherwise atypical'
in: query
required: false
schema:
type: boolean
default: false
examples:
example-0:
value: false
summary: Return all selected genomes, including ones that are atypical
example-1:
value: true
summary: Only return genomes that have not been classified as atypical
- name: filters.assembly_version
description: 'Return all assemblies, including replaced and suppressed, or only current assemblies'
in: query
required: false
schema:
$ref: '#/components/schemas/v2AssemblyDatasetDescriptorsFilterAssemblyVersion'
default: current
examples:
example-0:
value: current
summary: Only return current assemblies
example-1:
value: all_assemblies
summary: Return all assemblies, including suppressed and replaced
- name: filters.assembly_level
description: 'Only return genome assemblies that have one of the specified assembly levels. By default, do not filter.'
in: query
required: false
schema:
type: array
items:
$ref: '#/components/schemas/v2reportsAssemblyLevel'
examples:
example-0:
value:
- chromosome
- complete_genome
summary: Chromosome and complete genome