System API v2
Welcome to the documentation of the API version 2. It is a web-based API to retrieve and update information in Wordbee Translator.
A key difference compared to version 1 of the API is that API credentials can be created individually per user. Credentials inherit the access rights (or profile) of the users. You can create dedicated API users to allow different people or systems to interact with the API and within a defined framework of rights.
The API sample root URL can be:
The API 2 endpoint is your Wordbee Translator URL + /api
Chapters:
Jobs — Provides methods to enumerate and manage jobs.
- jobs/list
- jobs/{id}/summary
- jobs/{id}/action/commit
- jobs/{id}/action/reassign-person
- jobs/{id}/terms
- jobs/{id}/terms/preview
- jobs/{id}/terms/checklist
- jobs/{id}/traces — The resulting JSON object has these properties: count Total number of traces. int items Array with the list of traces, see below. object[] persons An object containing the persons referred to by the traces uid property. Note: Excludes persons that the user cannot see. There is an access right to prevent a user from viewing user and company names. See Persons List (Object) for details. object jobs An object with all referenced jobs. object canAdd If true then user can add new comments bool Each trace has these properties: cty Always "job" string traceid The ID of the trace. The format is "s229" + creation date, "s9938" + creation date string txt Optional message with the trace. Typically used with traces that are messages. string loc The locale to which the comment is attached. This can be a source or target locale. string loct The language name. string dt The date of the trace. datetime uid The user who triggered this event. Null if the user was deleted. int? tsk The task code to which this event is attached: RV, TR, PROOF string tskt The task name. string status The job status at the time. Numeric status, see Job Status int statust The job status title. string jid The string job id to which this trace refers. string edit True if the user is allowed to edit or delete the item. False, if no change is permitted. bool The jobs object is a dictionary where the key is the string job id and the value an object as below: id The globally unique ID of the job (which encodes jobid + iscodyt) string jobid The numeric job id (unique for Standard and Codyt respectively) int iscodyt True: A Codyt job. False: A standard job. bool reference The reference of the job. With Codyt jobs this is the job's document name. string task The task code of the job (TR, RV...) string taskt The task title (Translation, Revision...) string src / srct Source language code and name string trg / trgt Target language code and name string branch / brancht Branch language code and name. In general the branch locale is identical to the target locale. It may be different where a workflow involves a back translation or translation into pivot languages. string status The job status as a number. See Job Status int statust The job status name. string assignment Assignment details, see Job Assignment Details Example: "assignment" : { "mode" : 0, "modet" : "Fixed assignment" , "cid" : 334, "cname" : "Ultra Translations" , "uid" : null , "uname" : null , "wasAccepted" : true } object
- jobs/{id}/traces (post)
- jobs/{id}/traces/{traceid} (put)
- jobs/{id}/traces/{traceid} (delete)
- workflow/{id}/traces
- jobs/wordcounts/list
- jobs/{id}/supplier (post)
- Common - Jobs — Common data structures related to jobs.
- jobs/{id}/properties (post)
Resources — This namespace provides API methods to retrieve and manipulate data related to segments, documents, document sets, source/target files and attachments and other related data.
- resources/segments/rights
- resources/items
- Search and filter segments
- resources/segments/view
- resources/segments/io
- Export to TMX, EXCEL, CSV, ODS, TBX
- Copy / Consolidate resources
- resources/segments/actions
- resources/segments/finder
- resources/segments/reports
- resources/segments/sampling
- resources/documents
- resources/comments
- resources/timeline
- resources/files
- resources/qa
- Statistics
- resources/team
- resources/list
- Text edits
- Objects - resources
Settings — Provides methods to retrieve and update platform settings such as languages and task codes.
- Languages and codes
- Document formats
- Document format profiles
- Word count profiles
- settings/tbx
- Machine translation
- Custom field configuration
- Segmentation settings (SRX)
- Workflows
- User profiles
- settings/tasks/codes
- settings/currencies/codes
- settings/domains/codes
- settings/countries/codes
- settings/timezones/codes
Common — This chapter discusses general concepts or mechanisms linked from other pages.
- Lists — GETTING STARTED This query searches items in status "1" and with a reference starting with "ax": CODE (POST) */list HTTP BODY: { "query": '{status} = 1 AND {reference}.StartsWith("ax")' } URLS The following methods are available to search, count, print and aggregate your data. Querying data */list Retrieve and query items with all or selected fields. Supports pagination. Parameters like query string, data fields and pagination are included in the request body. Read more */list/full Same as above but systematically includes all data fields in the results. Read more */list/count Same as above but returns just the grand total of jobs matching filter criteria. Read more */list/aggregations Get statistics such as total items per status or other criteria. Gain insight into data. Read more */list/items/{id} Get all fields for a specific item. Read more Field details */list/fields Get list of data fields with name, description, data type and more information. Read more Reports */list/print Download filtered data to EXCEL, XML or JSON. Read more Advanced methods */list/autocomplete Implement auto complete functionality for selected data fields. Read more */list/queries/* Load and save queries for later reuse. Read more */list/layouts/* Load and save list/filter layouts for later reuse. Read more Method Description Documentation ACCESS RIGHTS Please keep in mind that your access rights entirely decide on the data and the field values you can retrieve. With limited rights you may not see all the jobs or projects etc., but just yours. With limited rights you may not see some customer details or other user profile dependent information. Access rights are exactly the same as in the Wordbee Translator system. See also: Access Rights
- Auto-completion and pagination — Many API methods implement optional auto-completion and pagination functionality: