GET /api/job_templates
Afficher les modèles de job

GET /api/locations/:location_id/job_templates
Afficher les modèles de job par emplacement

GET /api/organizations/:organization_id/job_templates
Afficher les modèles de job par organisation

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

search
optionel

filtrer les résultats

Validations:

  • Must be a String

order
optionel

trier les resultats

Validations:

  • Must be a String

page
optionel

paginer les résultats

Validations:

  • Must be a String

per_page
optionel

nombre d'entier par requête

Validations:

  • Must be a String


POST /api/job_templates/import
Importe un modèle de job depuis ERB

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

template
requis

Modèle ERB

Validations:

  • Must be a String

overwrite
optionel

Remplace le modèle si il existe déjà

Validations:

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


GET /api/job_templates/:id/export
Exporte un modèle de job vers ERB

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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
Voir les détails d'un modèle de job

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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
Créer un modèle de job

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

job_template
requis

Validations:

  • Must be a Hash

job_template[name]
requis

Nom de modèle

Validations:

  • Must be a String

job_template[job_category]
requis

Catégorie du job

Validations:

  • Must be a String

job_template[description_format]
optionel , nil autorisé

Ce modèle est utilisé pour générer la description. Les valeurs d'entrée peuvent être utilisées avec la syntaxe %{package}. Vous pouvez aussi inclure la catégorie du job et le nom du modèle avec %{job_category} et %{template_name}.

Validations:

  • Must be a String

job_template[template]
requis

Validations:

  • Must be a String

job_template[provider_type]
requis

Type de fournisseur

Validations:

  • Must be one of: SSH.

job_template[snippet]
optionel , nil autorisé

Validations:

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

job_template[audit_comment]
optionel , nil autorisé

Validations:

  • Must be a String

job_template[locked]
optionel , nil autorisé

Indique si le modèle peut être modifié

Validations:

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

job_template[ssh]
optionel , nil autorisé

Options spécifiques au fournisseur SSH

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
optionel , nil autorisé

Options pour l'utilisateur effectif

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
optionel , nil autorisé

Ce que l'utilisateur devrait utiliser pour lancer le script (comme des mécanismes sudo)

Validations:

  • Must be a String

job_template[ssh][effective_user][overridable]
optionel , nil autorisé

Défini s'il est permis de remplacer l'utilisateur effectif depuis formulaire de lancement.

Validations:

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

job_template[ssh][effective_user][current_user]
optionel , nil autorisé

indique si l'utilisateur actuel doit être utilisé comme utilisateur effectif

Validations:

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

job_template[location_ids]
optionel , nil autorisé

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

job_template[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type


PUT /api/job_templates/:id
Mise à jour d'un modèle de job

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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
requis

Validations:

  • Must be a Hash

job_template[name]
optionel

Nom de modèle

Validations:

  • Must be a String

job_template[job_category]
optionel

Catégorie du job

Validations:

  • Must be a String

job_template[description_format]
optionel , nil autorisé

Ce modèle est utilisé pour générer la description. Les valeurs d'entrée peuvent être utilisées avec la syntaxe %{package}. Vous pouvez aussi inclure la catégorie du job et le nom du modèle avec %{job_category} et %{template_name}.

Validations:

  • Must be a String

job_template[template]
optionel

Validations:

  • Must be a String

job_template[provider_type]
optionel

Type de fournisseur

Validations:

  • Must be one of: SSH.

job_template[snippet]
optionel , nil autorisé

Validations:

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

job_template[audit_comment]
optionel , nil autorisé

Validations:

  • Must be a String

job_template[locked]
optionel , nil autorisé

Indique si le modèle peut être modifié

Validations:

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

job_template[ssh]
optionel , nil autorisé

Options spécifiques au fournisseur SSH

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
optionel , nil autorisé

Options pour l'utilisateur effectif

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
optionel , nil autorisé

Ce que l'utilisateur devrait utiliser pour lancer le script (comme des mécanismes sudo)

Validations:

  • Must be a String

job_template[ssh][effective_user][overridable]
optionel , nil autorisé

Défini s'il est permis de remplacer l'utilisateur effectif depuis formulaire de lancement.

Validations:

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

job_template[ssh][effective_user][current_user]
optionel , nil autorisé

indique si l'utilisateur actuel doit être utilisé comme utilisateur effectif

Validations:

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

job_template[location_ids]
optionel , nil autorisé

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

job_template[organization_ids]
optionel , nil autorisé

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type


GET /api/job_templates/revision

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

version
optionel

Version de modèle

Validations:

  • Must be a String


DELETE /api/job_templates/:id
Supprimer un modèle de job

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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
Cloner un modèle de provisioning

Paramètres

Nom du paramètre Description
location_id
optionel

Tri par emplacement

Validations:

  • Must be a Integer

organization_id
optionel

Tri par organisation

Validations:

  • Must be a Integer

id
requis

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
requis

Validations:

  • Must be a Hash

job_template[name]
requis

Nom de modèle

Validations:

  • Must be a String