NCncats
Gene

Get a download summary of a gene data package

Changed on

Get a download summary of a gene data package, including counts and estimated package size, in JSON format.

post/gene/download_summary

Request

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

Request body

gene_idsinteger[]
include_annotation_typeV2Fasta[]
returned_content'COMPLETE' | 'IDS_ONLY'
fasta_filterstring[]
accession_filterstring[]
aux_reportV2GeneDatasetRequestGeneDatasetReportType[]
tabular_reportsV2GeneDatasetRequestGeneDatasetReportType[]
table_fieldsstring[]
table_report_type'DATASET_REPORT' | 'PRODUCT_REPORT'

Response

A successful response

record_countinteger
assembly_countinteger
resource_updated_onstring date-time

Changes

  • e5d4400c8e5dRevision changes
    • 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 DATASET_REPORT was added

    • info

      the request property default value DATASET_REPORT was added

    • info

      the request property default value FASTA_UNSPECIFIED was added

    • info

      the request property default value COMPLETE was added

    • info

      the request property default value DATASET_REPORT 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