Documentation Center

Get tasks

Get a list of the tasks defined on your system.

For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The sessionId in the response is your session token. Use this token in all the other calls that you make.

Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to Management > User Setup > User Types, and then select your user type.

API call

<protocol>://<ws-host>:<ws-port>/ws-api/v2/tasks?token=<sessionId>

Details

  • GET method
  • Content-Type in the header: application/json
  • Mandatory parameter: the session token (as a query string parameter or as a key-value pair in the header)

Integration tips

For integration purposes, you might want to obtain information only about certain tasks or about the tasks belonging to a specific project. If you already know the IDs of the tasks, use the ids filter. If you know the ID of the project, use the projectId filter.

Available filters

You can add the filters as query string parameters or as key-value pairs in the header:
FilterDescription
ids=<taskId1,taskId2,...,taskIdN>The IDs of the tasks to retrieve, separated by commas.
projectId=<projectId>The ID of the project from which to retrieve tasks.
sortBy=<fieldName>Use this filter in conjunction with the fields filter. If the fields you specified for sorting are not available, the results will not be sorted.
sortDirection=<asc|desc>Ascending or descending.
fields=<fieldName1,fieldName2,…,fieldNameN>The names of the fields to be included in the JSON response, separated by commas. Do not use in conjunction with the excludedFields filter.
excludedFields=<fieldName1,fieldName2,…,fieldNameN>The names of the fields to be excluded from the JSON response, separated by commas. Do not use in conjunction with the fields filter.
offset=<number>The zero-based starting index in the entire collection of the first item to return.
limit=<number>The maximum number of collection items to return for a single request. By default, 30. The limit should be greater than or equal to 1.
view=<value>The name of the view.
outdatedTasks=<true\false>A flag indicating whether or not outdated tasks should be included.
Examples:
  • <protocol>://<ws-host>:<ws-port>/ws-api/v2/tasks?token=<sessionId>&ids=1081,1065,1074
  • <protocol>://<ws-host>:<ws-port>/ws-api/v2/tasks?token=<sessionId>&sortBy=name&sortDirection=asc
  • <protocol>://<ws-host>:<ws-port>/ws-api/v2/tasks?token=<sessionId>&fields=name,description&sortBy=name&sortDirection=asc
  • <protocol>://<ws-host>:<ws-port>/ws-api/v2/tasks?token=<sessionId>&excludedFields=name
  • <protocol>://<ws-host>:<ws-port>/ws-api/v2/tasks?token=<sessionId>&limit=10&fields=name,creationDate&ids=3346,3347
  • <protocol>://<ws-host>:<ws-port>/ws-api/v2/tasks?token=<sessionId>&projectId=3483

Advanced filtering

To reduce the amount of data in the result and to improve performance, you can perform the filtering deeper in the project tree structure. For example: <protocol>://<ws-host>:<ws-port>/ws-api/v2/tasks?token=<sessionId>&fields=id,project(id,name,targetLocale(id,name)),workflow(steps(id,name))

In this case, the returned JSON contains only the fields you specified for each layer:
  • The ID of each task, the project in which it is included, and the workflow used to process it.
  • The ID, the name, and the target locale of the project.
  • The ID and the name of the target locale used in the project.
  • Inside the workflow model, the ID and the name of the workflow steps.
The same logic applies to the excludedFields filter.

Response

A screen shot that shows a typical response to this call.

Error messages

MessageStatus code
The limit is not valid (It should be greater than or equal to 1.)400 Bad Request
Sort direction not provided, or invalid400 Bad Request
Offset not provided, or invalid (If the offset value is negative.)400 Bad Request
Offset out of range. Collection has only n items (If the offset value is greater than n.)400 Bad Request
No session token provided or invalid token401 Unauthorized
For input string: \<invalidId>\ (If one of the IDs you entered is not a valid number.)500 Internal Server Error

Troubleshooting

  • Make sure that the endpoint you are calling is correct.
  • Make sure that you are using the GET method for the call.
  • Make sure that the Content-Type in the header is application/json.
  • Make sure that your session token is correct and that it has not expired.