Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/classes/metadata/clear

Requires JWT

Remove a metadata field from a class.

If the metadata field name wasn't set on this class, the class is returned unchanged.

Request

POST /api/p/<project gid>/classes/metadata/clear
Authorization: Bearer <JWT>

{
    "class": "<class gid>",
    "name": "group.code",
}

class gid of the class to remove the metadata field from
name name for the metadata field

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "class": "<class gid>"
    },
    "data": {
        "classes": {
            "<class gid>": {…}
        },
        "layouts": {
            …
        }
    }
}

result

class the class with the metadata field removed - this is usually a working copy.

data

classes Class info with name, fields, metadata.
layouts Layout info with hierarchy, if the layout changed to a working copy.

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 - can't work with this item