Studies

Publish a study

Builds the study bundle, increments the study revision, and creates a published study record. Returns the published study metadata.

post/studies/{studyId}/publish

Request

  • Base URL: http://localhost:8080/api/v0
  • URL: http://localhost:8080/api/v0/studies/{studyId}/publish
  • Auth: HTTP bearer

Path parameters

studyIdstring uuid required

Response

Study published successfully

idstring uuid required
studyIdstring uuid required
revisioninteger required

The revision number of this publication

visibility'public' | 'unlisted' required

Whether a published study is listed publicly or only accessible via invitation code

bundleURLstring uri required

URL to download the study bundle

publishedAtstring date-time required

When this revision was published

Example response

{
  "revision": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.