NCncats
Genome

Get a download summary (preview) of a genome annotation data package by genome assembly accession

Changed on

Get a download summary (preview) of a genome annotation data package, including counts and file sizes, by genome assembly accession, in JSON format.

post/genome/annotation_report/download_summary

Request

  • Base URL
    https://api.ncbi.nlm.nih.gov/datasets/v2
  • Auth
    API key in header api-key

Request body

accessionstring
annotation_idsstring[]
symbolsstring[]
locationsstring[]
gene_typesstring[]
search_textstring[]
include_annotation_typeV2GenomeAnnotationRequestAnnotationType[]
page_sizeinteger
table_fieldsstring[]
table_format'NO_TABLE' | 'SUMMARY' | 'PRODUCT'
include_tabular_header'INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY' | 'INCLUDE_TABULAR_HEADER_ALWAYS' | 'INCLUDE_TABULAR_HEADER_NEVER'
page_tokenstring

Response

A successful response

record_countinteger
assembly_countinteger
resource_updated_onstring date-time

Changes

  • e5d4400c8e5dRevision changes
    • info

      added the new DEFAULT enum value to the request property /

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

  • 6b24249801ecRevision changes
    • info

      the request property default value DEFAULT was added

    • info

      the request property default value SORT_DIRECTION_UNSPECIFIED was added

    • info

      the request property default value INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY was added

    • info

      the request property default value NO_TABLE was added

    • info

      the response's property default value UNKNOWN_ASSEMBLY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_ASSEMBLY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_GENE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_GENE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_GENE_WARNING_CODE was added for the status

    • info

      the response's property default value UNKNOWN_ORGANELLE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_ORGANELLE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_TAXONOMY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_TAXONOMY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_VIRUS_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_VIRUS_ERROR_CODE was added for the status