MT-EQuAl REST API
GET task/show
Returns list of the ongoing tasks of the specified project. The output includes the tasks status and the due date for the following tasks: project creation, evaluation format setup, input corpus, guidelines setup, corpus check, evaluation(s), and project finalization.
Endpoint
GET http(s)://hostname/api/task/show
Request Parameters
Header field
|
Type | Value |
---|---|---|
X-Api-Key |
string | Required. A valid access token from a registered MT-EQuAl account. The access token
must have been issued on behalf of the current user. |
Request data | Type | Value |
---|---|---|
id | string | Required. The project id. |
Response
On success, the HTTP status code in the response header is 200
(OK)
and the response is structured in JSON as follow:
{
"header": {
"date": "Date and time of the response generation process",
"description": "Description of the invoked method or error message",
"status": "status/error code"
},
"result": {
"tasks": [
{
"id": "The task id",
"name": "The task name",
"date": "The due date",
"status": "done or undone",
"message": "Any additional information to provide to the user",
},
....
}
}
}
Example
curl -X GET "https://hostname/api/task/show?id=1" -H "X-Api-Key: {user access token}"
{
"header": {
"date": "Monday, 2016-05-16 11:54:17 Europe/Paris",
"description": "Returns list of the ongoing tasks of the specified project. The output includes the tasks status and the due date for the following tasks:
project creation, evaluation format setup, input corpus, guidelines setup, corpus check, evaluation(s), and project finalization.",
"status": "200"
},
"result": {
"tasks": [
{
...
]
}
}