View compendium

List compendia

Returns up to 100 results by default.

curl https://…/api/v1/compendium?limit=100&start=2

GET /api/v1/compendium?limit=100&start=2

200 OK

{
  "results": [
    "nkm4b",
    "asdis",
    "nb2sm",
    …
  ]
}

You can also filter the results.

  • Filter by user:
    • curl https://…/api/v1/compendium?user=0000-0002-1825-0097
    • GET /api/v1/compendium?user=0000-0002-1825-0097
  • Filter by doi:
    • curl https://…/api/v1/compendium?doi=10.9999%2Ftest
    • GET /api/v1/compendium?doi=10.9999%2Ftest
200 OK

{
  "results": [
    "nkm4b",
    "nb2sm"
  ]
}

If there is no compendium found, the service returns an empty list.

GET /api/v1/compendium?doi=not_a_doi

200 OK

{
  "results": []
}

URL parameters for compendium lists

  • job_id - Comma-separated list of related job ids to filter by.
  • user - Public user identifier to filter by.
  • doi - A DOI to filter by.
  • start - Starting point of the result list. start - 1 results are skipped. Defaults to 1.
  • limit - Limits the number of results in the response. Defaults to 100.

View single compendium

This includes the complete metadata set, related job ids and a tree representation of the included files. The created timestamp refers to the upload of the compendium. It is formated as ISO8601.

curl https://…/api/v1/$ID

GET /api/v1/compendium/:id

200 OK

{
  "id":"comid",
  "metadata": … ,
  "created": "2016-08-01T13:57:40.760Z",
  "files": …
 }

URL parameters for single compendium view

  • :id - the compendiums id

Error responses for single compendium view

404 Not Found

{"error":"no compendium with this id"}

curl https://…/api/v1/compendium/$ID/jobs

GET /api/v1/compendium/:id/jobs

200 OK
{
  "results": [
    "nkm4L",
    "asdi5",
    "nb2sg",
    …
  ]
}

If a compendium does not have any jobs yet, the returned list is empty.

200 OK
{
  "results": [ ]
}
  • :id - compendium id that the results should be related to