Make (or return) the run's example PDF

Sets the run's PDF summary as its workflow version's example
(docs/run-examples.md). Needs edit permission on the workflow, read
access to every dataset the run wrote to, and a SUCCEEDED run.

  • A READY PDF for this run (refresh false): 200 with it, and it is
    (re)set as the version's example; nothing is generated or counted.
  • A job already in flight for this run: 202 with it.
  • Otherwise a new job starts (202): it takes the workflow's lock and
    counts against the daily per-workflow, per-user and per-workspace
    limits; refresh true regenerates a PDF that exists.

503 when examples are not enabled.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
boolean
Defaults to false
string

Optional; refused (422) when the run isn't of this workflow.

integer

Optional; refused (422) when the run didn't run this version.

Responses

502

The request couldn't be queued for the curation service; the job is FAILED and the lock released

503

Examples are not enabled

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json