API

All functionalities of the platform can be access through a restful api by using curl or httpie.
A credential token was required to use api.
You can get the token on the website in account settings tab (/account/settings/).
With curl, it is necessary to add -H 'Authorization: Token '

Description URL Method URL Params Data type Data Params
list user projects api/v1/project/list GET None None None
create a new project api/v1/project/add POST None json Required
name: [string]
description: [string]
type: "CO"
deprecate list available model on project api/v1/project/:project_id/model/list GET project_id: [integer] None None
deprecate send a new model on project api/v1/project/:project_id/model/add POST project_id: [integer] json Required
name: [string]
code: [string]
list available simulators on project api/v1/project/:project_id/simulator/list GET project_id: [integer] None None
send a new simulator on project api/v1/project/:project_id/simulator/add POST project_id: [integer] json Required
docker_name: [string]
docker_address: [string]
docker_version: [string]
Optional
registry_url: [string]
registry_username: [string]
registry_token: [string]
list available parameters set on project api/v1/project/:project_id/parameters/list GET project_id: [integer] None None
send a new parameters set on project api/v1/project/:project_id/parameters/add POST project_id: [integer] json Required
name: [string]
parameters_list: [string]
list available states set on project api/v1/project/:project_id/state/list GET project_id: [integer] None None
send a new states set on project api/v1/project/:project_id/state/add POST project_id: [integer] json Required
name: [string]
states_list: [string]
list available experimental datas on project api/v1/project/:project_id/experimental_datastate/list GET project_id: [integer] None None
send a new experimental data on project api/v1/project/:project_id/experimental_data/add POST project_id: [integer] json Required
name: [string]
experimental_data_list: [string]
list available computation ressources of project api/v1/project/:project_id/ressource/list GET project_id: [integer] None None
send a ressource on project api/v1/project/:project_id/ressource/add POST project_id: [integer] json Required
name: [string]
walltime: [datetime]
memory: [integer]
nbr_cores: [integer]
list computation present on project api/v2/project/:project_id/computation/list GET project_id: [integer] None None
send a computation on project api/v2/project/:project_id/computation/add POST project_id: [integer] json Required
program: [string]
configuration: [json]
ressource: [integer]
get computation status of project api/v1/project/:project_id/computation/:computation_id/status GET project_id: [integer]
computation_id: [integer]
None None
get computation results of project api/v1/project/:project_id/computation/:computation_id/results GET project_id: [integer]
computation_id: [integer]
None None