ATTENTION

You're browsing the documentation for an development version of froxlor.
The current stable version's documentation can be found here.

Cronjobs

Cronjobs.add

You cannot add new cronjobs yet.

Cronjobs.get

return a cronjob entry by id

Permission

admin

Parameter

FieldTypeDescription
idintcronjob-id

Response

string as json-encoded array

Cronjobs.update

update a cronjob entry by given id

Permission

admin

Parameter

FieldTypeDescription
idint
isactivebooloptional whether the cronjob is active or not
interval_valueintoptional number of seconds/minutes/hours/etc. for the interval
interval_intervalstringoptional interval for the cronjob (MINUTE, HOUR, DAY, WEEK or MONTH)

Response

string as json-encoded array

Cronjobs.listing

lists all cronjob entries

Permission

admin

Parameter

FieldTypeDescription
sql_searcharrayoptional array with index = fieldname, and value = array with 'op' => operator (one of <, > or =),LIKE is used if left empty and 'value' => searchvalue
sql_limitintoptional specify number of results to be returned
sql_offsetintoptional specify offset for resultset
sql_orderbyarrayoptional array with index = fieldname and value = ASC|DESC to order the resultset by one or morefields

Response

string as json-encoded array count|list

Cronjobs.listingCount

returns the total number of cronjobs

Permission

admin

Response

string as json-encoded response message

Cronjobs.delete

You cannot delete system cronjobs.