Lists
The generic "List" API lets you query projects, jobs, orders, people, configurations etc:
- 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.
Lists will be made available over time for: jobs/list, projects/list, companies/list, users/list etc. See the respective documentation pages to start reading.
The * in the URLs are placeholders. Replace by the data you searcjh, such as: /api/jobs/list or /api/companies/list.
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.
| 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