Rest New API Documentation

1. Get author

Returns info about a single author entry of a map. The id identifies the author entry on this specific map, not a global, cross-map author identifier.

1.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/132/authors/53 HTTP/1.1

1.2. Path Parameters

Table 1. /minerva/new_api/projects/{projectId}/maps/{mapId}/authors/{authorId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`authorId`	author entry identifier (specific to this map, not a global author identifier)

1.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/132/authors/53' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

1.4. HTTP response

HTTP/1.1 200 OK

1.5. Response Fields

Path Type Description

Path	Type	Description
`id`	`Number`	identifier of this author entry (not a globally unique author identifier; the same person listed on multiple maps gets a separate entry per map)
`firstName`	`String`	given name of the author
`lastName`	`String`	family name of the author
`email`	`String`	email address
`organisation`	`String`	institution the author is affiliated with

id

Number

identifier of this author entry (not a globally unique author identifier; the same person listed on multiple maps gets a separate entry per map)

firstName

String

given name of the author

lastName

String

family name of the author

email

String

email address

organisation

String

institution the author is affiliated with

1.6. Sample Response

{
  "id" : 53,
  "firstName" : "John",
  "lastName" : "Doe",
  "email" : null,
  "organisation" : null
}

2. List authors

Returns a page of authors of a map.

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

2.1. HTTP request

GET /minerva/new_api/projects/test_project/maps/134/authors/ HTTP/1.1

2.2. Path Parameters

Table 2. /minerva/new_api/projects/{projectId}/maps/{mapId}/authors/
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier

2.3. Query Parameters

Parameter Description

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

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

2.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/134/authors/' -X GET \
    -H 'Authorization: Bearer xxxxxxxx'

2.5. HTTP response

HTTP/1.1 200 OK

2.6. Response Fields

Path Type Description

Path	Type	Description
`content`	`Array`	list of authors on the page
`content[].id`	`Number`	identifier of this author entry (not a globally unique author identifier; the same person listed on multiple maps gets a separate entry per map)
`content[].firstName`	`String`	given name of the author
`content[].lastName`	`String`	family name of the author
`content[].email`	`String`	email address
`content[].organisation`	`String`	institution the author is affiliated with
`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

content

Array

list of authors on the page

content[].id

Number

identifier of this author entry (not a globally unique author identifier; the same person listed on multiple maps gets a separate entry per map)

content[].firstName

String

given name of the author

content[].lastName

String

family name of the author

content[].email

String

email address

content[].organisation

String

institution the author is affiliated with

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

2.7. Sample Response

{
  "content" : [ {
    "id" : 54,
    "firstName" : "John",
    "lastName" : "Doe",
    "email" : null,
    "organisation" : null
  } ],
  "totalPages" : 1,
  "totalElements" : 1,
  "numberOfElements" : 1,
  "size" : 20,
  "number" : 0
}

3. Add author

Adds a new author to the map.

3.1. HTTP request

POST /minerva/new_api/projects/test_project/maps/130/authors/ HTTP/1.1

3.2. Path Parameters

Table 3. /minerva/new_api/projects/{projectId}/maps/{mapId}/authors/
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier

3.3. Request Fields

Path Type Description

Path	Type	Description
`firstName`	`String`	given name of the author
`lastName`	`String`	family name of the author
`email`	`String`	email address
`organisation`	`String`	institution the author is affiliated with

firstName

String

given name of the author

lastName

String

family name of the author

email

String

email address

organisation

String

institution the author is affiliated with

3.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/130/authors/' -X POST \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"firstName":"John","lastName":"Doe","email":"john.doe@uni.lu","organisation":"University of Luxembourg"}' \
    -H 'Content-Type: application/json'

3.5. HTTP response

HTTP/1.1 201 Created

3.6. Response Fields

Path Type Description

Path	Type	Description
`id`	`Number`	identifier of this author entry (not a globally unique author identifier; the same person listed on multiple maps gets a separate entry per map)
`firstName`	`String`	given name of the author
`lastName`	`String`	family name of the author
`email`	`String`	email address
`organisation`	`String`	institution the author is affiliated with

id

Number

identifier of this author entry (not a globally unique author identifier; the same person listed on multiple maps gets a separate entry per map)

firstName

String

given name of the author

lastName

String

family name of the author

email

String

email address

organisation

String

institution the author is affiliated with

3.7. Sample Response

{
  "id" : 52,
  "firstName" : "John",
  "lastName" : "Doe",
  "email" : "john.doe@uni.lu",
  "organisation" : "University of Luxembourg"
}

4. Update author

Updates an existing map author.

Note	Supports optimistic locking via the `If-Match` header.

4.1. HTTP request

PUT /minerva/new_api/projects/test_project/maps/136/authors/55 HTTP/1.1

4.2. Path Parameters

Table 4. /minerva/new_api/projects/{projectId}/maps/{mapId}/authors/{authorId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`authorId`	author entry identifier (specific to this map, not a global author identifier)

4.3. Request Fields

Path Type Description

Path	Type	Description
`firstName`	`String`	given name of the author
`lastName`	`String`	family name of the author
`email`	`String`	email address
`organisation`	`String`	institution the author is affiliated with

firstName

String

given name of the author

lastName

String

family name of the author

email

String

email address

organisation

String

institution the author is affiliated with

4.4. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/136/authors/55' -X PUT \
    -H 'Authorization: Bearer xxxxxxxx' \
    -d '{"firstName":"John","lastName":"Doe","email":"john.doe@uni.lu","organisation":"University of Luxembourg"}' \
    -H 'Content-Type: application/json'

4.5. HTTP response

HTTP/1.1 200 OK

4.6. Response Fields

Path Type Description

Path	Type	Description
`id`	`Number`	identifier of this author entry (not a globally unique author identifier; the same person listed on multiple maps gets a separate entry per map)
`firstName`	`String`	given name of the author
`lastName`	`String`	family name of the author
`email`	`String`	email address
`organisation`	`String`	institution the author is affiliated with

id

Number

identifier of this author entry (not a globally unique author identifier; the same person listed on multiple maps gets a separate entry per map)

firstName

String

given name of the author

lastName

String

family name of the author

email

String

email address

organisation

String

institution the author is affiliated with

4.7. Sample Response

{
  "id" : 55,
  "firstName" : "John",
  "lastName" : "Doe",
  "email" : "john.doe@uni.lu",
  "organisation" : "University of Luxembourg"
}

5. Delete author

Deletes an author from the map.

Note	Supports optimistic locking via the `If-Match` header.

5.1. HTTP request

DELETE /minerva/new_api/projects/test_project/maps/138/authors/56 HTTP/1.1

5.2. Path Parameters

Table 5. /minerva/new_api/projects/{projectId}/maps/{mapId}/authors/{authorId}
Parameter	Description
`projectId`	project identifier
`mapId`	map identifier
`authorId`	author entry identifier (specific to this map, not a global author identifier)

5.3. CURL sample

$ curl 'https://minerva-dev.lcsb.uni.lu/minerva/new_api/projects/test_project/maps/138/authors/56' -X DELETE \
    -H 'Authorization: Bearer xxxxxxxx'

5.4. HTTP response

HTTP/1.1 200 OK

Rest New API Documentation - Map authors

1. Get author

1.1. HTTP request

1.2. Path Parameters

1.3. CURL sample

1.4. HTTP response

1.5. Response Fields

1.6. Sample Response

2. List authors

2.1. HTTP request

2.2. Path Parameters

2.3. Query Parameters

2.4. CURL sample

2.5. HTTP response

2.6. Response Fields

2.7. Sample Response

3. Add author

3.1. HTTP request

3.2. Path Parameters

3.3. Request Fields

3.4. CURL sample

3.5. HTTP response

3.6. Response Fields

3.7. Sample Response

4. Update author

4.1. HTTP request

4.2. Path Parameters

4.3. Request Fields

4.4. CURL sample

4.5. HTTP response

4.6. Response Fields

4.7. Sample Response

5. Delete author

5.1. HTTP request

5.2. Path Parameters

5.3. CURL sample

5.4. HTTP response