Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/definitions/layouts/components/move

Requires JWT

Move a component inside a definition's layout.

If the parent component doesn't exist or doesn't accept children, you'll get an error.

If you don't specify before_component (or the specified component isn't in the layout or a child of the given parent), the new component is added at the end.

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

Request

POST /api/p/<project gid>/definitions/layouts/components/move
Authorization: Bearer <JWT>

{
    "definition": "<definition gid>",
    "component": "<component gid>",
    "parent": "<component gid>",
    "before_component": "<component gid>"
}

definition gid of the definition to update the layout for
component gid of the component that is moved
parent move the component to this parent

optional

before_component the component is moved before this component

Success response

Authorization: <JWT>

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

result

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

data

definitions Definition info with name, classes, fields, and layout, also includes the original definition 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