REST - Task
REST-Interface
REST-Interface
URL
GET <application-url>/api/task/<taskId>
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.Task
Permission
Login
Sample
GET http://localhost:8080/mtr-backend/api/task/1
URL
GET <application-url>/api/task
Query parameter
resubmissionTimePeriodInDays
setresubmissionTimePeriodInDays
setresubmissionDateInSeconds
not set or resubmissionDateInSeconds
< nowresubmissionDateInSeconds
set and resubmissionDateInSeconds
> nowProduces
application/json
application/xml
List<com.matterial.mtr.api.object.Task>
Permission
Login
Sample
GET http://localhost:8080/mtr-backend/api/task
Creating a task will automatically set (overwrite) these fields:
creationDateInSeconds
- now
authorAccount
- current usertaskStatusId
- OPENURL
POST <application-url>/api/task
Consumes
application/json
application/xml
com.matterial.mtr.api.object.Task
Produces
application/json
application/xml
com.matterial.mtr.api.object.Task
Permission
EDIT_TASK
Sample
POST http://localhost:8080/mtr-backend/api/task
You can only update these fields:
description
dueDateInSeconds
resubmissionTimePeriodInDays
documentLanguageVersionId
assignedRole
URL
PUT <application-url>/api/task/<taskId>
Path parameter
Consumes
application/json
application/xml
com.matterial.mtr.api.object.Task
Produces
application/json
application/xml
com.matterial.mtr.api.object.Task
Permission
EDIT_TASK
Sample
PUT http://localhost:8080/mtr-backend/api/task/2
Since v2.5.0
Accepts the task. This sets these values:
taskStatusId
- ACCEPTED
acceptedAccount
- current userThe task can only be accepted if:
TaskStatus
is OPEN
URL
PUT <application-url>/api/task/<taskId>/accept
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.Task
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/task/2/accept
Since v2.5.0
Returns the task to group. This sets these values:
taskStatusId
- OPEN
acceptedAccount
- null
The task can only be returned if:
TaskStatus
is ACCEPTED
URL
PUT <application-url>/api/task/<taskId>/return
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.Task
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/task/2/return
Since v2.5.0
Closes the task. This sets these values:
taskStatusId
- CLOSED
The task can only be closed if:
TaskStatus
is ACCEPTED
URL
PUT <application-url>/api/task/<taskId>/close
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.Task
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/task/2/close
Since v2.5.0
Rejects the task. This sets these values:
taskStatusId
- REJECTED
The task can only be rejected if:
TaskStatus
is ACCEPTED
URL
PUT <application-url>/api/task/<taskId>/reject
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.Task
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/task/2/reject
Since v2.5.0
Resubmits the task. This sets these values:
resubmissionDateInSeconds
- now
+ resubmissionTimePeriodInDays
The task can only be resubmitted if:
TaskStatus
is ACCEPTED
resubmissionTimePeriodInDays
was set ( > 0
)URL
PUT <application-url>/api/task/<taskId>/resubmit
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.Task
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/task/2/resubmit
Since v2.5.0
Reopens the task. This sets these values:
taskStatusId
- ACCEPTED
The task can only be reopened if:
TaskStatus
is CLOSED
or REJECTED
URL
PUT <application-url>/api/task/<taskId>/reopen
Path parameter
Produces
application/json
application/xml
com.matterial.mtr.api.object.Task
Permission
Login
Sample
PUT http://localhost:8080/mtr-backend/api/task/2/reopen
URL
DELETE <application-url>/api/task/<taskId>
Path parameter
Produces
text/plain
Integer - count of removed
Permission
EDIT_TASK
Sample
DELETE http://localhost:8080/mtr-backend/api/task/8