REST API

Find an interactive API explorer at REDOC API Speification

GET /actions

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• actions[].id (integer) –

• actions[].return_value (string) –

• actions[].success (boolean) –

• actions[].uri (string) –

GET /actions/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find action

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• api_uri (string) –

• end_time (string) –

• executions[].id (integer) –

• executions[].uri (string) –

• experiment.id (integer) –

• experiment.label (string) –

• experiment.uri (string) –

• freetext (string) –

• id (integer) –

• return_value (string) –

• start_time (string) –

• success (boolean) –

• transition.id (integer) –

• transition.uri (string) –

• uri (string) –

• web_uri (string) –

PUT /actions/{id}

Parameters:

• id (integer) –

Request JSON Object:

• end_time (string) –

• return_value (string) –

• success (boolean) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find action

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• api_uri (string) –

• end_time (string) –

• executions[].id (integer) –

• executions[].uri (string) –

• experiment.id (integer) –

• experiment.label (string) –

• experiment.uri (string) –

• freetext (string) –

• id (integer) –

• return_value (string) –

• start_time (string) –

• success (boolean) –

• transition.id (integer) –

• transition.uri (string) –

• uri (string) –

• web_uri (string) –

GET /callback_executions/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified callback_execution execution

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• action.api_uri (string) –

• action.end_time (string) –

• action.executions[].id (integer) –

• action.executions[].uri (string) –

• action.experiment.id (integer) –

• action.experiment.label (string) –

• action.experiment.uri (string) –

• action.freetext (string) –

• action.id (integer) –

• action.return_value (string) –

• action.start_time (string) –

• action.success (boolean) –

• action.transition.id (integer) –

• action.transition.uri (string) –

• action.uri (string) –

• action.web_uri (string) –

• api_uri (string) –

• callback.callback_arguments (string) –

• callback.condition (string) –

• callback.description (string) –

• callback.executions[].id (integer) –

• callback.executions[].uri (string) –

• callback.function (string) –

• callback.initial_delay (integer) –

• callback.label (string) –

• callback.run_timeout (integer) –

• callback.state.id (integer) –

• callback.state.label (string) –

• callback.state.uri (string) –

• callback.uri (string) –

• callback.wait_timeout (integer) –

• cohort.description (string) –

• cohort.external_urls (object) –

• cohort.id (integer) –

• cohort.label (string) –

• cohort.subjects[].id (integer) –

• cohort.subjects[].label (string) –

• cohort.subjects[].uri (string) –

• cohort.uri (string) –

• created (string) –

• experiment.api_uri (string) –

• experiment.external_ids (object) –

• experiment.id (integer) –

• experiment.label (string) –

• experiment.scandate (string) –

• experiment.state.id (integer) –

• experiment.state.label (string) –

• experiment.state.uri (string) –

• experiment.subject.id (integer) –

• experiment.subject.label (string) –

• experiment.subject.uri (string) –

• experiment.uri (string) –

• experiment.variable_map (object) –

• experiment.web_uri (string) –

• external_systems (object) –

• finished (string) –

• id (integer) –

• result (string) –

• result_log (string) –

• result_values (object) –

• run_log (string) –

• run_start (string) –

• status (string) –

• subject.api_uri (string) –

• subject.cohort.id (integer) –

• subject.cohort.label (string) –

• subject.cohort.uri (string) –

• subject.date_of_birth (string) –

• subject.experiments[].id (integer) –

• subject.experiments[].label (string) –

• subject.experiments[].uri (string) –

• subject.external_ids (object) –

• subject.id (integer) –

• subject.label (string) –

• subject.uri (string) –

• subject.web_uri (string) –

• uri (string) –

• wait_start (string) –

• web_uri (string) –

PUT /callback_executions/{id}

Parameters:

• id (integer) –

Request JSON Object:

• result (string) –

• result_log (string) –

• result_values (object) –

• run_log (string) –

