Versions Compared

Key

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

...

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.string
fields

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
aggid

Optional aggregation to include with query results.

See ./list/aggregations on available aggregations.

You can also include this property individually with each query: ./list

string?
...There may be other properties for specific use by the Wordbee Translator system*

 

EXAMPLES

Calling /list/querieslayouts may return:

Code Block
{{
	{  		"default": {
			
    "origin": "UserSystem",
			
    "id": null,
    "name": "User default",
			"query": ""
		},
		System default",
    "fields": [
      {
        "id": "id",
        "width": null
      },
      {
        "id": "oreference",
        "width": null
      }
    ],
    "rows": 20
  },
  "userpresets": [],
  "systempresets": [
    {
			
      "origin": "User",
			"System",
      "id": null,
      "name": "MySystem querydefault",
			"query": "{status} = 1 AND {locked} = false"
		},
		],
		"systempresets": []
	}

      "fields": [
        {
          "id": "id",
          "width": null
        },
        {
          "id": "oreference",
          "width": null
        }
      ],
      "rows": 20
    }
  ]
}}