Model Instances¶

Get model instance description using instance UUID¶

GET https://validation-v1.brainsimulation.eu/model-instances/?id=(string: model_instance_uuid)¶

Retrieve model instance specific information from the model catalog using model instance UUID

Example request:

GET /model-instances/?id=9217f786-a124-4327-b260-17e85624b9ba HTTP/1.1
Accept: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
Host: validation-v1.brainsimulation.eu

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "instances": [
          {
                  "id": "9217f786-a124-4327-b260-17e85624b9ba",
                  "version": "1.0",
                  "description": "",
                  "parameters": "",
                  "code_format": "py, hoc, mod",
                  "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC.zip",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          }
  ]
}

Request Headers:
Parameters:	model_instance_uuid – UUID of the model instance to be retrieved
	Authorization – Bearer TOKEN
Status Codes:	200 OK – model instance description successfully retrieved 400 Bad Request – incorrect API call 403 Forbidden – invalid token provided

Get model instance description using model UUID and version¶

GET https://validation-v1.brainsimulation.eu/model-instances/?model_id=(string: model_uuid)&version=(string: version)¶

Retrieve model instance specific information from the model catalog using model’s UUID and version

Example request:

GET /model-instances/?model_id=743f0df9-6811-466b-856e-d26db25dd272&version=1.0 HTTP/1.1
Accept: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
Host: validation-v1.brainsimulation.eu

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "instances": [
          {
                  "id": "9217f786-a124-4327-b260-17e85624b9ba",
                  "version": "1.0",
                  "description": "",
                  "parameters": "",
                  "code_format": "py, hoc, mod",
                  "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC.zip",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          }
  ]
}

Request Headers:
Parameters:	model_uuid – UUID of the model whose instance is to be retrieved version – version of the model to be retrieved
	Authorization – Bearer TOKEN
Status Codes:	200 OK – model instance description successfully retrieved 400 Bad Request – incorrect API call 403 Forbidden – invalid token provided

Get model instance description using model alias and version¶

GET https://validation-v1.brainsimulation.eu/model-instances/?model_alias=(string: model_alias)&version=(string: version)¶

Retrieve model instance specific information from the model catalog using model’s UUID

Example request:

GET /model-instances/?model_alias=CA1_int_cNAC_BluePyOpt&version=1.0 HTTP/1.1
Accept: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
Host: validation-v1.brainsimulation.eu

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "instances": [
          {
                  "id": "9217f786-a124-4327-b260-17e85624b9ba",
                  "version": "1.0",
                  "description": "",
                  "parameters": "",
                  "code_format": "py, hoc, mod",
                  "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC.zip",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          }
  ]
}

Request Headers:
Parameters:	model_alias – alias of the model whose instance is to be retrieved version – version of the model to be retrieved
	Authorization – Bearer TOKEN
Status Codes:	200 OK – model instance description successfully retrieved 400 Bad Request – incorrect API call 403 Forbidden – invalid token provided

List all instances of a model specified using model UUID¶

GET https://validation-v1.brainsimulation.eu/model-instances/?model_id=(string: model_uuid)¶

Retrieve model descriptions satisfying specified filters

Example request:

GET /model-instances/?model_id=743f0df9-6811-466b-856e-d26db25dd272 HTTP/1.1
Accept: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
Host: validation-v1.brainsimulation.eu

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "instances": [
          {
                  "id": "9f4eeec3-30ac-47bc-aaf5-871558052047",
                  "version": "2.0",
                  "description": "version 2: more detailed",
                  "parameters": "",
                  "code_format": "py, hoc",
                  "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC_v2.zip",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          },
          {
                  "id": "9217f786-a124-4327-b260-17e85624b9ba",
                  "version": "1.0",
                  "description": "",
                  "parameters": "",
                  "code_format": "py, hoc, mod",
                  "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC.zip",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          }
  ]
}

Request Headers:
Parameters:	model_uuid – UUID of the model whose instances are to be retrieved
	Authorization – Bearer TOKEN
Status Codes:	200 OK – model descriptions successfully retrieved 400 Bad Request – incorrect API call 403 Forbidden – invalid token provided

List all instances of a model specified using model alias¶

GET https://validation-v1.brainsimulation.eu/model-instances/?model_alias=(string: model_alias)¶

Retrieve model descriptions satisfying specified filters

Example request:

GET /model-instances/?model_alias=CA1_int_cNAC_BluePyOpt HTTP/1.1
Accept: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
Host: validation-v1.brainsimulation.eu

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "instances": [
          {
                  "id": "9f4eeec3-30ac-47bc-aaf5-871558052047",
                  "version": "2.0",
                  "description": "version 2: more detailed",
                  "parameters": "",
                  "code_format": "py, hoc",
                  "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC_v2.zip",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          },
          {
                  "id": "9217f786-a124-4327-b260-17e85624b9ba",
                  "version": "1.0",
                  "description": "",
                  "parameters": "",
                  "code_format": "py, hoc, mod",
                  "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC.zip",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          }
  ]
}

