Up - API Reference - Home
Requires JWT
Move a component inside a definition's layout.
You can only change the layout if you have extended the definition.
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.
POST /api/p/<project gid>/records/definition/layouts/components/move
Authorization: Bearer <JWT>
{
"record": "<record gid>",
"component": "<component gid>",
"parent": "<component gid>",
"before_component": "<component gid>"
}
record the record's gid
component gid of the component that is moved
parent move the component to this parent
before_component the component is moved before this component
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.
Authorization: <JWT>
{
"success": true,
"result": {
"record": "<record gid>",
"definition": "<definition gid>",
"layout": "<layout gid>"
},
"data": {
"records": {
"<record gid>": {
"gid": "<record gid>",
"definition": "<definition gid>",
…
}
},
"definitions": {
"<definition gid>": {
"gid": "<definition gid>",
…
}
},
"layouts": {
"<layout gid>": {
"gid": "<layout gid>",
…
}
},
}
}
record the record.
definition the record's definition is (now) a working copy.
layout the layout is (now) a working copy.
records Record info with hierarchy, definition, field values.
definitions Definition info with name, classes, fields, and layout.
layouts Layout info with hierarchy.
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