Welcome to Validation Framework REST API documentation

General Info

• Collabs on the HBP Collaboratory can be either public or private. Public Collabs can be accessed by all registered users, whereas private Collabs require the user to be granted permission for access.

• The Model Catalog and the Validation Framework apps can be added to any Collab. A Collab may have multiple instances of these apps. The apps require to be configured by setting the provided filters appropriately before they can be used. These filters restrict the type of data displayed in that particular instance of the app.

• All tests are public, i.e. every test registered on the Validation Framework can be seen by all users.

• Models are created inside specific Collab instances of the Model Catalog app. The particular app inside which a model was created is termed its host app. Similarly, the Collab containing the host app is termed the host Collab.

• Models can be set as public/private. If public, the model and its associated results are available to all users. If private, it can only be seen by users who have access to the host Collab. See table below for summary of access privileges.

• No information can be deleted from the Model Catalog and Validation Framework apps. In future, an option to hide data would be implemented. This would offer users functionality similar to deleting, but with the data being retained in the database back-end.

• Models, model instances, tests and test instances can be edited as long as there are no results associated with them. Results can never be edited!

  		Collab (Private/Public)
  		Collab Member			Not Collab Member
  		View (GET)	Create (POST)	Edit (PUT)	View (GET)	Create (POST)	Edit (PUT)
  Model	Private	Yes	Yes	Yes	No	No	No
  	Public	Yes	Yes	Yes	Yes	No	No

REST APIs

The HBP validation framework offers the below described APIs. These can be accessed through the following base URL: https://validation-v1.brainsimulation.eu

• Models
  • Get model description using UUID
  • Get model description using alias
  • List model descriptions that satisfy specified filters
  • Register a new model description
  • Edit an existing model description
• Model Instances
  • Get model instance description using instance UUID
  • Get model instance description using model UUID and version
  • Get model instance description using model alias and version
  • List all instances of a model specified using model UUID
  • List all instances of a model specified using model alias
  • Register a new model instance description using: model_uuid
  • Register a new model instance description using: model_alias
  • Edit an existing model instance description using: model_instance_uuid
  • Edit an existing model instance description using: model_uuid, version
  • Edit an existing model instance description using: model_alias, version
• Model Images
  • Get a specific model image info using image UUID
  • List all image info associated with a model using model UUID
  • List all image info associated with a model using model alias
  • Register new model image info using model UUID
  • Register new model image info using model alias
  • Edit existing model image info
• Tests
  • Get test definition using UUID
  • Get test definition using alias
  • List test definitions that satisfy specified filters
  • Register a new test definition
  • Edit an existing test definition
• Test Instances
  • Get test instance definition using instance UUID
  • Get test instance definition using test UUID and version
  • Get test instance definition using test alias and version
  • List all instances of a test specified using test UUID
  • List all instances of a test specified using test alias
  • Register a new test instance definition using: test_uuid
  • Register a new test instance definition using: test_alias
  • Edit an existing test instance definition using: test_instance_uuid
  • Edit an existing test instance definition using: test_uuid, version
  • Edit an existing test instance definition using: test_alias, version
• Results
  • Get a specific test result: provide summary
  • Get a specific test result: provide details by test
  • Get a specific test result: provide details by model
  • List all results satisfying specified filters: provide summary
  • List all results satisfying specified filters: provide details by test
  • List all results satisfying specified filters: provide details by model
  • Register a new test result
• Miscellaneous
  • Get configuration of model catalog app
  • Initial configuration of model catalog app
  • Reconfiguration of model catalog app
  • Get configuration of validation framework app
  • Initial configuration of validation framework app
  • Reconfiguration of validation framework app
  • Get valid attribute values