Unicat API Reference

Up - API Reference - Home

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

Requires JWT

Commit a definition.

We used a copy to keep track of the changes; now we need to apply those changes to the original, and remove the copy.

Afterwards, the definition is no longer a working copy. All places where this definition is used will now work with the newly committed definition - this includes records that use this definition and now have new or removed fields.

Note: record data can be lost if you commit a definition!

The accompanying layout is committed too.

Note: you cannot commit an extended definition

Request

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

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

definition the definition to commit

Success response

Authorization: <JWT>

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

result

definition the definition is no longer a working copy.

data

definitions Definition info with name, classes, fields.
layouts Layout info with hierarchy, for the committed 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