You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Excuse a single ticket for multiple related problems. I'll create separate if you'd prefer that.
Is your feature request related to a problem? Please describe.
I enabled API access to programmatically export documents. I found that I can retrieve project documents and then export annotations in the desired format. However, there are some shortcomings:
The /api/aero/v1/projects/{projectId}/documents endpoint returns all documents, requiring filtering on client side, for example to get only state=CURATION-COMPLETE
Documents can only be exported one-by-one with the /api/aero/v1/projects/{projectId}/documents/{documentId} endpoint
When exporting, the response is always Content-Type: application/octet-stream. Additionally, Accept header causes status 406 Not Acceptable, even if a matching media type is requested. These I find a bug
Describe the solution you'd like
Ideally, it would be possible to directly export all matching documents, without doing a search first. Something like
GET /api/aero/v1/projects/{projectId}/documents{?format,state}
The response could be a ZIP with each document exported in the chosen format
Describe alternatives you've considered
If a new endpoint is not feasible, it would be nice to introduce some improvements
Add ?state query param to document search endpoint
Respond with matching content type, such as rdfcas => text/turtle, conllu => text/plain, jsoncas => application/json, etc
(Optionally) Allow content negotiation of RDF formats. For example, requesting with Accept: application/n-triples should be honoured and respond with RDF in n-triples format
The text was updated successfully, but these errors were encountered:
Excuse a single ticket for multiple related problems. I'll create separate if you'd prefer that.
Is your feature request related to a problem? Please describe.
I enabled API access to programmatically export documents. I found that I can retrieve project documents and then export annotations in the desired format. However, there are some shortcomings:
/api/aero/v1/projects/{projectId}/documents
endpoint returns all documents, requiring filtering on client side, for example to get onlystate=CURATION-COMPLETE
/api/aero/v1/projects/{projectId}/documents/{documentId}
endpointContent-Type: application/octet-stream
. Additionally,Accept
header causes status406 Not Acceptable
, even if a matching media type is requested. These I find a bugDescribe the solution you'd like
Ideally, it would be possible to directly export all matching documents, without doing a search first. Something like
The response could be a ZIP with each document exported in the chosen format
Describe alternatives you've considered
If a new endpoint is not feasible, it would be nice to introduce some improvements
?state
query param to document search endpointrdfcas => text/turtle
,conllu => text/plain
,jsoncas => application/json
, etcAccept: application/n-triples
should be honoured and respond with RDF in n-triples formatThe text was updated successfully, but these errors were encountered: