Unicat API Reference

/api/p/<project gid>/classes/layouts/components/modify

Requires JWT

Modify a component in a class' layout.

Request

POST /api/p/<project gid>/classes/layouts/components/modify
Authorization: Bearer <JWT>

{
    "class": "<class gid>",
    "component": "<component gid>",
    "name": "optional component name",
    "type": "field",
    "options": {"field": "<field gid>", "style": "title"}
}

class gid of the class to update the layout for
component gid of the component that is modified

optional

The following are all optional, but at least one must be provided.

name the name of the component
type the type of component
options some types need extra options

See layouts for types and options for components

Success response

Authorization: <JWT>

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

result

class the class with the changed layout - this is a working copy.
layout the layout is (now) a working copy.

data

classes Class info with name, fields, and layout, also includes the original class if it changed to a working copy.
layouts Layout info with hierarchy, also includes the original layout if it 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