API – Program report
Before making a request, log in as a user with the Administrator role. How to log in via API is described here API – Authorization
- To get the program report you need to send GET request to the following URI
https://localhost:8080/api/v2/programs/report/{id}?page=1&count=10&filter[programId]={id}&sorting[task_finish_date]=desc - The request must contain the headings Content-Type: application/json;charset=UTF-8 and Authorization: Bearer xxxxxx.
Request example:
curl 'https://localhost:8080/api/v2/programs/report/123?page=1&count=10&filter[programId]=123&sorting[task_finish_date]=desc' -H 'Authorization: Bearer xxxxxx' -H 'Content-Type: application/json;charset=UTF-8'
Instead of a local address http://localhost:8080 you need to use the address of your server.
instead of 123, specify the program id.
instead of 123, specify the program id.
Answer
In case of successful request (HTTP response code - 200), the following result will be returned:
- results arraydata
- pagination object (information about the number of pages, the current page, the number of results)pager
The request supports filtering by the following fields:
- taskId - Task ID
- userId - User ID
- position - Position
- city - City
- department - Department
- tags - tag
- task_finish_date - period by date of completion
In case of error (HTTP response code - 400) it returns JSON object with error information