GET /api/job_templates
Job-Vorlagen auflisten

GET /api/locations/:location_id/job_templates
Job-Vorlagen pro Standort auflisten

GET /api/organizations/:organization_id/job_templates
Job-Vorlagen pro Organisation auflisten

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

search
optional

Ergebnisse filtern

Validations:

  • Must be a String

order
optional

Ergebnisse sortieren

Validations:

  • Must be a String

page
optional

Ergebnisse nummerieren

Validations:

  • Must be a String

per_page
optional

Anzahl der Einträge pro Anfrage

Validations:

  • Must be a String


POST /api/job_templates/import
Job-Vorlage aus ERB importieren

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

template
verpflichtend

Vorlage ERB

Validations:

  • Must be a String

overwrite
optional

Vorlage überschreiben, falls bereits vorhanden

Validations:

  • Must be one of: true, false, 1, 0


GET /api/job_templates/:id/export
Job-Vorlage nach ERB exportieren

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/job_templates/:id
Details der Job-Vorlage anzeigen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/job_templates
Job-Vorlage erstellen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

job_template
verpflichtend

Validations:

  • Must be a Hash

job_template[name]
verpflichtend

Vorlagenname

Validations:

  • Must be a String

job_template[job_category]
verpflichtend

Job-Kategorie

Validations:

  • Must be a String

job_template[description_format]
optional , nil erlaubt

Diese Vorlage wird für die Erstellung der Beschreibung verwendet. Eingabewerte können mittels Syntax %{package} verwendet werden. Sie können auch Job-Kategorie und Vorlagennamen über %{job_category} und %{template_name} einschließen.

Validations:

  • Must be a String

job_template[template]
verpflichtend

Validations:

  • Must be a String

job_template[provider_type]
verpflichtend

Providertyp

Validations:

  • Must be one of: SSH.

job_template[snippet]
optional , nil erlaubt

Validations:

  • Must be one of: true, false, 1, 0

job_template[audit_comment]
optional , nil erlaubt

Validations:

  • Must be a String

job_template[locked]
optional , nil erlaubt

Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht

Validations:

  • Must be one of: true, false, 1, 0

job_template[ssh]
optional , nil erlaubt

Besondere Optionen des SSH-Anbieters

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
optional , nil erlaubt

Effektive Benutzeroptionen

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
optional , nil erlaubt

Welcher Benutzer zur Ausführung des Skripts verwendet werden soll (mittels sudo-ähnlichen Mechanismen)

Validations:

  • Must be a String

job_template[ssh][effective_user][overridable]
optional , nil erlaubt

Ob es möglich sein soll, den effektiven Benutzer des Aufruf-Formulars außer Kraft zu setzen.

Validations:

  • Must be one of: true, false, 1, 0

job_template[ssh][effective_user][current_user]
optional , nil erlaubt

Ob das aktuelle Login als effektiver Benutzer verwendet werden soll

Validations:

  • Must be one of: true, false, 1, 0

job_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

job_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


PUT /api/job_templates/:id
Job-Vorlage aktualisieren

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

job_template
verpflichtend

Validations:

  • Must be a Hash

job_template[name]
optional

Vorlagenname

Validations:

  • Must be a String

job_template[job_category]
optional

Job-Kategorie

Validations:

  • Must be a String

job_template[description_format]
optional , nil erlaubt

Diese Vorlage wird für die Erstellung der Beschreibung verwendet. Eingabewerte können mittels Syntax %{package} verwendet werden. Sie können auch Job-Kategorie und Vorlagennamen über %{job_category} und %{template_name} einschließen.

Validations:

  • Must be a String

job_template[template]
optional

Validations:

  • Must be a String

job_template[provider_type]
optional

Providertyp

Validations:

  • Must be one of: SSH.

job_template[snippet]
optional , nil erlaubt

Validations:

  • Must be one of: true, false, 1, 0

job_template[audit_comment]
optional , nil erlaubt

Validations:

  • Must be a String

job_template[locked]
optional , nil erlaubt

Ob die Vorlage für die Bearbeitung gesperrt ist oder nicht

Validations:

  • Must be one of: true, false, 1, 0

job_template[ssh]
optional , nil erlaubt

Besondere Optionen des SSH-Anbieters

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
optional , nil erlaubt

Effektive Benutzeroptionen

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
optional , nil erlaubt

Welcher Benutzer zur Ausführung des Skripts verwendet werden soll (mittels sudo-ähnlichen Mechanismen)

Validations:

  • Must be a String

job_template[ssh][effective_user][overridable]
optional , nil erlaubt

Ob es möglich sein soll, den effektiven Benutzer des Aufruf-Formulars außer Kraft zu setzen.

Validations:

  • Must be one of: true, false, 1, 0

job_template[ssh][effective_user][current_user]
optional , nil erlaubt

Ob das aktuelle Login als effektiver Benutzer verwendet werden soll

Validations:

  • Must be one of: true, false, 1, 0

job_template[location_ids]
optional , nil erlaubt

Standorte durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type

job_template[organization_ids]
optional , nil erlaubt

Organisationen durch angegebene Kennungen ERSETZEN

Validations:

  • Must be an array of any type


GET /api/job_templates/revision

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

version
optional

Vorlagenversion

Validations:

  • Must be a String


DELETE /api/job_templates/:id
Job-Vorlage löschen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/job_templates/:id/clone
Bereitstellungsvorlage klonen

Parameter

Parametername Beschreibung
location_id
optional

Scope nach Standorten

Validations:

  • Must be a Integer

organization_id
optional

Scope nach Organisationen

Validations:

  • Must be a Integer

id
verpflichtend

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

job_template
verpflichtend

Validations:

  • Must be a Hash

job_template[name]
verpflichtend

Vorlagenname

Validations:

  • Must be a String