[ensembl-dev] Ensembl REST API | Documentation for returned JSON objects

[Ramiro Magno]

Cheers Brandon!

On Mon, 5 Aug 2019 at 12:02, Brandon Walts <bwalts at ebi.ac.uk> wrote:
>
> Hi Ramiro
>
> Unfortunately, this is not yet fully documented.
>
> To answer your questions, yes, 1 means current.
>
> There appears to be a bug in some of the values for "peptide" where null is returned even for proteins. Thank you for bringing this to our attention and we will look into it.
>
> possible_replacement returns a list of "successors" for the ID, in other words a list of stable IDs up to the current stable ID that have replaced a retired stable ID. For example, http://rest.ensembl.org/archive/id/ENSG00000263255?content-type=text/plain - ENSG00000263255 having been retired and superceeded by ENSG00000256229
>
> Best
> -Brandon
>
> On 30/07/2019 16:10, Ramiro Magno wrote:
>
> Hi Devs,
>
> Is there documentation on the variables returned in JSON responses?
>
> For example:
>
> http://rest.ensembl.org/documentation/info/archive_id_get
>
> Returns a JSON object of 9 variables:
>
> - id
> - latest
> - type
> - version
> - release
> - is_current
> - assembly
> - peptide
> - possible_replacement
>
> While some of them self-explanatory, others it is not obvious to me what the exact meaning and what kind of values I might encounter. For instance, "is_current", seems to be coded as "1" or "0"? Where "1" means current? Not sure what "peptide" means either, most examples I tried gives NULL; not sure what "possible_replacement" means too.
>
> Many thanks, RM
>
> _______________________________________________
> Dev mailing list    Dev at ensembl.org
> Posting guidelines and subscribe/unsubscribe info: https://lists.ensembl.org/mailman/listinfo/dev_ensembl.org
> Ensembl Blog: http://www.ensembl.info/
>
> _______________________________________________
> Dev mailing list    Dev at ensembl.org
> Posting guidelines and subscribe/unsubscribe info: https://lists.ensembl.org/mailman/listinfo/dev_ensembl.org
> Ensembl Blog: http://www.ensembl.info/