Unicat API Reference

/api/p/<project gid>/definitions/delete

Requires JWT

Deletes a definition if it's not in use.

If a definition is used by a record or by another definition, it cannot be deleted. You must break those relationships first.

Note: you cannot delete an extended definition that's in use (use revert on the record's definition).

Request

POST /api/p/<project gid>/definitions/delete
Authorization: Bearer <JWT>

{
    "definition": "<definition gid>"
}

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {},
    "data": {}
}

Error response

401 Unauthorized - missing or expired JWT
403 Forbidden - not a member of the project
422 Unprocessable Entity - definition is in use

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer realm="JWT access to Unicat."

{
    "success": false,
    "data": null,
    "error": {
        "code": 401,
        "message": "Permission denied",
        "info": {}
    }
}

HTTP/1.1 403 Forbidden

{
    "success": false,
    "result": {
        "code": 403,
        "message": "Forbidden",
        "info": {}
    },
    "data": {}
}