IOionworks
studies

Update a study

Changed on

Update an existing study.

patch/projects/{project_id}/studies/{study_id}

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/projects/{project_id}/studies/{study_id}
  • Auth
    none declared

Path parameters

project_idstring uuid required
study_idstring uuid required

Request body

namestring nullable

The new name of the study.

descriptionstring nullable

The new optional description for the study.

Response

Successful Response

namestring required

The name of the study.

descriptionstring nullable

An optional description for the study.

project_idstring required

The ID of the project this study belongs to.

organization_idstring required

Organization this study belongs to.

created_bystring nullable

User ID of the creator.

idstring required

The unique identifier for the study.

created_atstring date-time required

Timestamp of when the study was created.

updated_atstring date-time required

Timestamp of when the study was last updated.

Changes

  • ea3d377fec1aRevision changes
    • breaking

      for the path request parameter project_id, the format changed from no format to uuid

    • breaking

      for the path request parameter study_id, the format changed from no format to uuid