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.

1 EXAMPLES

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

EXAMPLES

Enumerate all configurations

To get first 100 configuration with all fields:

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

The result is:

{
    "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:

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:

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

Count configurations per file format

Use the aggregation option:

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

The result is:

{
    "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
        },
		...