Difference between revisions of "API for Server Data Queries"

From EteRNA WiKi
Jump to: navigation, search
(Added type=active_projects)
(Example for in-game usage as well as browser based)
Line 3: Line 3:
 
<p>&nbsp;</p>
 
<p>&nbsp;</p>
 
<p>==Overview==</p>
 
<p>==Overview==</p>
<p>&nbsp;</p>
+
<p>Queries can be submitted directly from any browser (by specifying the URL in the browser's address bar), from an application running inthe browser, or from the in-game scrpting engine.&nbsp; When issued from a browser, the query takes the form of a URL.&nbsp; Wnem issued from the in-game scrpting engine, it takes the form of a call to the function AjaxManager.querySync.</p>
 
<p>===Examples===</p>
 
<p>===Examples===</p>
<p>The URL <a href="http://eterna.cmu.edu/get/?type=lab&amp;nid=2857430">http://eterna.cmu.edu/get/?type=lab&amp;nid=2857430</a> requests data about the lab with ID 2857430.</p>
+
<p>====From a browser====</p>
<p>However, it doesn't return any information about the synthesis results.&nbsp; To get those, the URL is <a href="http://eterna.cmu.edu//get/?type=solutions&amp;puznid=2857430">http://eterna.cmu.edu//get/?type=solutions&amp;puznid=2857430</a>.&nbsp; Notice that the option names (nid and puznid) are differernt for the two queries, but they both refer to the lab ID.</p>
+
<ul>
<p>&nbsp;</p>
+
<li><a href="http://eterna.cmu.edu/get/?type=lab&amp;nid=2857430">http://eterna.cmu.edu/get/?type=lab&amp;nid=2857430</a> requests metadata about the lab with ID 2857430.</li>
 +
</ul>
 +
<p>====From in-game scripts====</p>
 +
<ul>
 +
<li><span style="font-family: courier new,courier;">AjaxManager.querySync("GET", Application.GET_URI, {type:lab, nid:2857430})</span> requests data about the lab with ID 2857430.</li>
 +
</ul>
 
<p>==Query types==</p>
 
<p>==Query types==</p>
 
<p>===type=active_labs===</p>
 
<p>===type=active_labs===</p>

Revision as of 21:31, 23 October 2013

The EteRNA servers implement a RESTful API for much of the data behind both the game and lab.  This data is available to both in-game scripts and browser-based tools.

Contents

 

Overview

Queries can be submitted directly from any browser (by specifying the URL in the browser's address bar), from an application running inthe browser, or from the in-game scrpting engine.  When issued from a browser, the query takes the form of a URL.  Wnem issued from the in-game scrpting engine, it takes the form of a call to the function AjaxManager.querySync.

Examples

From a browser

From in-game scripts

  • AjaxManager.querySync("GET", Application.GET_URI, {type:lab, nid:2857430}) requests data about the lab with ID 2857430.

Query types

type=active_labs

This is a deprecated API for getting information about active labs.  The recommended query is now type=active_projects.

type=active_projects

Other parameters

  • start - the first index of the array of labs (deafults to 0).  Together with the size parameter, this is used to break the list over multiple plages.
  • size - the number of active labs to return

Information returned

This returns information about the currently active labs. The information includes

  • Lab ID (called nid here)
  • Lab Ddscription (called body)
  • Lab founder

This query does not include anything about the lab's submissions.  To get information about submissions to an active lab, use the type-solutions query for each lab id in this list.

For more details, see Server Queries: type=active_projects.

type=groups

type=lab

Other parameters

  • nid - the lab ID (required)

Information returned

This returns meta information about the lab.  It's content is largely determined by what information appears on the UI's main page for the lab, e.g. http://eterna.cmu.edu/web/lab/3376133/.  This includes the

  • Title
  • Description
  • Target structure
  • Comments
  • Number of submissions
  • Number of syntheses, if any
  • Summary of the highest scoring syntheses

For more details, see Server Queries: type=lab.

 

type=past_labs

type=pending_labs

type=puzzle

type=script

type=solutions

type=user

type=votes

Issues surrounding recent changes

For the moment,  this is focused on documenting the 9/26 changes that broke a bunch of existing scripts.

Update: Justin says he'll return the old API, to preserve compatibility with existing scripts.  Thanks, Justin!

Friday (5:50 PM PDT) update: My Data Mining Tool, which was broken by the change to the type=lab query, now works again.  But I think Justin was probably especially careful about fixing the queries it uses.  I advise anyone reading this to test any scripts they really care about, and if it is still broken, post here.  Please describe the query URL, and what about the JSON is missing.

Omei (talk) 01:30, 28 September 2013 (UTC)

 

My favorite script by Stlne is broken. The one that states how many votes and design slots I have left in a lab. Here is its URL: http://eterna.cmu.edu/web/script/3126111/ and here is the message I get back: Return : jsonOut.data.labs is undefined

-- Eli Fisker (talk) 16:42, 2 October 2013 (UTC)

I confirmed this has been fixed.

Omei (talk) 18:50, 16 October 2013 (UTC)

---

The script is now running, but except for the top lab in the pic I have linked in here, it is stuck in time, only showing past rounds labs

-- Eli Fisker (talk) 20:46, 16 October 2013 (UTC)


Agreed; this was my mistake. The UI is generating the same query, "http://eterna.cmu.edu//get/?type=active_labs", as the script, but somehow the UI gets the right answer.  Must be something in the headers.  In any case, Justin is aware of it now.

Omei (talk) 23:49, 16 October 2013 (UTC)

 

type=past-labs: New fields are needed to access the thumbnail images (change)

I note two related changes here, but I wouldn't consider asking Justin t change it for my scripts.  They seem like a reasonable step in moving forward.

  1. The thumbnail images have been moved to Amazon's S3 service.  The thumbnails don't exist at their old location.  This breaks scripts that displayed the thumbnails, like my took that creates the list of past labs here on the wiki.  But moving them to Amazon seems good, so I'm just going to update that script.
    Update: To my pleasant surprise, the thumbnails are back at the old URL on the Eterna servers, as well as thei new location in the Amazon cloud.  Not only that, but thumbnails for the newest labs have been added, too.  So I don't have to update the script right away.  For me, this is striking evidence that Eterna really is serious about supporting player-led developments.  A big thanks to the Eterna devs in general and (presumably) to Justin in particular.
  2. The format of the type=past-labs query (e.g. http://eterna.cmu.edu/get/?type=past_labs&skip=0&size=21 response has changed.  It may well be completely backward compatible; I'm not sure because I don't have a complete record of what it was.  But as it stands now, a solution has a field named "puzzles", which is an array of objects.  Each element of the array is an object which has a field also called "puzzles", which is also an array.  Each element of this array is a nid which seems to correspond to a secondary structure, because the query "https://s3.amazonaws.com/eterna/puzzle_mid_thumbnails/thumbnail<nid>.png" returns a thumbnail image of the target structure for that lab. I think this new level of indirection is there to support labs that allow sequences with differernt lengths and target structures. The reproducibility lab is one example, but I remember Rhiju talking about supporting this, long before the reproducibility lab came into being.

Omei (talk) 01:30, 28 September 2013 (UTC)

---

type=lab: Doesn't return anything meaningful for labs in last synthesis round

Apparently Justin restored the behavior of the lab query for existing labs, but didn't cary that over to new labs.  A query for a new lab returns

{"data":{"lab":null,"comments":[],"supercomments":[],"num_synthesized":0,"follow":[],"num_slots":false,"sum_picks":null,"num_solutions":"0","my_votes":null,"uid":"57675"},"memcache":true}

So any existing scripts that use the lab query are still broken for new labs.  I'll raise this issue with Justin.

Resolution: Justin pointed out that I was incorrect; the lab query for the latest round returns the same results it used to.  The cause of my confusion is that the in-game URLs can be misleading.  If you go to the past labs page and choose the Reprodicibility Lab, you'r be taken to the URL http://eterna.cmu.edu/web/lab/3376330/.&nbsp; But 3376330 is not the lab ID; it is the project (a new construct)  ID.  To determine the lab ID, you have to click through to the browse page, whose URL is http://eterna.cmu.edu/web/browse/3293294/. Here we see the lab ID, and if you use that in a type=lab GET query, you'll get the results you expect.

Hopefully the project/lab terminolgy will get straigthened out.

Omei (talk) 23:45, 30 September 2013 (UTC)


Missing Semicirle - 2 bends and Semicircle - 5 bends in past labs.

This is a strange one.  I don't know that it is related to the recent server changes, but I'll note it here.

The two labs Semicircle - 2 bends and Semicircle - 5 bends, which were part of Cloud Lab 8, have disappeared from the past_labs query and replaced by Semicircle - 3 bends and Semicircle - 4 bends, which were part of Cloud Lab 9.  The easiest way to confirm this is to look at the most recent diff for the list of labs.  Search for "2 bends".  I verified that the GET query for past_labs isn't returning them, but the queries for solutions and lab still do.

Omei (talk) 01:57, 3 October 2013 (UTC)

 

These two labs are under Proposed labs for now, as the new button for open 2 round was so easy to hit that several lab makers hit it by accident. Justin has disabled the option for now.

-- Eli Fisker (talk) 20:46, 16 October 2013 (UTC)


 

 


Personal tools
Main page
Introduction to the Game