Unicat API Reference

Up - API Reference - Home

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

Requires JWT

Add a field to a definition.

If you don't specify before_field (or the specified field isn't in the definition), the new field is added at the end.

Note: you cannot add working copies of fields, only committed fields can be added.

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

Request

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

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

definition gid of the definition to add the field to
field gid of the field that is added

optional

before_field the added field is put before this field

Success response

Authorization: <JWT>

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

result

definition the definition with the added 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