Overview images give a graphical overview of the processes described in the project and contain clickable areas linking to its maps. They are optional - a project can have none. The endpoints are served from /new_api/projects/{projectId}/overview_images.

1. List overview images

Returns the overview images defined for the project. Every image carries its size in pixels and the list of links - polygons drawn over the image that navigate to a map (OverviewModelLink, optionally with a zoom level and coordinates), to another overview image (OverviewImageLink) or to a search query (OverviewSearchLink). The image that should be opened first is available as topOverviewImage of the project.

Requires IS_ADMIN or READ_PROJECT authority for the given project.

Note
 The result is paged - use the page and size query parameters to walk through it.

1.1. HTTP request

GET /minerva/new_api/projects/test_project/overview_images/?page=0&size=5 HTTP/1.1

1.2. Path Parameters

Table 1. /minerva/new_api/projects/{projectId}/overview_images/
Parameter Description

projectId

project identifier

1.3. Query Parameters

Parameter Description

page

index of the page to fetch, counted from 0; 0 by default

size

number of entries on a page; 20 by default, 10000 at most

1.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/overview_images/?page=0&size=5' -X GET \
    --cookie "MINERVA_AUTH_TOKEN=xxxxxxxx"

1.5. HTTP response

HTTP/1.1 200 OK

1.6. Response Fields

Path Type Description

content

Array

list of overview images on the page

content[].id

Number

unique overview image identifier

content[].filename

String

name of the file with the image

content[].width

Number

width of the image in pixels

content[].height

Number

height of the image in pixels

content[].links

Array

clickable areas defined on the image; a link points to a map (OverviewModelLink), to another overview image (OverviewImageLink) or to a search query (OverviewSearchLink)

totalPages

Number

total number of pages

totalElements

Number

total number of elements

numberOfElements

Number

number of elements on this page

size

Number

page size

number

Number

page number

1.7. Sample Response

{
  "content" : [ {
    "id" : 44,
    "filename" : "image.png",
    "width" : 200,
    "height" : 100,
    "links" : [ {
      "id" : 130,
      "linkedModel" : 110,
      "zoomLevel" : 2,
      "xCoord" : 10,
      "yCoord" : 20,
      "type" : "OverviewModelLink",
      "polygon" : [ {
        "x" : 0.0,
        "y" : 0.0
      }, {
        "x" : 10.0,
        "y" : 10.0
      }, {
        "x" : 10.0,
        "y" : 0.0
      } ]
    }, {
      "id" : 131,
      "linkedOverviewImage" : 44,
      "type" : "OverviewImageLink",
      "polygon" : [ {
        "x" : 0.0,
        "y" : 0.0
      }, {
        "x" : 10.0,
        "y" : 10.0
      }, {
        "x" : 10.0,
        "y" : 0.0
      } ]
    }, {
      "id" : 132,
      "query" : "a1",
      "type" : "OverviewSearchLink",
      "polygon" : [ {
        "x" : 0.0,
        "y" : 0.0
      }, {
        "x" : 10.0,
        "y" : 10.0
      }, {
        "x" : 10.0,
        "y" : 0.0
      } ]
    } ]
  } ],
  "totalPages" : 1,
  "totalElements" : 1,
  "numberOfElements" : 1,
  "size" : 5,
  "number" : 0
}