Request Headers:
Parameters:	model_alias – alias of the model whose instances are to be retrieved
	Authorization – Bearer TOKEN
Status Codes:	200 OK – model descriptions successfully retrieved 400 Bad Request – incorrect API call 403 Forbidden – invalid token provided

Register a new model instance description using: model_uuid¶

POST https://validation-v1.brainsimulation.eu/model-instances/¶

Register a new model instance description in the model catalog using model_uuid

Example request:

POST /model-instances/ HTTP/1.1
Accept: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
Host: validation-v1.brainsimulation.eu

[
  {
          "model_id": "743f0df9-6811-466b-856e-d26db25dd272",
          "version": "2.0",
          "description": "version 2",
          "parameters": "",
          "code_format": "py, hoc, mod",
          "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC_v2.zip"
  }
]

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "uuid": [
          "9f4eeec3-30ac-47bc-aaf5-871558052047"
  ]
}

Request Headers:
	Authorization – Bearer TOKEN
Status Codes:	201 Created – model instance description successfully created 400 Bad Request – incorrect API call 403 Forbidden – invalid token provided

Register a new model instance description using: model_alias¶

POST https://validation-v1.brainsimulation.eu/model-instances/¶

Register a new model instance description in the model catalog using model_alias

Note

This isn’t currently available. See: https://github.com/HumanBrainProject/hbp-validation-framework/issues/163

Example request:

POST /model-instances/ HTTP/1.1
Accept: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
Host: validation-v1.brainsimulation.eu

[
  {
          "model_alias": "CA1_int_cNAC_BluePyOpt",
          "version": "2.0",
          "description": "version 2",
          "parameters": "",
          "code_format": "py, hoc, mod",
          "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC_v2.zip"
  }
]

Example response:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "uuid": [
          "9f4eeec3-30ac-47bc-aaf5-871558052047"
  ]
}

Request Headers:
	Authorization – Bearer TOKEN
Status Codes:	201 Created – model instance description successfully created 400 Bad Request – incorrect API call 403 Forbidden – invalid token provided

Edit an existing model instance description using: model_instance_uuid¶

PUT https://validation-v1.brainsimulation.eu/model-instances/¶

Edit an existing model instance description in the model catalog by specifying the model instance UUID

Note

Only this variant of the model instance edit API allows the change of version name.

Example request:

PUT /model-instances/ HTTP/1.1
Accept: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
Host: validation-v1.brainsimulation.eu

[
  {
          "id": "9f4eeec3-30ac-47bc-aaf5-871558052047",
          "version": "2.0 - 2018",
          "description": "version 2: more detailed",
          "parameters": "",
          "code_format": "py, hoc",
          "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC_v2.zip"
  }
]

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "uuid": [
          "9f4eeec3-30ac-47bc-aaf5-871558052047"
  ]
}

Request Headers:
	Authorization – Bearer TOKEN
Status Codes:	202 Accepted – model instance description successfully updated 400 Bad Request – incorrect API call 403 Forbidden – invalid token provided

Edit an existing model instance description using: model_uuid, version¶

PUT https://validation-v1.brainsimulation.eu/model-instances/¶

Edit an existing model instance description in the model catalog by specifying the model UUID and version

Example request:

PUT /model-instances/ HTTP/1.1
Accept: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
Host: validation-v1.brainsimulation.eu

[
  {
          "model_id": "743f0df9-6811-466b-856e-d26db25dd272",
          "version": "2.0",
          "description": "version 2: more detailed",
          "parameters": "",
          "code_format": "py, hoc",
          "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC_v2.zip"
  }
]

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "uuid": [
          "9f4eeec3-30ac-47bc-aaf5-871558052047"
  ]
}

Request Headers:
	Authorization – Bearer TOKEN
Status Codes:	202 Accepted – model instance description successfully updated 400 Bad Request – incorrect API call 403 Forbidden – invalid token provided

Edit an existing model instance description using: model_alias, version¶

PUT https://validation-v1.brainsimulation.eu/model-instances/¶

Edit an existing model instance description in the model catalog by specifying the model alias and version

Example request:

PUT /model-instances/ HTTP/1.1
Accept: application/json
Authorization: Bearer TOKEN
Content-Type: application/json
Host: validation-v1.brainsimulation.eu

[
  {
          "model_alias":"CA1_int_cNAC_BluePyOpt",
          "version": "2.0",
          "description": "version 2: more detailed",
          "parameters": "",
          "code_format": "py, hoc",
          "source": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC_v2.zip"
  }
]

Example response:

HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "uuid": [
          "9f4eeec3-30ac-47bc-aaf5-871558052047"
  ]
}

Request Headers:
	Authorization – Bearer TOKEN
Status Codes:	202 Accepted – model instance description successfully updated 400 Bad Request – incorrect API call 403 Forbidden – invalid token provided

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¶

Table of Contents

Previous topic

Next topic

This Page