| Method | URI | Auth | Body | Parameters | Return | Description |
|---|---|---|---|---|---|---|
| Studies | ||||||
| GET | /studies | Researcher | - | PaginatedResults<Study> | All studies (for creating links within any community) | |
| POST | /studies | Researcher | Study | Study | study with id returned | |
| GET | /studies/{id} | Researcher | - | Study | ||
| PUT | /studies/{id} | Researcher | Study | Study | ||
| DELETE | /studies/{id} | Researcher | - | - | ||
| Forms / Dataset Definitions (one per research instrument participants will use in a study) | ||||||
| GET | /studies/{id}/forms | Researcher | - | PaginatedResults<Form> | Unlikely to be more than a page of these | |
| POST | /studies/{id}/forms | Researcher | Form | Form | form with id returned | |
| GET | /studies/{id}/forms/{id} | Researcher | - | Form | ||
| PUT | /studies/{id}/forms/{id} | Researcher | Form | Form | ||
| DELETE | /studies/{id}/forms/{id} | Researcher | - | - | ||
Researcher - can be pretty much any Synapse user
GET /studies/{id}/form get all dataset definitions for study {id}
POST /studies/{id}/form create a new dataset definition
GET /studies/{id}/form/{id} get dataset definition
PUT /studies/{id}/form/{id} update dataset definition
DELETE /studies/{id}/form/{id} delete this dataset definition