REST API of tasks enables you to use tasks data from SimplyIT.cloud and connect them with other tools.
We have at the moment three API calls which enables you use SimplyIT.cloud as master data about tasks, create new task using the API call or edit some task using the API call. Rest API “tasks” allows task filtering.
If you haven’t read the basic information about REST API, you can find it here.
REST API: “tasks”
Description of the call:
Returns information about all tasks in your “company” including all related objects.
Accessing data from tables:
Task, RelatedObject
Parameters with options for tasks filter:
| Parameters | Options | Description |
| name | Free text, name of task | filter tasks by task name |
| category | Free text, name of category | filter tasks by existing task category |
| state | backlog, new, work_in_progress, done | filter tasks by the selected state |
| responsible_user | Free text, name of task responsible user | filter tasks by the name of the user responsible for the task |
| time_filter | last_next_7_days, last_next_two_weeks, last_next_month, last_next_3_months | filter tasks by the selected time filter |
| append_on_service_type | E2eService, ServiceComponent, Provider, Stakeholder | filter tasks by the selected Service type |
| append_on_service_name | Free text, name of the Service | filter tasks by the existing Service name |
Example of curl:
curl -u username:password -i -H ‘Accept:application/json’ http://trial.simplyit.cloud/api/v1/tasks?category=task&state=new&append_on_service_type=E2eService&responsible_user=john&time_filter=last_next_month
Example output:
REST API: “tasks/create_task”
Description of the call:
You can create new task with this API call and returns a new task for further work with it. You must enter all required parameters correctly for successful creation or you can create a backlog task.
Change data in tables:
Task
Required parameters and options:
| Parameters | Options | Additional information |
| name | Free text, name of the task | |
| task_category | Free text, name of category | task category must exist! You can find your available task categories in the company settings page |
| start_date | start date in valid format | valid format is: %d/%m/%y – %H:%M %d = day %m = month %y = year %H = hour %M = minute |
| end_date | end date in valid format | valid format is: %d/%m/%y – %H:%M %d = day %m = month %y = year %H = hour %M = minute |
| user_id | only existing user id | you must know user id if you want to create full task, new task will be assigned to this user, you can find your user id on the users page |
| services_ids | list of related objects in valid format | you must select unless one related object and you must know selected service type and specific service id. Valid service types are: E2eService, ServiceComponent, Provider, Stakeholder Valid format is for example: {Provider:20,ServiceComponent:2} |
Tip:
If you want to create a backlog task, you can add a params state=backlog and at this moment is required only name!
More parameters and options:
| Parameters | Options | Aditional information |
| description | free text of task description |
Example of curl for create a backlog task:
curl -u username:password -i -H ‘Accept:application/json’ http://trial.simplyit.cloud/api/v1/tasks/create_task?state=backlog&name=Call john
Example output for backlog task:
Example of curl for create a full task:
curl -u username:password -i -H ‘Accept:application/json’ http://trial.simplyit.cloud/api/v1/tasks/create_task?task_category=task&name=Call%20john&user_id=122&start_date=16/09/2020%2015:00&end_date=16/09/2020%2016:00&services_ids={Provider:20,ServiceComponent:2}
Example output for full task:
REST API: “tasks/:id/change_task”
Description of the call:
You can update your task with this API call and returns an updated task for further work with it. You must know a task id for successful updating. You can get your task id using “tasks” Rest API calling.
Change data in tables:
Task
Parameters with options who can be changed in task:
| Parameters | Options | Additional information |
| name | Free text, name of the task | |
| task_category | Free text, name of category | task category must exist! You can find your available task categories in the company settings page |
| start_date | start date in valid format | valid format is: %d/%m/%y – %H:%M %d = day %m = month %y = year %H = hour %M = minute |
| end_date | end date in valid format | valid format is: %d/%m/%y – %H:%M %d = day %m = month %y = year %H = hour %M = minute |
| description | Free text, description of the task | |
| state | backlog, new, work_in_progress, done | you must select only one of this options |
| user_id | only existing user id | you must know user id if you want to change assigned user, you can find your user id on the users page |
| services_ids | list of related objects in valid format | you must know selected service type and specific service id. Valid service types are: E2eService, ServiceComponent, Provider, Stakeholder. Valid format is for example: {Provider:20,ServiceComponent:2} Attention! You must specify all services! If you forget to include some service, this service will no longer be related to the task |
Note: only the attributes which you enter in the parameters will be changed, the others remain the same
Example of curl:
curl -u username:password -i -H ‘Accept:application/json’ http://trial.simplyit.cloud/api/v1/tasks/2343/change_task?name=Call%20Alice&state=work_in_progress
Example output:
