Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/records/definition/fieldlists/fields/remove

Requires JWT.

Remove a field from the record's definition's fieldlist.

Afterwards, the record's definition is a working copy (if it wasn't already).

Request

POST /api/p/<project gid>/records/definition/fieldlists/fields/remove
Authorization: Bearer <JWT>

{
    "record": "<record gid>",
    "fieldlist": "<fieldlist key>",
    "field": "<field gid>",
}

record the record's gid
fieldlist the fieldlist to remove the field from
field the field to remove

optional

language return data for this (project) language.
languages return data for these (project) languages.

If you request language and/or languages, you get the records' title and fields for the combined set. If you request neither, you'll get all available languages.

Success response

Authorization: <JWT>

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

result

record the record.
definition the record's definition is (now) a working copy.

data

definitions Definition info with name, classes, fields.
records Record info with hierarchy, definition, field values.
layouts Layout info with hierarchy, for the returned definition.

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