REST API endpoints
Find out what endpoints you can call and what methods you can use to call each endpoint. You can also find sample calls, potential error messages, and a response for each call.
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.
Important: Your session token may expire after a while. In this case, perform a new Login action to refresh the token. You can adjust the session timeout on your WorldServer application server, in the general.properties file.
- Announcements
Announcements are a way in which administrators can inform users of various events such as company-related news, upgrades, or potential downtime. - Attribute definitions
In WorldServer, attribute definitions are the custom attributes that you can create by going to Management > Administration > Customization. Through the API, you can obtain information about the attributes defined on your system and check whether a specific attribute exists. - Attribute values
Attribute values are the values of the custom attributes defined on your system. You can get the values defined for certain resources and update them. - Clients
Clients are groups of users who submit content and require translation services. For example, a client can include an entire organization or a department within an organization. Through the API, you can obtain information about the clients defined on your system and check whether a specific client exists. - Configurations
Get information about various project configurations from the general.properties file (such as illegal project name characters or priority bands) or from the tm.properties file (such as the use of the Live TM mode). - Cost models
When you determine the scope (word count and price) of a project, folder, or asset, you need to select a cost model to calculate the cost of the project. Through the API, you can obtain information about the cost models defined on your system and check whether a specific cost model exists. - Files and assets
Get information about the reference files and translatable assets on your system, including their content, and upload files as attribute values or as translatable assets. - Info
Version information includes the server version, the name and host machine of your WorldServer database, and the current version of the API. - Issues
Issues can be assigned to a particular user or workflow role (independent issues) or associated with a task (task issues). Through the API, you can obtain information about the issues created on your system and check whether a specific issue exists. - Jobs
The collection of jobs processed in the background across your entire WorldServer environment. - Linguistic filters
The collection of linguistic filters. - Locales
A locale is a user-defined combination of a language specific to a place (such as English spoken in the United States) and a default encoding used to store content in this language (such as ISO-8559 or UTF-8). Through the API, you can obtain information about the locales defined on your system and check whether a specific locale exists. - Login
Obtaining a session token is the main prerequisite for all the requests that you can make to the WorldServer API. - Logout
Log out after making all the calls that you need to cancel the current user session. - Online assets
Online assets are assets created by the Enable Online Editing automatic action and processed in SDL Online Editor. - Project attributes
Project attributes are custom attributes defined specifically for projects and associated with project types. In WorldServer, you can add custom attributes by going to Management > Administration > Customization and selecting Attributes in the Custom component type list. - Project groups
A project group is a representation of an entire translation job, from one source locale to one or more target locales. Project groups usually contain multiple projects—one for each target locale. - Project types
Project types are templates for creating projects. Every time you create a project in WorldServer, you also need to select an appropriate project type. Through the API, you can obtain information about the project types defined on your system and check whether a specific project type exists. - Projects
Various calls for obtaining information about projects and performing operations with them. - QA Checker profiles
QA Checker profiles are configurations that you can use to perform quality assurance checks and in SDL Trados Studio and in WorldServer. - Quality models
Use quality models to specify different error categories and severities that will be used when reviewing translations. Through the API, however, you can only retrieve a list of the quality models defined on your system, without modifying them. - Requests for quotes
A quote is an estimation of the scope, timing, and cost of a potential project. Through the API, you can get the quotes requested by certain clients, the quotes that have a certain status, or all the quotes requested on the system. - Search filters
Through the API, you can perform various operations with search filters, such as getting, creating, updating, or deleting them. - Segments
The segments processed as part of a certain task. - Task history
A task's history tracks various changes related to that task from its creation to its completion. The task history includes information such as completed steps, assignments, exported assets, or the users who claimed and unclaimed the task at various points throughout the workflow. - Tasks
A task corresponds to a single asset in a single project for a single target locale. As part of working with tasks in a project, you can perform various operations such as claiming, completing, canceling, redoing, moving, importing, exporting, or updating tasks. - Term database entries
A term database entry consists of one or more associated terms and a set of attributes. Through the API, you can obtain information about the entries defined on your system and check whether a specific entry exists. - Translation memory entries
A translation memory entry consists of a pair of equivalent source and target segments. Through the API, you can obtain information about the entries defined on your system and check whether a specific entry exists. - Users
A user is any person who plays a role in localizing content in WorldServer. Through the API, you can obtain information about the users defined on your system, as well as statistics, personal preferences, or permissions for the current user. - Workflow roles
Workflow roles are groups of WorldServer users who perform similar duties; for example, translators or reviewers. - Workflows
A workflow defines a standard, repeatable process for translating and handling content. Workflows consist of steps and transitions that link the steps together, imposing the order in which the steps occur. - Workgroups
Workgroups are groups of related users, such as departments within organization, and you can link them to project types so that WorldServer can automatically assign the appropriate users to tasks. Through the API, you can obtain information about the workgroups defined on your system and check whether a specific workgroup exists.