Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

URL

Description

(GET) list/layouts

Gets a list of all layouts. This is an object with properties:

  • default: Object with the user's default layout.
  • userpresets: An array of user layouts. If the user has not saved any presets, the array is empty.
  • systempresets: An array of predefined and commonly used layouts. Empty if none available.

 

(PUT) list/layouts/userpresets

Sets a list of user layouts. Include the JSON array in the HTTP BODY.

To clear all presets, set an empty array.

 

(GET) list/layouts/default

Gets the user's default layout.

 

(PUT) list/layouts/default

Sets the user's default layout. Include the query object in the HTTP BODY.

If the body is empty, the system restores the user default to the system default.

 

 

PRESET OBJECT

LAYOUTOBJECT

A preset layout object has these properties:

origin

Describes who created the layout:

  • SystemDefault: The system default.
  • UserDefault: The user's default query.
  • User: A user preset saved with a name.

 

string
nameThe name of the layout.stringquery

The query string. Not null. An empty string means that no filter will be applied.

See Query language

stringfields

Array of fields to be included in the layout. Each element has these properties:

  • id: The field ID.
  • width: A string with the preferred width.

See ./list/fields to get a list of all available fields.

object[]
rowsRows to show per pageint
...There may be other properties for specific use by the Wordbee Translator system*

 

EXAMPLES

Calling /list/queries may return:

...