GET /api/job_templates
Listar plantillas de trabajo

GET /api/locations/:location_id/job_templates
Listar plantillas de trabajo por ubicación

GET /api/organizations/:organization_id/job_templates
Listar plantillas de trabajo por organización

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

organizar resultados

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por solicitud

Validations:

  • Must be a String


POST /api/job_templates/import
Importar una plantilla de trabajo desde ERB

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

template
requerido

Plantilla ERB

Validations:

  • Must be a String

overwrite
opcional

Sobrescribir plantilla si ya existe

Validations:

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


GET /api/job_templates/:id/export
Exportar una plantilla de trabajo desde ERB

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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
Mostrar detalles de la plantilla de trabajo

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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
Crear una plantilla de trabajo

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

job_template
requerido

Validations:

  • Must be a Hash

job_template[name]
requerido

nombre de plantilla

Validations:

  • Must be a String

job_template[job_category]
requerido

Categoría de trabajo

Validations:

  • Must be a String

job_template[description_format]
opcional , nil permitido

Esta plantilla se utiliza para generar la descripción. Los valores de entrada se pueden utilizar con la sintaxis %{package}. También puede incluir la categoría de trabajo y el nombre de la plantilla con %{job_category} y %{template_name}.

Validations:

  • Must be a String

job_template[template]
requerido

Validations:

  • Must be a String

job_template[provider_type]
requerido

Tipo de proveedor

Validations:

  • Must be one of: SSH.

job_template[snippet]
opcional , nil permitido

Validations:

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

job_template[audit_comment]
opcional , nil permitido

Validations:

  • Must be a String

job_template[locked]
opcional , nil permitido

Si la plantilla está bloqueada o no para edición

Validations:

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

job_template[ssh]
opcional , nil permitido

Opciones específicas del proveedor SSH

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
opcional , nil permitido

Opciones de usuario efectivo

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
opcional , nil permitido

El usuario que se debe utilizar para ejecutar el script (con mecanismos tipo sudo)

Validations:

  • Must be a String

job_template[ssh][effective_user][overridable]
opcional , nil permitido

Si debe tener permiso para sustituir el usuario efectivo del formulario de invocación.

Validations:

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

job_template[ssh][effective_user][current_user]
opcional , nil permitido

Si el inicio de sesión del usuario actual se debe utilizar como usuario efectivo

Validations:

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

job_template[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

job_template[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


PUT /api/job_templates/:id
Actualizar una plantilla de trabajo

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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
requerido

Validations:

  • Must be a Hash

job_template[name]
opcional

nombre de plantilla

Validations:

  • Must be a String

job_template[job_category]
opcional

Categoría de trabajo

Validations:

  • Must be a String

job_template[description_format]
opcional , nil permitido

Esta plantilla se utiliza para generar la descripción. Los valores de entrada se pueden utilizar con la sintaxis %{package}. También puede incluir la categoría de trabajo y el nombre de la plantilla con %{job_category} y %{template_name}.

Validations:

  • Must be a String

job_template[template]
opcional

Validations:

  • Must be a String

job_template[provider_type]
opcional

Tipo de proveedor

Validations:

  • Must be one of: SSH.

job_template[snippet]
opcional , nil permitido

Validations:

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

job_template[audit_comment]
opcional , nil permitido

Validations:

  • Must be a String

job_template[locked]
opcional , nil permitido

Si la plantilla está bloqueada o no para edición

Validations:

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

job_template[ssh]
opcional , nil permitido

Opciones específicas del proveedor SSH

Validations:

  • Must be a Hash

job_template[ssh][effective_user]
opcional , nil permitido

Opciones de usuario efectivo

Validations:

  • Must be a Hash

job_template[ssh][effective_user][value]
opcional , nil permitido

El usuario que se debe utilizar para ejecutar el script (con mecanismos tipo sudo)

Validations:

  • Must be a String

job_template[ssh][effective_user][overridable]
opcional , nil permitido

Si debe tener permiso para sustituir el usuario efectivo del formulario de invocación.

Validations:

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

job_template[ssh][effective_user][current_user]
opcional , nil permitido

Si el inicio de sesión del usuario actual se debe utilizar como usuario efectivo

Validations:

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

job_template[location_ids]
opcional , nil permitido

REMPLAZAR ubicaciones con ID dadas

Validations:

  • Must be an array of any type

job_template[organization_ids]
opcional , nil permitido

REMPLAZAR organizaciones con ID dadas.

Validations:

  • Must be an array of any type


GET /api/job_templates/revision

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

version
opcional

versión de plantilla

Validations:

  • Must be a String


DELETE /api/job_templates/:id
Eliminar una plantilla de trabajo

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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
Clonar una plantilla de aprovisionamiento

Parámetros

Nombre del parámetro Descripción
location_id
opcional

Alcance por ubicación

Validations:

  • Must be a Integer

organization_id
opcional

Alcance por organización

Validations:

  • Must be a Integer

id
requerido

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
requerido

Validations:

  • Must be a Hash

job_template[name]
requerido

nombre de plantilla

Validations:

  • Must be a String