Sign in
simulation_boards

Create a simulation board for a study

Create a new simulation board within a study.

post/projects/{project_id}/studies/{study_id}/simulation_boards

Path parameters

project_idstring required
study_idstring required

Request body

namestring required

The name of the simulation board.

template_idstring required

The experiment template this board is bound to.

configobject

Visualization config (plots and grid layout).

table_filterobject

Persisted MUI DataGrid filter model for this board.

column_visibilityobject nullable

Persisted MUI DataGrid column visibility model for this board.

Response

Successful Response

namestring required

The name of the simulation board.

template_idstring required

The experiment template this board is bound to.

project_idstring required

The project this simulation board belongs to.

study_idstring nullable

The study this simulation board belongs to, if any.

organization_idstring required

Organization this simulation board belongs to.

configobject

Visualization config (plots and grid layout).

table_filterobject

Persisted MUI DataGrid filter model for this board.

column_visibilityobject nullable

Persisted MUI DataGrid column visibility model for this board.

idstring required

The unique identifier for the board.

created_atstring date-time required

Timestamp of when the board was created.

Changes

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