jobs/list | Wordbee

The jobs/list/* methods let you find and filter both Codyt and Standard jobs:

Query data and get results. Print data to Excel or XML.
Aggregate data for statistics. Auto-complete service.
Save frequently used queries and result layouts for later reuse.

NOTE : Replace */list by /api/jobs/list in the URLs below.

GETTING STARTED

This query searches items in status "1" and with a reference starting with "ax":

(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.

Method	Description	Documentation
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

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.

JOB IDS

A job has a unique id which is a string of the following format:

"c{number}" : A Codyt job. Examples: c3302, c102...
"s{number}" : A Standard job. Examples: s223, s994

The number in this identifier is a sequential number specific to either Codyt or Standard.

EDIT DISTANCE

Four optional data fields report how much editing a completed job required. They are the same figures shown in the Edit effort row of the job word count tooltip and in the columns of report S410, and they are stored per job for both Standard and Codyt jobs.

These fields are not part of the default response. They are returned only when you name them in the fields parameter of your request (or when you pass allfields). Field names are case-sensitive and must be spelled exactly as below: a differently capitalised name is silently ignored rather than reported as an error.

Field	Description	Type
editDistance	Share of the job's measurable text that the worker changed, as a percentage. This is an effort rate and is not capped: repeated edits or large deletions can push it above 100%. It is not the bounded post-edit distance used by MT evaluation tools. Null when the job has no measurable text.	double?
editDistanceChars	Number of characters the worker changed in the job. Returns 0, not null, when the job has no measurable text (report S410 behaves the same way).	long?
editDistanceMT	How far the final translation sits from the machine translation it started from, as a percentage between 0 and 100. Measured over the job's machine-translated segments regardless of who edited them, so it is not filtered by the job's worker or task: for a post-editing job this is effectively the assignee's MT effort, for a later revision job it is the cumulative figure. Null when no text on the job was machine-translated.	double?
editDistanceMTChars	Number of characters separating the final translation from the machine translation it started from. Null when no text on the job was machine-translated.	long?

When the values are available

The figures are calculated by a scheduled task that runs about 60 minutes after a job is completed. A null value therefore means one of several things, which the API does not distinguish:

The job is not completed yet.
The job completed less than about 60 minutes ago and the calculation has not run.
The job completed before this feature shipped. The figures are forward-looking only; older jobs are not backfilled.
The job has no measurable text, or was not machine-translated (for the two MT fields).

Retry rule. A value is final once the job status is Completed and its end date is more than about 60 minutes old. A null value after that point means the job has no measurable data and will never acquire one — do not poll indefinitely.

Limitations

Not filterable. Jobs cannot be queried by edit distance. A request that filters on one of these fields is rejected with a "cannot be queried" error.
Not sortable. A request that sorts on one of these fields is served with the default sort instead; the request itself does not fail.
Job level only. The figures are stored per job, including for multi-document Standard jobs. They are not available per document, and are deliberately not exposed by jobs/wordcounts/list, whose rows are per job per document per word count sheet.

Visibility

These fields carry no access right of their own. Each caller receives values for exactly the jobs they can already see, which is the same set the job word count tooltip already shows them. A user without the see company jobs or see master company jobs rights gets values only for their own assigned jobs; with see company jobs for their own supplier company's jobs; with see master company jobs the wider internal view. Values are never returned for another company's jobs.