Retreive a list of tasks from your administration. Use offset and limit parameters to retrieve more tasks over multiple calls. It is also possible to retreive only tasks relating to one project by adding Project and SelectProjectBy.
- Request
- Response
Parameters
Project
String
Details
(optional) Filter the tasks associated with the project by either projectnumber or projectname
SelectProjectBy
String
Details
Allowed values: NAME or NUMBER. Determines wether the value in the parameter 'Project' is the projectname or projectnumber.
SearchOperand
String
Details
When creating a request with multiple parameters, this setting can be used to switch between "AND" or "OR" condition checking. For example: when both parameters ChangedSince and CreatedSince are submitted and this setting is set to "AND", the query will only return tasks where both ChangedSince AND CreatedSince match the parameters. However, if this setting is set to "OR" the query will return a list of tasks that match with either the ChangedSince or the CreatedSince. This setting defaults to "AND". This setting only applies to the parameters: ChangedSince and CreatedSince.
ChangedSince
Long
Details
(optional) An UNIX timestamp in seconds. Will return only tasks that are changed since the specified timestamp.
CreatedSince
Long
Details
(optional) An UNIX timestamp in seconds. Will return only tasks that are created since the specified timestamp.
Limit
Integer
Details
Defines the limit of items to retreive
Offset
Integer
Details
Defines the offset for the retreive
Sorting
String
Details
An optional sorting parameter. Recommended to use when using LIMIT and OFFSET parameters. Allowed sorting values: CreatedDate, ChangedDate
SortDir
String
Details
Defaults to "DESC". Allowed values: "ASC" (low to high) and "DESC" (high to low)
CURL Example
|
1 |
curl -X GET -H "Content-Type: application/json" -H "ApiKey: b7d343Bnhd436f3ec3bd3504582" -H "Username: [email protected]" "https://rest-api.silvasoft.nl/rest/listtaks" |
Parameters
Title
String
More info
The title of the task
Description
String
More info
The description of the task
StartDateTime
Long
More info
An UNIX timestamp in seconds reflecting the date and time of the start of the task.
EndDateTime
Long
More info
An UNIX timestamp in seconds reflecting the date and time of the end of the task.
AssignedTo
String
More info
The person that is assigned to the task
Status
String
More info
The status of the task
ProjectName
String
More info
If the task is associated with a project, the project name will be returned
ProjectNumber
Integer
More info
If the task is associated with a project, the project number will be returned
ProjectPhase
String
More info
If the task has an projectphase, the projectphase will be returned
CreatedOn
Long
More info
An UNIX timestamp in seconds reflecting the date and time of creation.
ChangedOn
Long
More info
An UNIX timestamp in seconds reflecting the date and time of last change.
Response JSON Example
The response order can vary from the parameter order above|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
[ { "AssignedTo": "John Doe", "Status": "Open", "ProjectPhase": "Algemene projectfase", "Description": "Example project", "StartDateTime": 1746939600, "ProjectName": "Test project", "EndDateTime": 1746943200, "ProjectNumber": 3, "Title": "test task by project", "CreatedOn": 1678362196, "ChangedOn": 1678362211 }, { "AssignedTo": "Jane Doe", "Status": "Open", "ProjectPhase": "", "Description": null, "StartDateTime": 1676469600, "ProjectName": null, "EndDateTime": 1676473200, "ProjectNumber": null, "Title": "Create test data", "CreatedOn": 1676459189, "ChangedOn": 1676459189 } ] |