Symbols the element was known under in the past. The endpoints are served from /new_api/projects/{projectId}/maps/{mapId}/bio_entities/elements/{id}/former_symbols.

1. List former symbols

Returns a page of former symbols of the element.

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/maps/230/bio_entities/elements/620/former_symbols/ HTTP/1.1

1.2. Path Parameters

Table 1. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/elements/{id}/former_symbols/
Parameter Description

projectId

project identifier

mapId

map identifier

id

unique element identifier (the numeric "id" field of the element, not the "elementId" taken from the source file)

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/maps/230/bio_entities/elements/620/former_symbols/' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

1.5. HTTP response

HTTP/1.1 200 OK

1.6. Response Fields

Path Type Description

content

array<string>

list of former symbols of the element

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" : [ "FFH" ],
  "totalPages" : 1,
  "totalElements" : 1,
  "numberOfElements" : 1,
  "size" : 20,
  "number" : 0
}

2. Add former symbol

Adds a former symbol to the element.

2.1. HTTP request

POST /minerva/new_api/projects/test_project/maps/226/bio_entities/elements/609/former_symbols/ HTTP/1.1

2.2. Path Parameters

Table 2. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/elements/{id}/former_symbols/
Parameter Description

projectId

project identifier

mapId

map identifier

id

unique element identifier (the numeric "id" field of the element, not the "elementId" taken from the source file)

2.3. Request Fields

Path Type Description

symbol

String

former symbol to be added

2.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/226/bio_entities/elements/609/former_symbols/' -X POST \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"symbol":"FormerSymbol 11"}' \
    -H 'Content-Type: application/json'

2.5. HTTP response

HTTP/1.1 201 Created

2.6. Sample Response

{
  "symbol" : "FormerSymbol 11"
}

3. Delete former symbol

The former symbol to remove is given verbatim in the path, and the call fails if the element does not carry it.

3.1. HTTP request

POST /minerva/new_api/projects/test_project/maps/228/bio_entities/elements/615/former_symbols:delete HTTP/1.1

3.2. Path Parameters

Table 3. /minerva/new_api/projects/{projectId}/maps/{mapId}/bio_entities/elements/{id}/former_symbols:delete
Parameter Description

projectId

project identifier

mapId

map identifier

id

unique element identifier (the numeric "id" field of the element, not the "elementId" taken from the source file)

3.3. Request Fields

Path Type Description

symbol

String

former symbol to be removed

3.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/228/bio_entities/elements/615/former_symbols:delete' -X POST \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"symbol":"FFH"}' \
    -H 'Content-Type: application/json'

3.5. HTTP response

HTTP/1.1 200 OK