Documentation Center

API release notes

An overview of the main changes made to the REST API in WorldServer 11.4.

Version change

The second version (v2) of the REST API services has been released starting with WorldServer 11.4. Although calls made to v1 of the API will still work, this version becomes deprecated and you should consider updating your code to use v2 instead.

Change log

The following endpoints have been modified or added in this release:
Affected endpointsChanges
/projects/cancel and /projects/completeThe response now includes the ID of the background job that handles your request to complete or cancel projects (backgroundTaskId). For more information, see Complete project steps and Cancel projects.
/tasksYou can now include the workflowServletAttr field when filtering the request. It will return the name of any custom servlet that might be used in the current workflow step. For example: fields=name, description,currentTaskStep(typeName,displayName,workflowStep(workflowServletAttr))
/tasks/encodingThis endpoint has been added to verify the encoding of assets corresponding to tasks.
/tasks/{taskId}/assetThis endpoint has been added to update source assets. After you update a source asset through the REST API, complete its corresponding task in WorldServer. At this point, the task you completed is given the Restarted status and WorldServer creates a new task, identical to the previous one (but with a different task ID). Use this new task to translate and review the updated source asset.