Codalab API Reference
competition
list
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator | |
search | A search term. |
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | |
description | |
url_redirect | (NOTE: You should not have Registration Required above checked if using URL redirection, because upon redirect participants will not be approved and unable to participate.) |
image | |
has_registration | |
start_date | |
end_date | |
creator required | |
modified_by required | |
last_phase_migration | |
is_migrating | |
force_submission_to_leaderboard | |
disallow_leaderboard_modifying | |
enable_medical_image_viewer | |
enable_detailed_results | |
reward | |
is_migrating_delayed | |
allow_teams | |
enable_per_submission_metadata | (Team name, Method name, Method description, etc.) |
allow_public_submissions | |
enable_forum | |
anonymous_leaderboard | |
enable_teams | |
require_team_approval | |
hide_top_three | |
hide_chart | |
allow_organizer_teams | |
deleted |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this competition. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator | |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this competition. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title required | |
description | |
url_redirect | (NOTE: You should not have Registration Required above checked if using URL redirection, because upon redirect participants will not be approved and unable to participate.) |
image | |
has_registration | |
start_date | |
end_date | |
creator required | |
modified_by required | |
last_phase_migration | |
is_migrating | |
force_submission_to_leaderboard | |
disallow_leaderboard_modifying | |
enable_medical_image_viewer | |
enable_detailed_results | |
reward | |
is_migrating_delayed | |
allow_teams | |
enable_per_submission_metadata | (Team name, Method name, Method description, etc.) |
allow_public_submissions | |
enable_forum | |
anonymous_leaderboard | |
enable_teams | |
require_team_approval | |
hide_top_three | |
hide_chart | |
allow_organizer_teams | |
deleted |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this competition. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator | |
search | A search term. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
title | |
description | |
url_redirect | (NOTE: You should not have Registration Required above checked if using URL redirection, because upon redirect participants will not be approved and unable to participate.) |
image | |
has_registration | |
start_date | |
end_date | |
creator | |
modified_by | |
last_phase_migration | |
is_migrating | |
force_submission_to_leaderboard | |
disallow_leaderboard_modifying | |
enable_medical_image_viewer | |
enable_detailed_results | |
reward | |
is_migrating_delayed | |
allow_teams | |
enable_per_submission_metadata | (Team name, Method name, Method description, etc.) |
allow_public_submissions | |
enable_forum | |
anonymous_leaderboard | |
enable_teams | |
require_team_approval | |
hide_top_three | |
hide_chart | |
allow_organizer_teams | |
deleted |
delete
Cleanup the destruction of a competition. This requires removing phases, submissions, and participants. We should try to design the models to make the cleanup simpler if we can.
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this competition. |
Query Parameters
The following parameters should be included as part of a URL query string.
Parameter | Description |
---|---|
creator | |
search | A search term. |
enable_chagrade > create
Provides a way to add a dummy chagrade bot user to competitions to make submissions from chagrade
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required |
leaderboards > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required |
leaderboards > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
phase required |
leaderboards > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this phase leader board. |
leaderboards > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this phase leader board. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
phase required |
leaderboards > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this phase leader board. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
phase |
leaderboards > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this phase leader board. |
pages > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required |
pages > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | |
title | |
label required | |
markup | |
html |
pages > list_0
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
category required |
pages > create_0
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
category required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | |
title | |
label required | |
markup | |
html |
pages > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this page. |
pages > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this page. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | |
title | |
label required | |
markup | |
html |
pages > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this page. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename | |
title | |
label | |
markup | |
html |
pages > list_1
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this page. |
entity_label required |
pages > create_1
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this page. |
entity_label required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
codename required | |
title | |
label required | |
markup | |
html |
participants > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required |
participants > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
reason | |
deleted | |
user required | |
competition required | |
status required |
participants > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this competition participant. |
participants > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this competition participant. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
reason | |
deleted | |
user required | |
competition required | |
status required |
participants > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this competition participant. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
reason | |
deleted | |
user | |
competition | |
status |
participants > delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
id required | A unique integer value identifying this competition participant. |
phases > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this competition. |
phases > create
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this competition. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
end_date required | |
phases required |
phases > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this competition. |
phasenumber required |
phases > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this competition. |
phasenumber required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
end_date required | |
phases required |
phases > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this competition. |
phasenumber required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
end_date | |
phases |
phases > leaderboard > read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
phase_id required |
phases > leaderboard > update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
phase_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
phase required |
phases > leaderboard > partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
phase_id required |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
phase |
phases > leaderboard > data > list
Provides a web API to get the leaderboard data for a phase of a competition
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required | |
phase_id required |
submissions > list
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
competition_id required |
defaultcontent
create
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
category_codename required | |
category_name required | |
initial_visibility required | |
label required | |
codename required | |
rank | |
required | |
category required |
read
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this default content item. |
update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this default content item. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
category_codename required | |
category_name required | |
initial_visibility required | |
label required | |
codename required | |
rank | |
required | |
category required |
partial_update
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this default content item. |
Request Body
The request body should be a "application/json"
encoded object, containing the following items.
Parameter | Description |
---|---|
category_codename | |
category_name | |
initial_visibility | |
label | |
codename | |
rank | |
required | |
category |
delete
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
id required | A unique integer value identifying this default content item. |
submission
get_score > list
Provides a way to grab scores given a specific PK and the owner is the one making the request
Path Parameters
The following parameters should be included in the URL path.
Parameter | Description |
---|---|
submission_id required |