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
...There may be other properties for specific use by the Wordbee Translator system*

 

EXAMPLES

Calling /list/querieslayouts may return:

Code Block
{{
 	{ 		"default": {
			
    "origin": "System",
    "Userid": null,
			
    "name": "UserSystem default",
			"query": ""
		},
		"userpresets": [{
			"origin": "User",
			"name": "My query",
			"query": "{status} = 1 AND {locked} = false"
		},
		],
		"systempresets": []
	}

    "fields": [
      {
        "id": "id",
        "name": "ID",
        "desc": "The globally unique string ID of the job, such as 'c2002' or 's773'",
        "type": "String",
        "isdata": true,
        "iscol": true,
        "iscoldef": true,
        "canquery": true,
        "cansort": true,
        "width": null
      },
      {
        "id": "oreference",
        "name": "Order ref",
        "desc": "",
        "type": "String",
        "isdata": false,
        "iscol": true,
        "iscoldef": true,
        "canquery": true,
        "cansort": true,
        "width": null
      }
    ],
    "rows": 20
  },
  "userpresets": [],
  "systempresets": [
    {
      "origin": "System",
      "id": null,
      "name": "System default",
      "fields": [
        {
          "id": "id",
          "name": "ID",
          "desc": "The globally unique string ID of the job, such as 'c2002' or 's773'",
          "type": "String",
          "isdata": true,
          "iscol": true,
          "iscoldef": true,
          "canquery": true,
          "cansort": true,
          "width": null
        },
        {
          "id": "oreference",
          "name": "Order ref",
          "desc": "",
          "type": "String",
          "isdata": false,
          "iscol": true,
          "iscoldef": true,
          "canquery": true,
          "cansort": true,
          "width": null
        }
      ],
      "rows": 20
    }
  ]
}}