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

Параметры

Имя параметра Описание
search
необязательно

отфильтровать результаты


Value:

Must be String

order
необязательно

отсортировать результаты


Value:

Must be String

page
необязательно

разместить результат на нескольких страницах


Value:

Must be String

per_page
необязательно

количество записей на запрос


Value:

Must be String


GET /api/job_templates/:id
Show job template details

Параметры

Имя параметра Описание
id
обязательно

Value:

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

Параметры

Имя параметра Описание
job_template
обязательно

Value:

Must be a Hash

job_template[name]
обязательно

Template name


Value:

Must be String

job_template[job_category]
обязательно

Job category


Value:

Must be String

job_template[description_format]
необязательно , nil разрешен

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}.


Value:

Must be String

job_template[template]
обязательно

Value:

Must be String

job_template[provider_type]
обязательно

Provider type


Value:

Must be one of: SSH.

job_template[snippet]
необязательно , nil разрешен

Value:

Must be ‘true’ or ‘false’

job_template[audit_comment]
необязательно , nil разрешен

Value:

Must be String

job_template[locked]
необязательно , nil разрешен

Заблокирован ли шаблон для редактирования


Value:

Must be ‘true’ or ‘false’

job_template[ssh]
необязательно , nil разрешен

SSH provider specific options


Value:

Must be a Hash

job_template[ssh][effective_user]
необязательно , nil разрешен

Effective user options


Value:

Must be a Hash

job_template[ssh][effective_user][value]
необязательно , nil разрешен

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


Value:

Must be String

job_template[ssh][effective_user][overridable]
необязательно , nil разрешен

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


Value:

Must be ‘true’ or ‘false’

job_template[ssh][effective_user][current_user]
необязательно , nil разрешен

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


Value:

Must be ‘true’ or ‘false’


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

Параметры

Имя параметра Описание
id
обязательно

Value:

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
обязательно

Value:

Must be a Hash

job_template[name]
необязательно

Template name


Value:

Must be String

job_template[job_category]
необязательно

Job category


Value:

Must be String

job_template[description_format]
необязательно , nil разрешен

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}.


Value:

Must be String

job_template[template]
необязательно

Value:

Must be String

job_template[provider_type]
необязательно

Provider type


Value:

Must be one of: SSH.

job_template[snippet]
необязательно , nil разрешен

Value:

Must be ‘true’ or ‘false’

job_template[audit_comment]
необязательно , nil разрешен

Value:

Must be String

job_template[locked]
необязательно , nil разрешен

Заблокирован ли шаблон для редактирования


Value:

Must be ‘true’ or ‘false’

job_template[ssh]
необязательно , nil разрешен

SSH provider specific options


Value:

Must be a Hash

job_template[ssh][effective_user]
необязательно , nil разрешен

Effective user options


Value:

Must be a Hash

job_template[ssh][effective_user][value]
необязательно , nil разрешен

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


Value:

Must be String

job_template[ssh][effective_user][overridable]
необязательно , nil разрешен

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


Value:

Must be ‘true’ or ‘false’

job_template[ssh][effective_user][current_user]
необязательно , nil разрешен

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


Value:

Must be ‘true’ or ‘false’


GET /api/job_templates/revision

Параметры

Имя параметра Описание
version
необязательно

Template version


Value:

Must be String


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

Параметры

Имя параметра Описание
id
обязательно

Value:

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
Клонировать шаблон подготовки

Параметры

Имя параметра Описание
id
обязательно

Value:

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
обязательно

Value:

Must be a Hash

job_template[name]
обязательно

Template name


Value:

Must be String