Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/assets/search/folders

Requires JWT.

Search for folders.

Request

POST /api/p/<project gid>/assets/search/folders
Authorization: Bearer <JWT>

{
    "q": "products",
    "language": "nl"
}

q is the query to perform
language is the language to search in

optional

page.top (default 0) only return folders starting from the top-index (0-based).
page.size (default 10) only return this many folders.

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "assets": ["96ec02b2-fb8d-4fb4-b952-fad0c4b88a74", …],
        "assets.size": 17
    },
    "data": {
        "assets": {
            "96ec02b2-fb8d-4fb4-b952-fad0c4b88a74": {
                …
            },
            …
        }
    }
}

result

assets paginated results for the query, in relevancy order
assets.size the size of the non-paginated results for the query

data

assets Asset info with hierarchy, type, name. Unordered.

Error responses

400 Bad request - missing parameters or wrong type or value
401 Unauthorized - missing or expired JWT
403 Forbidden - not a member of this project
1002 Search error - internal search engine error

HTTP/1.1 422 Unprocessable entity

{
    "success": false,
    "result": {
        "code": 1002,
        "message": "Search error",
        "info": {}
    },
    "data": {}
}