Skip to content

Latest commit

 

History

History
202 lines (156 loc) · 9.59 KB

qualityassuranceevents.md

File metadata and controls

202 lines (156 loc) · 9.59 KB
Raw

Quality Assurance Events endpoint

The Quality Assurance feature aims to improve existing data in the repository using feedback that Quality Assurance sources (as OpenAIRE) made available, such as missing or additional metadata (abstract, subjects, PIDs, projects).

These endpoints provide access to the quality assurance events so that they can be reviewed and managed by the repository manager.

GET All quality assurance events

GET /api/integration/qualityassuranceevents

Unsupported. The quality assurance events can be retrieved only by source and target or via direct link, see the single entry and search method below.

GET Single quality assurance event

GET /api/integration/qualityassuranceevents/<:qualityassuranceevent-id>

Return a single quality assurance event:

{
  "id":"123e4567-e89b-12d3-a456-426614174000",
  "originalId": "oai:www.openstarts.units.it:10077/21486",
  "title":"Index nominum et rerum",
  "trust":"0.375",
  "topic":"ENRICH/MISSING/ABSTRACT",
  "eventDate": "2020/10/09 10:11 UTC",
  "status": "PENDING",
  "message" : {
    "type":"doi",
    "value":"10.18848/1447-9494/cgp/v15i09/45934",
    "abstracts":"Abstract Complex functionality of the ...",
    "acronym":"EPSILON",
    "code":"277749",
    "funder":"EC",
    "fundingProgram":"FP7",
    "jurisdiction":"EU",
    "title":"Elliptic Pdes and Symmetry of Interfaces and Layers for Odd Nonlinearities"
  },
  "type": "qualityassuranceevent"
}

Attributes

  • the id attribute is the event primary key
  • the originalId attribute is the identifier used by the event's source for the target publication
  • the title attribute is the title of the publication as provided by the correction's source
  • the trust attribute is the level of accuracy of the quality assurance event (values from 0.00 to 1.00)
  • the topic attribute is the name of the topic of the event
  • the status attribute is one of (ACCEPTED, REJECTED, DISCARDED, PENDING)
  • the eventDate attribute is the timestamp of the event reception
  • the message attribute is a json object which structure depends on the source and on the topic of the event. When the source is "openaire" and the "topic" type is
    • ENRICH/MISSING/PID and ENRICH/MORE/PID: fills message.type with the type of persistent identifier (doi, pmid, etc.) and message.value with the corresponding value
    • ENRICH/MISSING/ABSTRACT: fills message.abstract
    • ENRICH/MISSING/PROJECT and ENRICH/MORE/PROJECT: fills acronym, code, funder, fundingProgram, jurisdiction and title

Exposed links:

  • topic: link to the topic to which the event belong to (see qualityassurancetopics)
  • target: link to the item that represent the target to whom the quality assurance event apply
  • related: link to an optional second item that is involved in the qa events (i.e. the project item for OpenAIRE ENRICH/MISSING/PROJECT event)

Status codes:

  • 200 Ok - if the operation succeed
  • 401 Unauthorized - if you are not authenticated
  • 403 Forbidden - if you are not logged as an administrator
  • 404 Not found - if no qa event exists with such id

POST

To create a new quality assurance event

POST /api/integration/qualityassuranceevents

Only events for the Quality Assurance Source named DSpace User Corrections can be created. A new quality assurance event can be created by specifying the correctionType, the target item and an optional related item as parameters. The message of the quality assurance event will be provided as body of the json request.

The supported parameters are:

  • correctionType: the id of the correction type used to generate the quality assurance event
  • target: the uuid of the item that will be the target of the quality assurance event
  • related: (optional) the uuid of an additional item involved in the quality assurance event. Included for future extension

A sample CURL command would be:

curl -i -X POST 'https://demo.dspace.org/server/#/server/api/integration/qualityassuranceevents?correctionType=request-withdrawn&target=c71c4b56-ff05-4c7f-a45f-757e2e29ced7' /
-H 'Authorization: Bearer eyJhbGciO…' -H "Content-Type:text/json" /
--data '{reason: "The reason for the request provided by the user"}'

Return codes:

  • 201 Created - if the operation succeed
  • 400 Bad Request - if the target parameter or the correctionType parameters are missing
  • 401 Unauthorized - if you are not authenticated
  • 403 Forbidden - if you are not logged in with sufficient permissions
  • 422 Unprocessable Entity - if The given correctionType in the request is not valid, the given items in the request were not valid items or the provided correctionType is not allowed for the target item, the related item is unexpected or invalid for the specified correctionType.

DELETE

To delete a quality assurance event previously created

DELETE /api/integration/qualityassuranceevents/<:qualityassuranceevent-id>

Only events for the Quality Assurance Source named DSpace User Corrections can be deleted.

A sample CURL command would be:

curl -i -X DELETE 'https://demo.dspace.org/server/#/server/api/integration/qualityassuranceevents/c71c4b56-ff05-4c7f-a45f-757e2e29ced7' -H 'Authorization: Bearer eyJhbGciO…'

Return codes:

  • 204 No content - if the operation succeed
  • 401 Unauthorized - if you are not authenticated
  • 403 Forbidden - if you are not logged in with sufficient permissions. Only the user that has originally created the request can delete it
  • 404 Not found - if the quality assurance event doesn't exist (or was already deleted)

Search methods

Get qualityassuranceevents by a given topic

GET /api/integration/qualityassuranceevents/search/findByTopic?topic=:topic-key[&size=10&page=0]

It returns the list of qa events from a specific topic, eventually filtered by the target they refer to

The supported parameters are:

  • page, size see pagination
  • topic: mandatory, the key associated with the requested topic. Please note that the topic could contain the uuid of a specific target item to restrict the qa events. See the note about the qa topic id

Return codes:

  • 200 OK - if the operation succeed
  • 400 Bad Request - if the topic parameter is missing

Provide paginated list of the qa events available.

Get qualityassuranceevents created by the current user

GET /api/integration/qualityassuranceevents/search/findByCurrentUser?target=<:item-uuid>[&size=10&page=0]

It returns the list of qa events created from the current user

The supported parameters are:

  • target: mandatory. The uuid of the item target of the returned quality assurance events
  • page, size see pagination

Return codes:

  • 200 OK - if the operation succeed
  • 400 Bad Request - if the target parameter is missing or is not a UUID
  • 422 Unprocessable Entity - it the target parameter doesn't resolve to a valid item

Provide paginated list of the qa events for the specified target item created by the current user. An empty page is returned for unauthenticated users

PATCH

To record a decision

PATCH /api/integration/qualityassuranceevents/<:qualityassuranceevent-id>

This method allow users to Accept, Reject or Discard a qa event. The PATCH body must follow the JSON PATCH specification

[
  {
    "op": "replace",
    "path": "/status",
    "value": "ACCEPTED|REJECTED|DISCARDED|PENDING"
  }
]

As response, the modified qa event will be returned.

POST

To associated a related item to the qa event

POST /api/integration/qualityassuranceevents/<:qualityassuranceevent-id>/related?item=<:item-uuid>

This endpoint allows you to associate an associated item with the event, if the type of event supports it.

Return codes:

  • 201 Created - if the operation succeed
  • 401 Unauthorized - if you are not authenticated
  • 403 Forbidden - if you are not logged as an administrator
  • 404 Not found - if no qa event exists with such id
  • 422 Unprocessable entity - if the qa event doesn't allow a related item (for example it is an openaire event not related to a */PROJECT topic)

To remove a related item to the qa event

DELETE /api/integration/qualityassuranceevents/<:qualityassuranceevent-id>/related

Only the association between the qa event and the related item id deleted. The related item stays untouched

Return codes:

  • 204 No content - if the delete succeeded (including the case of no-op if the qa event didn't contain a related item)
  • 401 Unauthorized - if you are not authenticated
  • 403 Forbidden - if you are not logged as an administrator
  • 404 Not found - if no qa event exists with such id
  • 422 Unprocessable entity - if the qa event doesn't allow a related item (i.e. it is not related to a */PROJECT topic)

To replace a related item

Replacing a related item will require deleting the related association and creating a new association hereafter

Get qualityassuranceevents created by the current user

GET /api/integration/qualityassuranceevents/search/findByCurrentUser?target=<:item-uuid>[&size=10&page=0]

It returns the list of qa events created from the current user

The supported parameters are:

  • target: mandatory. The uuid of the item target of the returned quality assurance events
  • page, size see pagination

Return codes:

  • 200 OK - if the operation succeed
  • 400 Bad Request - if the target parameter is missing or is not a UUID
  • 422 Unprocessable Entity - it the target parameter doesn't resolve to a valid item

Provide paginated list of the qa events for the specified target item created by the current user. An empty page is returned for unauthenticated users