Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/definitions/fields/remove

Requires JWT

Remove a field from a definition.

Note: you cannot modify an extended definition (use the records/definition api).

Request

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

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

definition gid of the definition that holds the field
field gid of the field that is removed

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "definition": "<definition gid>"
    },
    "data": {
        "definitions": {
            "<definition gid>": {…}
        },
        "layouts": {
            …
        }
    }
}

result

definition the definition with the removed field - this is a working copy.

data

definitions Definition info with name, classes, fields.
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