New WebAnno remote API

Implement a new remote API for WebAnno with a more systematic API design and a more maintainable backend implementation.

Project

• project list - list projects
• project create - create a new project
• project read - get project information
• project delete - delete a project
• project export - export a project as a ZIP file
• project import - import a project as a ZIP file

Document

• document list - list documents in a project
• document create - import a document in a specified format
• document create parameter state - allow document to be created in a specified state (Allowed: NEW, ANNOTATION-IN-PROGRESS)
• document read - export a document in a specified format
• document delete - delete a document from a project

Annotations

• annotations list - list which users have annotations
• annotations create - create/overwrite a users annotations by importing from a specified format
• annotations create parameter state - allow annotations to be created in a specified state
• annotations read - export a users annotations in a specified format
• annotations delete - delete the annotation document record from the DB and the latest file. It will seem to WebAnno as if the annotation document was never created. If WebAnno is configured to maintain a backup history, this history will be retained (minus the latest file of course).

Curation

• curation create - create/overwrite a curation by importing from a specified format
• curation create parameter state - allow curation to be created in a specified state (actually is the document state. Allowed: CURATION-IN-PROGRESS, CURATION_FINISHED)
• curation read - export a curated document in a specified format
• curation delete - delete the latest curation file. It will seem to WebAnno as if the annotation document was never created. If WebAnno is configured to maintain a backup history, this history will be retained (minus the latest file of course).
• curations list - this is not necessary since a) there is only a single curation per document and b) the curation status of a document is provided in the document list call.

Misc

• allow messages in response (https://github.com/webanno/webanno/issues/455#issuecomment-283011969)

Undecided

• conflate curation with annotation API using a special username <-> having a dedicated curation API parallel to the annotation API -> decision: separate set of calls for curation

[nipunsadvilkar]

Thank you so much for the response. it’s working! 👍

[reckart]

You get access to the Swagger UI if you log in as admin (ROLE_ADMIN). But then a second login popup comes up. The user that you use there to log in must have ROLE_REMOTE. Check if your admin user does indeed have the ROLE_REMOTE.