Model Images

Get a specific model image info using image UUID

GET https://validation-v1.brainsimulation.eu/images/?id=(string: image_uuid)

Retrieve specific model image info from the model catalog using image UUID

Example request:

GET /images/?id=fab6a1e6-ca25-4b7e-9570-a15047764b1f 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

{
  "images": [
          {
                  "id": "fab6a1e6-ca25-4b7e-9570-a15047764b1f",
                  "url": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC/970717D_morph.jpeg",
                  "caption": "Morphology",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          }
  ]
}
Parameters:
  • image_uuid – UUID of the model image info to be retrieved
Request Headers:
 
Status Codes:

List all image info associated with a model using model UUID

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

Retrieve all image info for a model from the model catalog using model’s UUID

Example request:

GET /images/?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

{
  "images": [
          {
                  "id": "8cc6d197-8048-4465-9cd4-421f4f9ed0bc",
                  "url": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC/970717D_morph_filtered.jpeg",
                  "caption": "Morphology",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          },
          {
                  "id": "278c7b0e-c6d2-415d-b13b-dcc335f9a85d",
                  "url": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC/970717D_morph_filtered.jpeg",
                  "caption": "Morphology",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          }
  ]
}
Parameters:
  • model_uuid – UUID of the model whose instance is to be retrieved
  • version – version of the model to be retrieved
Request Headers:
 
Status Codes:

List all image info associated with a model using model alias

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

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

Example request:

GET /images/?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

{
  "images": [
          {
                  "id": "8cc6d197-8048-4465-9cd4-421f4f9ed0bc",
                  "url": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC/970717D_morph_filtered.jpeg",
                  "caption": "Morphology",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          },
          {
                  "id": "278c7b0e-c6d2-415d-b13b-dcc335f9a85d",
                  "url": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC/970717D_morph_filtered.jpeg",
                  "caption": "Morphology",
                  "model_id": "743f0df9-6811-466b-856e-d26db25dd272"
          }
  ]
}
Parameters:
  • model_alias – alias of the model whose instance is to be retrieved
  • version – version of the model to be retrieved
Request Headers:
 
Status Codes:

Register new model image info using model UUID

POST https://validation-v1.brainsimulation.eu/images/

Register new model image info in the model catalog using model_uuid

Example request:

POST /images/ 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",
          "url": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC/970717D_morph_filtered.jpeg",
          "caption": "Morphology"
  }
]

Example response:

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

{
  "uuid": [
          "c33a0c1e-a441-49eb-8db5-89fb1da93a85"
  ]
}
Request Headers:
 
Status Codes:

Register new model image info using model alias

POST https://validation-v1.brainsimulation.eu/images/

Register new model image info in the model catalog using model_alias

Note

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

Example request:

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

[
  {
          "model_alias": "CA1_int_cNAC_BluePyOpt",
          "url": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC/970717D_morph_filtered.jpeg",
          "caption": "Morphology"
  }
]

Example response:

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

{
  "uuid": [
          "a1b0c9ff-271a-4602-b91c-ff04244549cb"
  ]
}
Request Headers:
 
Status Codes:

Edit existing model image info

PUT https://validation-v1.brainsimulation.eu/images/

Edit an existing model image info in the model catalog by specifying the image UUID

Example request:

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

[
  {
          "id": "8cc6d197-8048-4465-9cd4-421f4f9ed0bc",
          "url": "https://github.com/lbologna/bsp_data_repository/optimizations/CA1_int_cNAC/970717D_morph_filtered.jpeg",
          "caption": "Morphology - refined"
  }
]

Example response:

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

{
  "uuid": [
          "8cc6d197-8048-4465-9cd4-421f4f9ed0bc"
  ]
}
Request Headers:
 
Status Codes: