1. List backgrounds

1.1. Path Parameters

Table 1. /projects/{projectId}/backgrounds/
Parameter Description

projectId

project identifier

1.2. Response Fields

Path Type Description

[].id

Number

identifier

[].name

String

name

[].description

[String, Null]

description

[].project.projectId

String

project id where this background belongs to

[].creator.login

String

who created background

[].status

String

is the background ready. Available statuses are: FAILURE, GENERATING, NA, OK, UNKNOWN

[].progress

Number

generating images progress information (in %)

[].order

Number

order used when listing all backgrounds

[].images[].path

String

directory where background tiles are located

[].images[].model.id

Number

(sub)map for which images are described

[].defaultOverlay

Boolean

should the background be used as default (at most one per project should be marked with true)

1.3. CURL sample

$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/backgrounds/' -i -X GET

1.4. Sample Response

[ {
  "id" : 272,
  "name" : "Normal",
  "defaultOverlay" : true,
  "project" : {
    "projectId" : "test_project"
  },
  "creator" : {
    "login" : "admin"
  },
  "status" : "OK",
  "progress" : 100.0,
  "description" : null,
  "order" : 0,
  "images" : [ {
    "id" : 522,
    "model" : {
      "id" : 491
    },
    "projectBackground" : {
      "id" : 272
    },
    "path" : "dir_0"
  }, {
    "id" : 521,
    "model" : {
      "id" : 492
    },
    "projectBackground" : {
      "id" : 272
    },
    "path" : "dir_1"
  } ]
} ]

2. Get background by id

2.1. Path Parameters

Table 2. /projects/{projectId}/backgrounds/{backgroundId}
Parameter Description

projectId

project identifier

backgroundId

background identifier

2.2. Response Fields

Path Type Description

id

Number

identifier

name

String

name

description

[String, Null]

description

project.projectId

String

project id where this background belongs to

creator.login

String

who created background

status

String

is the background ready. Available statuses are: FAILURE, GENERATING, NA, OK, UNKNOWN

progress

Number

generating images progress information (in %)

order

Number

order used when listing all backgrounds

images[].path

String

directory where background tiles are located

images[].model.id

Number

(sub)map for which images are described

defaultOverlay

Boolean

should the background be used as default (at most one per project should be marked with true)

2.3. CURL sample

$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/backgrounds/265' -i -X GET

2.4. Sample Response

{
  "id" : 265,
  "name" : "Normal",
  "defaultOverlay" : true,
  "project" : {
    "projectId" : "test_project"
  },
  "creator" : {
    "login" : "admin"
  },
  "status" : "OK",
  "progress" : 100.0,
  "description" : null,
  "order" : 0,
  "images" : [ {
    "id" : 499,
    "model" : {
      "id" : 479
    },
    "projectBackground" : {
      "id" : 265
    },
    "path" : "dir_1"
  }, {
    "id" : 498,
    "model" : {
      "id" : 478
    },
    "projectBackground" : {
      "id" : 265
    },
    "path" : "dir_0"
  } ]
}

3. Update Background

3.1. Path Parameters

Table 3. /projects/{projectId}/backgrounds/{backgroundId}
Parameter Description

projectId

project identifier

backgroundId

background identifier

3.2. Request Fields

Unresolved directive in project_backgrounds.adoc - include::../../../target/generated-snippets/projects/project_backgrounds/update_background/request-fields.adoc[]

3.3. Response Fields

Path Type Description

id

Number

identifier

name

String

name

description

[String, Null]

description

project.projectId

String

project id where this background belongs to

creator.login

String

who created background

status

String

is the background ready. Available statuses are: FAILURE, GENERATING, NA, OK, UNKNOWN

progress

Number

generating images progress information (in %)

order

Number

order used when listing all backgrounds

images[].path

String

directory where background tiles are located

images[].model.id

Number

(sub)map for which images are described

defaultOverlay

Boolean

should the background be used as default (at most one per project should be marked with true)

3.4. CURL sample

$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/backgrounds/261' -i -X PATCH \
    -d '{"id":261,"name":"weird_title","defaultOverlay":false,"creator":null,"description":null,"order":0}' \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx"

3.5. Sample Response

{
  "id" : 261,
  "name" : "weird_title",
  "defaultOverlay" : false,
  "project" : {
    "projectId" : "test_project"
  },
  "creator" : {
    "login" : "admin"
  },
  "status" : "OK",
  "progress" : 100.0,
  "description" : null,
  "order" : 0,
  "images" : [ {
    "id" : 494,
    "model" : {
      "id" : 475
    },
    "projectBackground" : {
      "id" : 261
    },
    "path" : "dir_1"
  }, {
    "id" : 493,
    "model" : {
      "id" : 476
    },
    "projectBackground" : {
      "id" : 261
    },
    "path" : "dir_0"
  } ]
}

4. Delete overlay

4.1. CURL sample

$ curl 'https://minerva-service.lcsb.uni.lu/minerva/api/projects/test_project/backgrounds/284' -i -X DELETE

4.2. Path Parameters

Table 4. /projects/{projectId}/backgrounds/{backgroundId}
Parameter Description

projectId

project identifier

backgroundId

background identifier