• status (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find callback_execution

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• action.api_uri (string) –

• action.end_time (string) –

• action.executions[].id (integer) –

• action.executions[].uri (string) –

• action.experiment.id (integer) –

• action.experiment.label (string) –

• action.experiment.uri (string) –

• action.freetext (string) –

• action.id (integer) –

• action.return_value (string) –

• action.start_time (string) –

• action.success (boolean) –

• action.transition.id (integer) –

• action.transition.uri (string) –

• action.uri (string) –

• action.web_uri (string) –

• api_uri (string) –

• callback.callback_arguments (string) –

• callback.condition (string) –

• callback.description (string) –

• callback.executions[].id (integer) –

• callback.executions[].uri (string) –

• callback.function (string) –

• callback.initial_delay (integer) –

• callback.label (string) –

• callback.run_timeout (integer) –

• callback.state.id (integer) –

• callback.state.label (string) –

• callback.state.uri (string) –

• callback.uri (string) –

• callback.wait_timeout (integer) –

• cohort.description (string) –

• cohort.external_urls (object) –

• cohort.id (integer) –

• cohort.label (string) –

• cohort.subjects[].id (integer) –

• cohort.subjects[].label (string) –

• cohort.subjects[].uri (string) –

• cohort.uri (string) –

• created (string) –

• experiment.api_uri (string) –

• experiment.external_ids (object) –

• experiment.id (integer) –

• experiment.label (string) –

• experiment.scandate (string) –

• experiment.state.id (integer) –

• experiment.state.label (string) –

• experiment.state.uri (string) –

• experiment.subject.id (integer) –

• experiment.subject.label (string) –

• experiment.subject.uri (string) –

• experiment.uri (string) –

• experiment.variable_map (object) –

• experiment.web_uri (string) –

• external_systems (object) –

• finished (string) –

• id (integer) –

• result (string) –

• result_log (string) –

• result_values (object) –

• run_log (string) –

• run_start (string) –

• status (string) –

• subject.api_uri (string) –

• subject.cohort.id (integer) –

• subject.cohort.label (string) –

• subject.cohort.uri (string) –

• subject.date_of_birth (string) –

• subject.experiments[].id (integer) –

• subject.experiments[].label (string) –

• subject.experiments[].uri (string) –

• subject.external_ids (object) –

• subject.id (integer) –

• subject.label (string) –

• subject.uri (string) –

• subject.web_uri (string) –

• uri (string) –

• wait_start (string) –

• web_uri (string) –

GET /callbacks

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• callbacks[].id (integer) –

• callbacks[].label (string) –

• callbacks[].uri (string) –

GET /callbacks/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified callback

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• callback_arguments (string) –

• condition (string) –

• description (string) –

• executions[].id (integer) –

• executions[].uri (string) –

• function (string) –

• initial_delay (integer) –

• label (string) –

• run_timeout (integer) –

• state.id (integer) –

• state.label (string) –

• state.uri (string) –

• uri (string) –

• wait_timeout (integer) –

PUT /callbacks/{id}

Parameters:

• id (integer) –

Request JSON Object:

• callback_arguments (string) –

• condition (string) –

• description (string) –

• function (string) –

• initial_delay (integer) –

• label (string) –

• run_timeout (integer) –

• wait_timeout (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find callback

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• callback_arguments (string) –

• condition (string) –

• description (string) –

• executions[].id (integer) –

• executions[].uri (string) –

• function (string) –

• initial_delay (integer) –

• label (string) –

• run_timeout (integer) –

• state.id (integer) –

• state.label (string) –

• state.uri (string) –

• uri (string) –

• wait_timeout (integer) –

POST /cohorts

Request JSON Object:

• description (string) –

• label (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• description (string) –

• external_urls (object) –

• id (integer) –

• label (string) –

• subjects[].id (integer) –

• subjects[].label (string) –

• subjects[].uri (string) –

• uri (string) –

GET /cohorts

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• cohorts[].id (integer) –

• cohorts[].label (string) –

• cohorts[].uri (string) –

GET /cohorts/by-label/{label}

Parameters:

• label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified cohort

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• description (string) –

• external_urls (object) –

• id (integer) –

• label (string) –

• subjects[].id (integer) –

• subjects[].label (string) –

• subjects[].uri (string) –

• uri (string) –

GET /cohorts/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified cohort

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• description (string) –

• external_urls (object) –

• id (integer) –

• label (string) –

• subjects[].id (integer) –

• subjects[].label (string) –

• subjects[].uri (string) –

• uri (string) –

PUT /cohorts/{id}

Parameters:

• id (integer) –

Request JSON Object:

• description (string) –

• label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified cohort

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• description (string) –

• external_urls (object) –

• id (integer) –

• label (string) –

• subjects[].id (integer) –

• subjects[].label (string) –

• subjects[].uri (string) –

• uri (string) –

POST /cohorts/{id}/external_urls

Parameters:

• id (integer) –

Request JSON Object:

• external_urls (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Added external urls

• 404 Not Found – Could not find specified cohort or external system

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• cohort_id (integer) –

• cohort_label (string) –

• external_urls (object) –

GET /cohorts/{id}/external_urls

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified cohort

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• cohort_id (integer) –

• cohort_label (string) –

• external_urls (object) –

PUT /cohorts/{id}/external_urls/{system_name}

Parameters:

• id (integer) –

• system_name (string) –

Request JSON Object:

• external_url (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Changed external url

• 404 Not Found – Could not find specified cohort or external system

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• cohort_id (integer) –

• cohort_label (string) –

• external_urls (object) –

DELETE /cohorts/{id}/external_urls/{system_name}

Parameters:

• id (integer) –

• system_name (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified cohort, external system or external id

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• cohort_id (integer) –

• cohort_label (string) –

• external_urls (object) –

GET /cohorts/{label}/subjects

Parameters:

• label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified cohort

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• subjects[].id (integer) –

• subjects[].label (string) –

• subjects[].uri (string) –

GET /cohorts/{label}/subjects/{subject_label}

Parameters:

• label (string) –

• subject_label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified cohort or subject

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• api_uri (string) –

• cohort.id (integer) –

• cohort.label (string) –

• cohort.uri (string) –

• date_of_birth (string) –

• experiments[].id (integer) –

• experiments[].label (string) –

• experiments[].uri (string) –

• external_ids (object) –

• id (integer) –

• label (string) –

• uri (string) –

• web_uri (string) –

GET /cohorts/{label}/subjects/{subject_label}/experiments

Parameters:

• label (string) –

• subject_label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified cohort or subject

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiments[].id (integer) –

• experiments[].label (string) –

• experiments[].uri (string) –

GET /cohorts/{label}/subjects/{subject_label}/experiments/{experiment_label}

Parameters:

• label (string) –

• subject_label (string) –

• experiment_label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified cohort, subject, or experiment

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• api_uri (string) –

• external_ids (object) –

• id (integer) –

• label (string) –

• scandate (string) –

• state.id (integer) –

• state.label (string) –

• state.uri (string) –

• subject.id (integer) –

• subject.label (string) –

• subject.uri (string) –

• uri (string) –

• variable_map (object) –

• web_uri (string) –

POST /experiments

Request JSON Object:

• label (string) –

• scandate (string) –

• subject_id (integer) –

• workflow_label (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created experiment

• 404 Not Found – Could not find specified subject or workflow

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• api_uri (string) –

• external_ids (object) –

• id (integer) –

• label (string) –

• scandate (string) –

• state.id (integer) –

• state.label (string) –

• state.uri (string) –

• subject.id (integer) –

• subject.label (string) –

• subject.uri (string) –

• uri (string) –

• variable_map (object) –

• web_uri (string) –

GET /experiments

Query Parameters:

• scandate (string) –

• subject_id (string) –

• state (string) –

• offset (integer) – Offset for pagination

• limit (integer) – Maximum number of rows returned

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiments[].id (integer) –

• experiments[].label (string) –

• experiments[].uri (string) –

GET /experiments/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find experiment

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• api_uri (string) –

• external_ids (object) –

• id (integer) –

• label (string) –

• scandate (string) –

• state.id (integer) –

• state.label (string) –

• state.uri (string) –

• subject.id (integer) –

• subject.label (string) –

• subject.uri (string) –

• uri (string) –

• variable_map (object) –

• web_uri (string) –

GET /experiments/{id}/actions

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• actions[].id (integer) –

• actions[].return_value (string) –

• actions[].success (boolean) –

• actions[].uri (string) –

POST /experiments/{id}/external_ids

Parameters:

• id (integer) –

Request JSON Object:

• external_ids (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Added external ids

• 404 Not Found – Could not find specified experiment or external system

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiment_id (integer) –

• experiment_label (string) –

• external_ids (object) –

GET /experiments/{id}/external_ids

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified experiment

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiment_id (integer) –

• experiment_label (string) –

• external_ids (object) –

PUT /experiments/{id}/external_ids/{system_name}

Parameters:

• id (integer) –

• system_name (string) –

Request JSON Object:

• external_id (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Changed external id

• 404 Not Found – Could not find specified experiment or external system

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiment_id (integer) –

• experiment_label (string) –

• external_ids (object) –

DELETE /experiments/{id}/external_ids/{system_name}

Parameters:

• id (integer) –

• system_name (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified experiment, external system or external id

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiment_id (integer) –

• experiment_label (string) –

• external_ids (object) –

GET /experiments/{id}/state

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified experiment

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• state.id (integer) –

• state.label (string) –

• state.uri (string) –

PUT /experiments/{id}/state

Parameters:

• id (integer) –

Request JSON Object:

• freetext (string) –

• state_label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified state

• 409 Conflict – Cannot change state to specified state, no valid transition!

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• error (object) –

• state.id (integer) –

• state.label (string) –

• state.uri (string) –

• success (boolean) –

POST /external_experiment_links

Request JSON Object:

• experiment (string) –

• external_id (string) –

• external_system (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created

• 404 Not Found – Specified experiment and/or external system not found

• 409 Conflict – External experiment link for experiment/external system combination already exists

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiment.id (integer) –

• experiment.label (string) –

• experiment.uri (string) –

• external_id (string) –

• external_system.id (integer) –

• external_system.system_name (string) –

• external_system.uri (string) –

• external_system.url (string) –

• id (integer) –

• uri (string) –

GET /external_experiment_links

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_experiment_links[].experiment.id (integer) –

• external_experiment_links[].experiment.label (string) –

• external_experiment_links[].experiment.uri (string) –

• external_experiment_links[].external_id (string) –

• external_experiment_links[].external_system.id (integer) –

• external_experiment_links[].external_system.system_name (string) –

• external_experiment_links[].external_system.uri (string) –

• external_experiment_links[].external_system.url (string) –

• external_experiment_links[].id (integer) –

• external_experiment_links[].uri (string) –

PUT /external_experiment_links

Request JSON Object:

• experiment (string) –

• external_id (string) –

• external_system (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Specified experiment and/or external system not found

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiment.id (integer) –

• experiment.label (string) –

• experiment.uri (string) –

• external_id (string) –

• external_system.id (integer) –

• external_system.system_name (string) –

• external_system.uri (string) –

• external_system.url (string) –

• id (integer) –

• uri (string) –

GET /external_experiment_links/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Cannot find specified external experiment

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiment.id (integer) –

• experiment.label (string) –

• experiment.uri (string) –

• external_id (string) –

• external_system.id (integer) –

• external_system.system_name (string) –

• external_system.uri (string) –

• external_system.url (string) –

• id (integer) –

• uri (string) –

POST /external_subject_links

Request JSON Object:

• external_id (string) –

• external_system (string) –

• subject_id (integer) –

Status Codes:

• 200 OK – Success

• 201 Created – Created

• 404 Not Found – Specified experiment and/or external system not found

• 409 Conflict – External experiment link for subject/external system combination already exists

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_id (string) –

• external_system.id (integer) –

• external_system.system_name (string) –

• external_system.uri (string) –

• external_system.url (string) –

• id (integer) –

• subject.id (integer) –

• subject.label (string) –

• subject.uri (string) –

• uri (string) –

GET /external_subject_links

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_subject_links[].external_id (string) –

• external_subject_links[].external_system.id (integer) –

• external_subject_links[].external_system.system_name (string) –

• external_subject_links[].external_system.uri (string) –

• external_subject_links[].external_system.url (string) –

• external_subject_links[].id (integer) –

• external_subject_links[].subject.id (integer) –

• external_subject_links[].subject.label (string) –

• external_subject_links[].subject.uri (string) –

• external_subject_links[].uri (string) –

PUT /external_subject_links

Request JSON Object:

• external_id (string) –

• external_system (string) –

• subject_id (integer) –

Status Codes:

• 200 OK – Success

• 201 Created – Created

• 404 Not Found – Specified experiment and/or external system not found

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_id (string) –

• external_system.id (integer) –

• external_system.system_name (string) –

• external_system.uri (string) –

• external_system.url (string) –

• id (integer) –

• subject.id (integer) –

• subject.label (string) –

• subject.uri (string) –

• uri (string) –

GET /external_subject_links/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Cannot find specified external subject

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_id (string) –

• external_system.id (integer) –

• external_system.system_name (string) –

• external_system.uri (string) –

• external_system.url (string) –

• id (integer) –

• subject.id (integer) –

• subject.label (string) –

• subject.uri (string) –

• uri (string) –

GET /external_systems

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_systems[].id (integer) –

• external_systems[].system_name (string) –

• external_systems[].uri (string) –

• external_systems[].url (string) –

GET /external_systems/by-name/{system_name}

Parameters:

• system_name (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Cannot find specified external system

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• id (integer) –

• system_name (string) –

• uri (string) –

• url (string) –

GET /external_systems/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Cannot find specified external system

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• id (integer) –

• system_name (string) –

• uri (string) –

• url (string) –

GET /roles

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• roles[].id (integer) –

• roles[].name (string) –

• roles[].uri (string) –

GET /roles/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find role

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• description (string) –

• id (integer) –

• name (string) –

• permissions[] (string) –

• update_datetime (string) –

• uri (string) –

POST /scans

Status Codes:

• 200 OK – Success

• 201 Created – Created

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiment.id (integer) –

• experiment.label (string) –

• experiment.uri (string) –

• id (integer) –

• scantype.id (integer) –

• scantype.modality (string) –

• scantype.protocol (string) –

• scantype.uri (string) –

• uri (string) –

GET /scans

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• scans[].experiment.id (integer) –

• scans[].experiment.label (string) –

• scans[].experiment.uri (string) –

• scans[].id (integer) –

• scans[].scantype.id (integer) –

• scans[].scantype.modality (string) –

• scans[].scantype.protocol (string) –

• scans[].scantype.uri (string) –

• scans[].uri (string) –

GET /scans/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Requested scan not found

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiment.id (integer) –

• experiment.label (string) –

• experiment.uri (string) –

• id (integer) –

• scantype.id (integer) –

• scantype.modality (string) –

• scantype.protocol (string) –

• scantype.uri (string) –

• uri (string) –

GET /scantypes

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• scantypes[].id (integer) –

• scantypes[].modality (string) –

• scantypes[].protocol (string) –

• scantypes[].uri (string) –

GET /scantypes/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified scantype

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• id (integer) –

• modality (string) –

• protocol (string) –

• uri (string) –

POST /service/check_timeouts

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• run_timeouts (integer) –

• wait_timeouts (integer) –

POST /service/config/import-config

Request JSON Object:

• config_definition (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_systems[].id (integer) –

• external_systems[].system_name (string) –

• external_systems[].uri (string) –

• external_systems[].url (string) –

• roles[].id (integer) –

• roles[].name (string) –

• roles[].uri (string) –

• scantypes[].id (integer) –

• scantypes[].modality (string) –

• scantypes[].protocol (string) –

• scantypes[].uri (string) –

• updated_at (string) –

• users[].id (integer) –

• users[].name (string) –

• users[].uri (string) –

• users[].username (string) –

PUT /service/config/import-config

Request JSON Object:

• config_definition (string) –

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_systems[].id (integer) –

• external_systems[].system_name (string) –

• external_systems[].uri (string) –

• external_systems[].url (string) –

• roles[].id (integer) –

• roles[].name (string) –

• roles[].uri (string) –

• scantypes[].id (integer) –

• scantypes[].modality (string) –

• scantypes[].protocol (string) –

• scantypes[].uri (string) –

• updated_at (string) –

• users[].id (integer) –

• users[].name (string) –

• users[].uri (string) –

• users[].username (string) –

POST /service/config/import-workflow

Request JSON Object:

• workflow_definition (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• id (integer) –

• label (string) –

• uri (string) –

GET /states

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• states[].id (integer) –

• states[].label (string) –

• states[].uri (string) –

GET /states/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified state

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• callbacks[] (string) –

• experiments[].id (integer) –

• experiments[].label (string) –

• experiments[].uri (string) –

• freetext (string) –

• id (integer) –

• label (string) –

• uri (string) –

• workflow.id (integer) –

• workflow.label (string) –

• workflow.uri (string) –

GET /states/{id}/experiments

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified state

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• experiments[].id (integer) –

• experiments[].label (string) –

• experiments[].uri (string) –

POST /subjects

Request JSON Object:

• cohort_label (string) –

• date_of_birth (string) –

• label (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• api_uri (string) –

• cohort.id (integer) –

• cohort.label (string) –

• cohort.uri (string) –

• date_of_birth (string) –

• experiments[].id (integer) –

• experiments[].label (string) –

• experiments[].uri (string) –

• external_ids (object) –

• id (integer) –

• label (string) –

• uri (string) –

• web_uri (string) –

GET /subjects

Query Parameters:

• cohort_label (string) – Cohort label

• offset (integer) – Offset for pagination

• limit (integer) – Maximum number of rows returned

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• subjects[].id (integer) –

• subjects[].label (string) –

• subjects[].uri (string) –

GET /subjects/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified subject

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• api_uri (string) –

• cohort.id (integer) –

• cohort.label (string) –

• cohort.uri (string) –

• date_of_birth (string) –

• experiments[].id (integer) –

• experiments[].label (string) –

• experiments[].uri (string) –

• external_ids (object) –

• id (integer) –

• label (string) –

• uri (string) –

• web_uri (string) –

PUT /subjects/{id}

Parameters:

• id (integer) –

Request JSON Object:

• cohort_label (string) –

• date_of_birth (string) –

• label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified subject

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• api_uri (string) –

• cohort.id (integer) –

• cohort.label (string) –

• cohort.uri (string) –

• date_of_birth (string) –

• experiments[].id (integer) –

• experiments[].label (string) –

• experiments[].uri (string) –

• external_ids (object) –

• id (integer) –

• label (string) –

• uri (string) –

• web_uri (string) –

POST /subjects/{id}/external_ids

Parameters:

• id (integer) –

Request JSON Object:

• external_ids (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Added external ids

• 404 Not Found – Could not find specified subject or external system

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_ids (object) –

• subject_id (integer) –

• subject_label (string) –

GET /subjects/{id}/external_ids

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified subject

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_ids (object) –

• subject_id (integer) –

• subject_label (string) –

PUT /subjects/{id}/external_ids/{system_name}

Parameters:

• id (integer) –

• system_name (string) –

Request JSON Object:

• external_id (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Changed external id

• 404 Not Found – Could not find specified subject or external system

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_ids (object) –

• subject_id (integer) –

• subject_label (string) –

DELETE /subjects/{id}/external_ids/{system_name}

Parameters:

• id (integer) –

• system_name (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified subject, external system or external id

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• external_ids (object) –

• subject_id (integer) –

• subject_label (string) –

GET /transitions

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• transitions[].id (integer) –

• transitions[].uri (string) –

GET /transitions/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified transition

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• condition (string) –

• destination_state.id (integer) –

• destination_state.label (string) –

• destination_state.uri (string) –

• id (integer) –

• source_state.id (integer) –

• source_state.label (string) –

• source_state.uri (string) –

• uri (string) –

POST /users

Request JSON Object:

• active (boolean) –

• email (string) –

• name (string) –

• password (string) –

• username (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created user

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• active (boolean) –

• create_time (string) –

• email (string) –

• id (integer) –

• name (string) –

• uri (string) –

• username (string) –

GET /users

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• users[].id (integer) –

• users[].name (string) –

• users[].uri (string) –

• users[].username (string) –

PUT /users/{id}

Parameters:

• id (integer) –

Request JSON Object:

• active (boolean) –

• email (string) –

• name (string) –

• password (string) –

• username (string) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to perform this operation

• 404 Not Found – Could not find user

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• active (boolean) –

• create_time (string) –

• email (string) –

• id (integer) –

• name (string) –

• uri (string) –

• username (string) –

GET /users/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to get this information

• 404 Not Found – Could not find user

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• active (boolean) –

• create_time (string) –

• email (string) –

• id (integer) –

• name (string) –

• uri (string) –

• username (string) –

DELETE /users/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find user

PUT /users/{username}/roles/{role_name}

Parameters:

• username (string) –

• role_name (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – User or Role not found

DELETE /users/{username}/roles/{role_name}

Parameters:

• username (string) –

• role_name (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – User or Role not found

GET /workflows

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• workflows[].id (integer) –

• workflows[].label (string) –

• workflows[].uri (string) –

GET /workflows/by-label/{label}

Parameters:

• label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified workflow

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• id (integer) –

• label (string) –

• uri (string) –

GET /workflows/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified workflow

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• id (integer) –

• label (string) –

• uri (string) –

GET /workflows/{workflow_label}/states

Parameters:

• workflow_label (string) –

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• states[].id (integer) –

• states[].label (string) –

• states[].uri (string) –

GET /workflows/{workflow_label}/states/{state_label}

Parameters:

• workflow_label (string) –

• state_label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find specified state

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• callbacks[] (string) –

• experiments[].id (integer) –

• experiments[].label (string) –

• experiments[].uri (string) –

• freetext (string) –

• id (integer) –

• label (string) –

• uri (string) –

• workflow.id (integer) –

• workflow.label (string) –

• workflow.uri (string) –