Below are the endpoints you currently have access to based on your roles.
Per controller the available actions are listed. You'll see the endpoint to send a HTTPS request to. If
available, a short textual description is provided. Also, the return type is shown.
Controllers and endpoints might be added, removed or changed.
To copy the OpenAPI text to your clipboard left-click the text.
Most endpoints require input. All input and output is JSON encoded, unless mentioned otherwise. What JSON properties to send to the endpoint is listed as well.
Per attribute you'll see an array describing the value. The first value is the default value used if no value is supplied in your input. The second value in the array describes the type of input. Available types are:
|FILTER_VALIDATE_INT||Requires input to be an integer.|
|FILTER_VALIDATE_NULLABLE_INT||Requires input to be an integer, or NULL.|
|FILTER_VALIDATE_DECIMAL||Requires input to be an decimal.|
|FILTER_VALIDATE_NULLABLE_DECIMAL||Requires input to be an decimal, or NULL.|
|FILTER_VALIDATE_HEX||Requires input to be hexadecimal (with or without 0x).|
|FILTER_VALIDATE_NULLABLE_HEX||Requires input to be hexadecimal (with or without 0x), or NULL.|
|FILTER_VALIDATE_DATE||Requires input to be a date in YYYY-MM-DD HH:MM:SS format.|
|FILTER_VALIDATE_TIME||Requires input to be a time in HH:MM:SS format.|
|FILTER_VALIDATE_DATETIME||Requires input to be a date in YYYY-MM-DD format.|
|FILTER_VALIDATE_BOOLEAN||Requires input to be a boolean. 0/1 yes/no is allowed.|
|FILTER_VALIDATE_EMPTY_BOOLEAN||Requires input to be a boolean. 0/1 yes/no is allowed. Can also be NULL|
|FILTER_VALIDATE_EMPTY_STRING||Requires input to be a string, may be an empty one or NULL.|
|FILTER_VALIDATE_NON_EMPTY_STRING||Requires input to be a string, must have a value.|
|FILTER_VALIDATE_INT_ARRAY||Requires input to be an array of integers, could be an empty one.|
|FILTER_VALIDATE_NON_EMPTY_INT_ARRAY||Requires input to be an array of integers, must have at least one value.|
|FILTER_VALIDATE_STRING_ARRAY||Requires input to be an array of strings, could be an empty one.|
|FILTER_VALIDATE_OBJECT||Requires input to be an object. A third value in the array is supplied describing what the object must look like.|
|FILTER_VALIDATE_OBJECT_ARRAY||Requires input to be an array of objects. A third value in the array is supplied describing what every object must look like.|
When using lists, you can search rather specific for your desired items. Below are the rules: