Unicat API Reference

Up - API Reference - Home

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

Requires JWT

Get one or more modules.

Request

You get a module either by specifying the name in module or modules.

If you provide both module and modules parameters, we use parameter matching to guess what you meant. The first action that matches the parameters is performed, the rest is ignored. Parameter matching happens in the order given below:

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

{
    "module": "<module name>"
}

or

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

{
    "modules": ["<module name>", …]
}

Success response

If you request a single module, you'll get a single result.

Authorization: <JWT>

{
    "success": true,
    "result": {
        "module": "Update Catalog"
    },
    "data": {
        "modules": {
            "Update Catalog": {
                …
            },
            …
        }
    }
}

If you requested multiple modules, you'll get a list of results.

Authorization: <JWT>

{
    "success": true,
    "result": {
        "modules": [
            "Import Update",
            "Update Catalog"
        ]
    },
    "data": {
        "modules": {
            "Import Update": {
                …
            },
            …
        }
    }
}

result

module the requested module, if a single module was asked for.
modules the requested modules, if multiple modules were asked for.

data

modules Module info with name, version, keys, actions, and logs.

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 - module not found