media/filescollection/{key}/items/file/properties (PUT)

To set properties for one or more files. This method operates very similar to https://wordbee.atlassian.net/wiki/spaces/API2/pages/2339438593

URL

(PUT) /api/media/filescollection/{key}/items/file/properties

PARAMETERS

The URL parameters are:

key

The unique files collection ID

string, Mandatory

The BODY is a JSON array with updates for one or more files:

files

Array of files with the properties to update.

object[], Mandatory

Each array element has these properties:

filename

Specify the same filename as above.

string, Mandatory

parserId

Optional. To assign the document format profile to use for this file. You can only assign profiles that are proposed in the file object, property parsers.

int?, Optional

pageCount

Optional. To assign a page count to the file. See also https://wordbee.atlassian.net/wiki/spaces/API2/pages/2339045384 to check if page counts can be assigned and for which file types.

int?, Optional

comments

Optional. To assign a comment to a file. Set an empty string ““ to remove an existing comment.

string?, Optional

 

RESULTS

The result is all contents of the file collection. The payload is identical to: https://wordbee.atlassian.net/wiki/spaces/API2/pages/2339274886

Example:

[ { "name": "marketing.docx", "ext": ".docx", "translate": false, "parserId": 2341, "domain": "MSWORD", "parsers": [2341, 1000], "pageCount": 3, "sizeKB": 100, "comments": "Not really" }, { "name": "file.pot", "ext": ".pot", "translate": false, "parserId": null, "domain": "POT", "parsers": null, "pageCount": 3, "sizeKB": 34, "comments": "Not really" } ]

 

 

Copyright Wordbee - Buzzin' Outside the Box since 2008