settings/documentformats/profiles/list

Enumerate and find document format profiles.

Such profiles are configured online under "Settings" > "Document format profiles".

A profile defines which file format configuration to use. A profile can be assigned to projects or an order form. It can also be restricted to a specific client.

This API method is available from September 2021

NOTE: Replace */list by /api/settings/documentformats/profiles/list in the URLs below.

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.

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.

EXAMPLES

Enumerate all configurations

To get first 100 configuration with all fields:

CODE

POST http://{server}/api/settings/documentformats/configs/list/full
BODY: { "take": 100 }

The result is:

CODE

{
    "total": 27,
    "count": 20,
    "rows": [
        {
            "id": 403,
            "domain": "CSV",
            "domaint": "CSV files",
            "name": "My CSV filter",
            "description": "My description",
            "exts": ".csv",
            "type": 33
        },
        {
            "id": 382,
            "domain": "MSPPT",
            "domaint": "Microsoft Powerpoint",
            "name": "Powerpoint filter",
            "description": "Action powerpoint zonder notes",
            "exts": ".ppt, .pot, .pps, .pptx, .pptm, .potx, .potm, .ppsx, .ppsm",
            "type": 9
        },
		....

Get configurations for files of extension ".doc" or ".docx"

Use a filter on extensions:

CODE

POST http://{server}/api/settings/documentformats/configs/list
BODY: { "query": '{exts}.Matches(".doc|.docx", "anyof")' }

When you want to filter by a single extension you can write shorter:

CODE

POST http://{server}/api/settings/documentformats/configs/list
BODY: { "query": '{exts}.Matches(".doc")' }

Count configurations per file format

Use the aggregation option:

CODE

POST http://{server}/api/settings/documentformats/configs/list/aggregations

The result is:

CODE

{
    "total": 65,
    "buckets": [
        {
            "value": "FRAMEMAKER",
            "title": "Adobe FrameMaker",
            "css": null,
            "query": "{domain}.Matches(\"FRAMEMAKER\")",
            "count": 6
        },
        {
            "value": "INCOPY",
            "title": "Adobe InCopy",
            "css": null,
            "query": "{domain}.Matches(\"INCOPY\")",
            "count": 1
        },
		...