Tasks REST API

You are here:
Estimated reading time: 2 min

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:
ParametersOptionsDescription
nameFree text, name of taskfilter tasks by task name
categoryFree text, name of categoryfilter tasks by existing task category
statebacklog, new, work_in_progress, donefilter tasks by the selected state
responsible_userFree text, name of task responsible userfilter tasks by the name of the user responsible for the task
time_filterlast_next_7_days, last_next_two_weeks, last_next_month, last_next_3_monthsfilter tasks by the selected time filter
append_on_service_typeE2eService, ServiceComponent, Provider, Stakeholderfilter tasks by the selected Service type, this works for primary object and related objects too
append_on_service_nameFree text, name of the Servicefilter tasks by the existing Service name, this works for primary object and related objects too
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:
ParametersOptionsAdditional information
nameFree text, name of the task
task_categoryFree text, name of categorytask category must exist! You can find your available task categories in the company settings page
start_datestart date in valid formatvalid format is:
%d/%m/%y – %H:%M
%d = day
%m = month
%y = year
%H = hour
%M = minute
end_dateend date in valid formatvalid format is:
%d/%m/%y – %H:%M
%d = day
%m = month
%y = year
%H = hour
%M = minute
user_idonly existing user idyou 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
parent_typeE2eService, ServiceComponent, Provider, Stakeholderyou must select a main object type
parent_idonly existing parent idyou must know a selected object type id, you can find this id using another REST API calling dependent by the selected object

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:
ParametersOptionsAditional information
descriptionfree 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&parent_type=E2eService&parent_id=22&user_id=122&start_date=16/09/2020%2015:00&end_date=16/09/2020%2016:00

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:
ParametersOptionsAdditional information
nameFree text, name of the task
task_categoryFree text, name of categorytask category must exist! You can find your available task categories in the company settings page
start_datestart date in valid formatvalid format is:
%d/%m/%y – %H:%M
%d = day
%m = month
%y = year
%H = hour
%M = minute
end_dateend date in valid formatvalid format is:
%d/%m/%y – %H:%M
%d = day
%m = month
%y = year
%H = hour
%M = minute
descriptionFree text, description of the task
statebacklog, new, work_in_progress, doneyou must select only one of this options
user_idonly existing user idyou must know user id if you want to change assigned user, you can find your user id on the users page
parent_typeE2eService, ServiceComponent, Provider, Stakeholderyou must select one of this object type if you want to change it(don’t forget to change a parent id too!)
parent_idonly existing parent idyou must know a new selected object type id, you can find this id using another REST API calling dependent by the selected object

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:
Was this article helpful?
Dislike 0
Views: 23
Start using SimplyIT today
Bring visibility into your services provided by IT, HR, maintenance or external vendors.