Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/modules/register

Requires JWT

Register a module with a version number.

If the module is already registered, the version number is updated if it's newer. If you try to register an older version, you'll get an error.

A successful registration automatically adds a log item.

Request

POST /api/p/<project gid>/modules/register
Authorization: Bearer <JWT>

{
    "module": "Update Catalog",
    "version": "1.0.11",
}

module name of the module to register
version version of the module, in 1.1.1 format

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "module": "<module name>"
    },
    "data": {
        "modules": {
            "<module name>": {…}
        }
    }
}

result

module the name of the registered module.

data

modules Module info with name and version.

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
422 Unprocessable entity - newer version of module found