API endpoint /experiments

[mjstealey]

/experiments

Endpoints

• /experiments paginated
• /experiments/{int:pk}
• /experiments/{int:pk}/membership
• /experiments/{int:pk}/resources
• /experiments/{int:pk}/sessions
• /experiments/{int:pk}/files

Functions

• search - by name as project personnel (per project)
• create experiment - as project personnel (per project)
• update expermient - as experiment personnel (per project)
• delete experiment - as experiment_creator (is_retired = True, is_deleted = True)
• list experiment membership - as experiment members (per experiment)
• update experiment membership - as experiment members (per experiment)
• list experiment resources - as experiment members (per experiment)
• update experiment resources - as experiment members (per experiment)
• create - by experiment workflow - TODO: determine if needed (workflow logic)
• update - by experiment workflow - TODO: determine if needed (workflow logic)
• delete - by experiment workflow - TODO: determine if needed (workflow logic)

Fields

--- /experiments
canonical_number:    - int
description:         - string
experiment_creator:  - int
experiment_id:       - int
experiment_state:    - string
is_canonical:        - boolean
is_retired:          - boolean
name:                - string
--- /experiments/{int:pk}
canonical_number:    - int
created_date:        - string
description:         - string
experiment_creator:  - int
experiment_id:       - int
experiment_members:  - array of user-experiment (granted_by, granted_date, user_id)
experiment_state:    - string
is_canonical:        - boolean
is_retired:          - boolean
name:                - string
project_id:          - int
resources:           - array of int
--- /experiments/{int:pk}/members
experiment_members:  - array of user-experiment (granted_by, granted_date, user_id)
--- /experiments/{int:pk}/resources
description:         - string
is_active:           - boolean
location:            - string
name:                - string
resource_class:      - string
resource_id:         - int
resource_mode:       - string
resource_type:       - string
--- /experiments/{int:pk}/files
experiment_files:  - array of experiment_files (file_id, file_name, file_path, file_type, notes)

Notes

• Experiment membership to be limited to a subset of project_membership (project_owners, project_members)
• is_canonical - default to False, only set to True when all associated resources are "canonical"