Search Submissions

Operations related to search, list or generate page tab documents for submissions

Get Submissions

GET http://biostudy-prod.ebi.ac.uk:8788/submissions

Search for submissions that belong to the user and match the given parameters. Example: curl -H "X-SESSION-TOKEN: <authToken>" \ http://biostudy-prod.ebi.ac.uk:8788/submissions?offset=1&limit=2&keywords=BioImages&released=true

Query Parameters

Name	Type	Description
offset	string	Page number
limit	string	Limit of the search result
accNo	string	Search for submissions with the given accession number
version	string	Search for submissions with the given version
type	string	Search for submissions with the given type. It should be either FILE or PAGE_TAB
rTimeFrom	string	Search for submissions which release time is past the given date
rTimeTo	string	Search for submissions which release time is before the given date
keywords	string	Search for submissions which title contains the given keyword
released	boolean	Search for submissions based on their visibility. True for public submissions, false for private.

Headers

Name	Type	Description
X-SESSION-TOKEN	string	User authentication token

200

[{
  "accno": "S-BSST113",
  "title": "Resubmission For Files",
  "version": 2,
  "ctime": "2021-02-16T11:04:43.173Z",
  "mtime": "2021-02-16T11:12:47.257Z",
  "rtime": "2021-01-15T00:00:00Z",
  "method": "FILE",
  "status": "PROCESSED"
}, {
  "accno": "S-BSST112",
  "title": "Resubmission For Files",
  "version": 2,
  "ctime": "2021-02-16T10:52:55.813Z",
  "mtime": "2021-02-16T10:55:07.851Z",
  "rtime": "2021-01-15T00:00:00Z",
  "method": "FILE",
  "status": "PROCESSED"
}]

401 Could not find a cake matching this query.

JSON Submission

GET http://biostudy-prod.ebi.ac.uk:8788/submissions/{accNo}.json

Get the page tab document in JSON format for the submission with the given accession number. Example: curl -H "X-SESSION-TOKEN: <authToken>" \ http://biostudy-prod.ebi.ac.uk:8788/submissions/S-BSST1.json

Query Parameters

Name	Type	Description
accNo	string	Accession number to get the page tab document

Headers

Name	Type	Description
X-SESSION-TOKEN	string	User authorization token

200

{
  "accno" : "S-BSST112",
  "attributes" : [ {
    "name" : "Title",
    "value" : "Resubmission For Files"
  }, {
    "name" : "ReleaseDate",
    "value" : "2021-01-15"
  } ],
  "section" : {
    "type" : "Study",
    "files" : [ {
      "path" : "test.txt",
      "size" : 10,
      "type" : "file"
    } ]
  }
}

401

TSV Submission

GET http://biostudy-prod.ebi.ac.uk:8788/submissions/{accNo}.tsv

Get the page tab document in TSV format for the submission with the given accession number. Example: curl -H "X-SESSION-TOKEN: <authToken>" \ http://biostudy-prod.ebi.ac.uk:8788/submissions/S-BSST1.tsv

Query Parameters

Name	Type	Description
accNo	string	Accession number to get the page tab document

Headers

Name	Type	Description
X-SESSION-TOKEN	string	User authorization token

200

Submission	S-BSST112
Title	Resubmission For Files
ReleaseDate	2021-01-15

Study

File	test.txt

401

XML Submission

GET http://biostudy-prod.ebi.ac.uk:8788/submissions/{accNo}.json

Get the page tab document in XML format for the submission with the given accession number. Example: curl -H "X-SESSION-TOKEN: <authToken>" \ http://biostudy-prod.ebi.ac.uk:8788/submissions/S-BSST1.xml

Query Parameters

Name	Type	Description
accNo	string	Accession number to get the page tab document

Headers

Name	Type	Description
X-SESSION-TOKEN	string	User authorization token

200

<?xml version='1.0' encoding='UTF-8'?>
<submission accno="S-BSST112">
  <attributes>
    <attribute>
      <name>Title</name>
      <value>Resubmission For Files</value>
    </attribute>
    <attribute>
      <name>ReleaseDate</name>
      <value>2021-01-15</value>
    </attribute>
  </attributes>
  <section type="Study">
    <files>
      <file size="10">
        <path>test.txt</path>
        <type>file</type>
      </file>
    </files>
  </section>
</submission>

401