GET /api/job_templates
List job templates

GET /api/locations/:location_id/job_templates
List job templates per location

GET /api/organizations/:organization_id/job_templates
List job templates per organization

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

search
opcjonalny

rezultat filtrowania

Validations:

  • Must be a String

order
opcjonalny

rezultat sortowania

Validations:

  • Must be a String

page
opcjonalny

rezultat paginacji

Validations:

  • Must be a String

per_page
opcjonalny

Liczba wpisów na jedno żądanie

Validations:

  • Must be a String


POST /api/job_templates/import
Import a job template from ERB

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

template
wymagany

Template ERB

Validations:

  • Must be a String

overwrite
opcjonalny

Overwrite template if it already exists

Validations:

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


GET /api/job_templates/:id/export
Export a job template to ERB

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

id
wymagany

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
Show job template details

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

id
wymagany

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
Create a job template

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

job_template
wymagany

Validations:

  • Must be a Hash

job_template[name]
wymagany

Template name

Validations:

  • Must be a String

job_template[job_category]
wymagany

Job category

Validations:

  • Must be a String

job_template[description_format]
opcjonalny , nil dopuszczalny

This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.

Validations:

  • Must be a String

job_template[template]
wymagany

Validations:

  • Must be a String

job_template[provider_type]
wymagany

Provider type

Validations:

  • Must be one of: SSH.

job_template[snippet]
opcjonalny , nil dopuszczalny

Validations:

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

job_template[audit_comment]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

job_template[locked]
opcjonalny , nil dopuszczalny

Czy szablon jest zablokowany do edycji

Validations:

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

job_template[ssh]
opcjonalny , nil dopuszczalny

SSH provider specific options

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
opcjonalny , nil dopuszczalny

Effective user options

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
opcjonalny , nil dopuszczalny

What user should be used to run the script (using sudo-like mechanisms)

Validations:

  • Must be a String

job_template[ssh][effective_user][overridable]
opcjonalny , nil dopuszczalny

Whether it should be allowed to override the effective user from the invocation form.

Validations:

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

job_template[ssh][effective_user][current_user]
opcjonalny , nil dopuszczalny

Whether the current user login should be used as the effective user

Validations:

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

job_template[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type

job_template[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type


PUT /api/job_templates/:id
Update a job template

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

id
wymagany

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
wymagany

Validations:

  • Must be a Hash

job_template[name]
opcjonalny

Template name

Validations:

  • Must be a String

job_template[job_category]
opcjonalny

Job category

Validations:

  • Must be a String

job_template[description_format]
opcjonalny , nil dopuszczalny

This template is used to generate the description. Input values can be used using the syntax %{package}. You may also include the job category and template name using %{job_category} and %{template_name}.

Validations:

  • Must be a String

job_template[template]
opcjonalny

Validations:

  • Must be a String

job_template[provider_type]
opcjonalny

Provider type

Validations:

  • Must be one of: SSH.

job_template[snippet]
opcjonalny , nil dopuszczalny

Validations:

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

job_template[audit_comment]
opcjonalny , nil dopuszczalny

Validations:

  • Must be a String

job_template[locked]
opcjonalny , nil dopuszczalny

Czy szablon jest zablokowany do edycji

Validations:

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

job_template[ssh]
opcjonalny , nil dopuszczalny

SSH provider specific options

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
opcjonalny , nil dopuszczalny

Effective user options

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
opcjonalny , nil dopuszczalny

What user should be used to run the script (using sudo-like mechanisms)

Validations:

  • Must be a String

job_template[ssh][effective_user][overridable]
opcjonalny , nil dopuszczalny

Whether it should be allowed to override the effective user from the invocation form.

Validations:

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

job_template[ssh][effective_user][current_user]
opcjonalny , nil dopuszczalny

Whether the current user login should be used as the effective user

Validations:

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

job_template[location_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ lokalizacje o podanym id

Validations:

  • Must be an array of any type

job_template[organization_ids]
opcjonalny , nil dopuszczalny

ZMIEŃ organizacje o podanym id

Validations:

  • Must be an array of any type


GET /api/job_templates/revision

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

version
opcjonalny

Template version

Validations:

  • Must be a String


DELETE /api/job_templates/:id
Delete a job template

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

id
wymagany

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
Sklonuj dostarczony szablon

Parametry

Nazwa parametru Opis
location_id
opcjonalny

Zakres w zależności od lokalizacji

Validations:

  • Must be a Integer

organization_id
opcjonalny

Zakres w zależności od organizacji

Validations:

  • Must be a Integer

id
wymagany

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
wymagany

Validations:

  • Must be a Hash

job_template[name]
wymagany

Template name

Validations:

  • Must be a String