KAS API Dokumentation
Back to top  

Functions

Anlegen eines Cronjobs

add_cronjob(array $parameter) 
link Beispiel
deprecated 2020-11-12: typo error mail_adress, use mail_address

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • protocol: Cronjob Protokoll: http|https
  • http_url: die Cronjob-URL
  • cronjob_comment: der Cronjobkommentar
  • minute: die ausführende Minute: */1-59|0-59|*
  • hour: die ausführende Stunde: */1-23|1-23|*
  • day_of_month: der ausführende Tag des Monats: 0-31|*
  • month: der ausführende Monat: *
  • day_of_week: der ausführende Wochentag: 0-7|* (Sonntag =0 oder =7)
  • http_user: der HTTP-Auth Benutzer (optional)
  • http_password: das HTTP-Auth Passwort (optional)
  • mail_address: die Mailadresse, welche die Bestätigungsmail erhält: RFC2822 (optional)
  • mail_condition: Bedingungswort: erscheint dieses in der Scriptausgab, so wird _keine_ E-Mail versendet (optional)
  • mail_subject: verwende cronjob_comment als E-Mail-Subject: default|comment (optional, default)
  • is_active: der Cronjob ist aktiv: Y|N (optional, default Y)

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\couldnt_get_kas_ressources
\day_of_month_or_day_of_week_incorrect
\day_of_month_syntax_incorrect
\day_of_week_syntax_incorrect
\hour_syntax_incorrect
\http_password_syntax_incorrect
\protocol_syntax_incorrect
\http_url_syntax_incorrect
\http_user_syntax_incorrect
\is_active_syntax_incorrect
\mail_address_syntax_incorrect
\mail_condition_syntax_incorrect
\max_cronjobs_reached
\minute_syntax_incorrect
\month_syntax_incorrect
\time_not_allowed

Löschen eines Cronjobs

delete_cronjob(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • cronjob_id: die zu löschende Cronjob ID, siehe get_cronjobs

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\cronjob_id_not_found
\cronjob_id_syntax_incorrect

Auslesen der Cronjobs

get_cronjobs(array $parameter) 
link Beispiel

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • cronjob_id: die ID des Cronjobs (optional)

Exceptions

\array_return Array der Cronjobs

Bearbeiten eines Cronjobs

update_cronjob(array $parameter) 
link Beispiel
deprecated 2020-11-12: typo error mail_adress, use mail_address

Parameters

$parameter

array

folgende Parameter sind möglich:

  • kas_login: das betreffende KAS Login
  • kas_auth_data: die Authentifizierungsdaten
  • kas_auth_type: der Authentifizierungstyp
  • cronjob_id: die zu bearbeitende Cronjob-ID
  • protocol: Cronjob Protokoll: http|https (optional
  • http_url: die Cronjob-URL (optional)
  • cronjob_comment: der Cronjobkommentar (optional)
  • minute: die ausführende Minute: */1-59|0-59|* (optional)
  • hour: die ausführende Stunde: */1-23|1-23|* (optional)
  • day_of_month: der ausführende Tag des Monats: 0-31|* (optional)
  • month: der ausführende Monat: * (optional)
  • day_of_week: der ausführende Wochentag: 0-7|* (Sonntag =0 oder =7, optional)
  • http_user: der HTTP-Auth Benutzer (optional)
  • http_password: das HTTP-Auth Passwort (optional)
  • mail_address: die Mailadresse, welche die Bestätigungsmail erhält: RFC2822 (optional)
  • mail_condition: Bedingungswort: erscheint dieses in der Scriptausgab, so wird _keine_ E-Mail versendet (optional)
  • mail_subject: verwende cronjob_comment als E-Mail-Subject: default|comment (optional)
  • is_active: der Cronjob ist aktiv: Y|N (optional)

Exceptions

TRUE die Aktion wurde durchgeführt
\missing_parameter ein Pflichtparameter fehlt
\in_progress das KAS Objekt ist zZt noch in Bearbeitung
\nothing_to_do es wurde nichts geändert
\cronjob_id_syntax_incorrect
\cronjob_not_found
\day_of_month_or_day_of_week_incorrect
\day_of_month_syntax_incorrect
\day_of_week_syntax_incorrect
\hour_syntax_incorrect
\http_password_syntax_incorrect
\protocol_syntax_incorrect
\http_url_syntax_incorrect
\http_user_syntax_incorrect
\is_active_syntax_incorrect
\mail_address_syntax_incorrect
\mail_condition_syntax_incorrect
\minute_syntax_incorrect
\month_syntax_incorrect
\time_not_allowed