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

Params

Param Name Description
location_id
Optional

Tri par emplacement

Validations:

  • Must be Integer

organization_id
Optional

Tri par organisation

Validations:

  • Must be Integer

search
Optional

filtrer les résultats

Validations:

  • Must be String

order
Optional

trier les resultats

Validations:

  • Must be String

page
Optional

paginer les résultats

Validations:

  • Must be String

per_page
Optional

nombre d'entier par requête

Validations:

  • Must be String


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

Params

Param Name Description
template
Required

Modèle ERB

Validations:

  • Must be String

overwrite
Optional

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'


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

Params

Param Name Description
id
Required

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

Params

Param Name Description
id
Required

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

Params

Param Name Description
job_template
Required

Validations:

  • Must be a Hash

job_template[name]
Required

Nom de modèle

Validations:

  • Must be String

job_template[job_category]
Required

Catégorie du job

Validations:

  • Must be String

job_template[description_format]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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 String

job_template[template]
Required

Validations:

  • Must be String

job_template[provider_type]
Required

Type de fournisseur

Validations:

  • Must be one of: SSH.

job_template[snippet]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'

job_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

job_template[locked]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Indique si le modèle peut être modifié

Validations:

  • Must be 'true' or 'false' or '1' or '0'

job_template[ssh]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Options spécifiques au fournisseur SSH

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Options pour l'utilisateur effectif

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

job_template[ssh][effective_user][overridable]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

job_template[ssh][effective_user][current_user]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

job_template[location_ids]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

job_template[organization_ids]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

Params

Param Name Description
id
Required

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
Required

Validations:

  • Must be a Hash

job_template[name]
Optional

Nom de modèle

Validations:

  • Must be String

job_template[job_category]
Optional

Catégorie du job

Validations:

  • Must be String

job_template[description_format]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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 String

job_template[template]
Optional

Validations:

  • Must be String

job_template[provider_type]
Optional

Type de fournisseur

Validations:

  • Must be one of: SSH.

job_template[snippet]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be 'true' or 'false' or '1' or '0'

job_template[audit_comment]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Validations:

  • Must be String

job_template[locked]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Indique si le modèle peut être modifié

Validations:

  • Must be 'true' or 'false' or '1' or '0'

job_template[ssh]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Options spécifiques au fournisseur SSH

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

Options pour l'utilisateur effectif

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be String

job_template[ssh][effective_user][overridable]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

job_template[ssh][effective_user][current_user]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

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

Validations:

  • Must be 'true' or 'false' or '1' or '0'

job_template[location_ids]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

REMPLACER les emplacements qui ont les ID suivant

Validations:

  • Must be an array of any type

job_template[organization_ids]
Optional , <span class="translation_missing" title="translation missing: fr.apipie.nil_allowed">Nil Allowed</span>

REMPLACER les organisations qui ont les ID suivant

Validations:

  • Must be an array of any type


GET /api/job_templates/revision

Params

Param Name Description
version
Optional

Version de modèle

Validations:

  • Must be String


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

Params

Param Name Description
id
Required

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

Params

Param Name Description
id
Required

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
Required

Validations:

  • Must be a Hash

job_template[name]
Required

Nom de modèle

Validations:

  • Must be String