NCncats
Organelle

Get an organelle data report

Changed on

Get an organelle data report in JSON format.

post/organelle/dataset_report

Request

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

Request body

taxonsstring[]
accessionsstring[]
organelle_typesV2reportsOrganelleType[]
first_release_datestring date-time
last_release_datestring date-time
tax_exact_matchboolean
returned_content'COMPLETE' | 'ASSM_ACC'
page_sizeinteger
page_tokenstring
table_format'ORGANELLE_TABLE_FORMAT_NO_TABLE' | 'SUMMARY'
include_tabular_header'INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY' | 'INCLUDE_TABULAR_HEADER_ALWAYS' | 'INCLUDE_TABULAR_HEADER_NEVER'

Response

A successful response

total_countinteger
next_page_tokenstring

Changes

  • e5d4400c8e5dRevision changes
    • info

      added the media type application/x-ndjson for the response with the status

    • info

      added the media type text/tab-separated-values for the response with the status

    • info

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

  • 6b24249801ecRevision changes
    • info

      the request property default value ORGANELLE_TYPE_UNKNOWN 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 COMPLETE was added

    • info

      the request property default value ORGANELLE_TABLE_FORMAT_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 ORGANELLE_TYPE_UNKNOWN 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_TAXONOMY_ERROR_CODE was added for the status

    • info

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

    • info

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