Unicat API Reference

/dam/p/<project gid>/info/<storage pathname>

Requires JWT.

Get info for an asset.

This info is stored with the asset, so you can get it quickly from the /api calls. This method exists so we can use it internally for the assets.

GET Request

GET /dam/p/<project gid>/info/<storage pathname>
Authorization: Bearer <JWT>

storage pathname is the storage path name to the asset - not related to the path name as used in the assets data.

The current implementation uses a gid-based filename with versioning. As an example, we have an svg file in /vector/example.svg, with gid eddbe3b0-eb6a-4301-9700-c770df127456 and version 31. The pathname will be eddbe3b0-eb6a-4301-9700-c770df127456~31.svg.

Success response

Note: unlike /api calls, a /dam call NEVER refreshes the JWT

{
    "success": true,
    "result": {
        "format": "svg",
        "filesize": 1192,
        "pages": 1,
        "width": 333,
        "height": 333,
        "resolution": [300.0, 300.0],
        "transparent": true,
        "animated": false,
        "colors": "truecolormatte",
        "colorspace": "srgb",
        "metadata": {
            "date:create": "2020-10-23T09:17:38+02:00",
            "date:modify": "2020-10-23T09:17:38+02:00"
        }
    },
    "data": {}
}

result

format file format, matches extension
filesize in bytes
pages number of pages in the document, e.g. pdf or frames of an animated gif
width in pixels
height in pixels
resolution [width, height] in dpi
transparent true | false
animated true | false
colors e.g. truecolor or greyscale
colorspace e.g. srgb or cmyk
metadata meta data embedded in the file

Error responses

400 Bad request - missing parameters or wrong type or value
401 Permission denied - missing or expired JWT
403 Forbidden - not a member of this project
422 Unprocessable entity - asset or parent asset doesn't exist