GET /foreman_tasks/api/tasks/summary
Show task summary

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer


GET /foreman_tasks/api/tasks/:id
Show task details

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer

id
optionel

UUID de la tâche

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 /foreman_tasks/api/tasks/:id/details
Show task extended details

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer

id
optionel

UUID de la tâche

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 /foreman_tasks/api/tasks/:id/sub_tasks
Show sub_tasks details

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer

id
optionel

UUID de la tâche

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 /foreman_tasks/api/tasks/bulk_search
List dynflow tasks for uuids


POST /foreman_tasks/api/tasks/bulk_resume
Reprendre toutes les tâches en attente avec des erreurs

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer

search
optionel

Reprendre toutes le tâches correspondant au string de recherche

Validations:

  • Must be a String

task_ids
optionel

Reprendre les tâches spécifiques par ID

Validations:

  • Must be an array of any type


POST /foreman_tasks/api/tasks/bulk_cancel
Annuler toutes les tâches annulables

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer

search
optionel

Annuler toutes le tâches correspondant à a chaîne de recherche

Validations:

  • Must be a String

task_ids
optionel

Annuler les tâches spécifiques par ID

Validations:

  • Must be an array of any type


POST /foreman_tasks/api/tasks/bulk_stop
Stop all stoppable tasks

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer

search
optionel

Stop tasks matching search string

Validations:

  • Must be a String

task_ids
optionel

Stop specific tasks by ID

Validations:

  • Must be an array of any type


GET /foreman_tasks/api/tasks
Lister les tâches

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer

search
optionel

Rechercher une chaîne

Validations:

  • Must be a String

page
optionel

Numéro de la page, commençant par 1

Validations:

  • Must be a number.

per_page
optionel

Nombre de résultats par page à renvoyer

Validations:

  • Must be a number.

order
optionel

Trier le champ et l'ordre, ex : 'name DESC'

Validations:

  • Must be a String

sort
optionel

Version Hash des paramètres d'« ordre »

Validations:

  • Must be a Hash

sort[by]
optionel

Champs dans lequel trier les résultats

Validations:

  • Must be a String

sort[order]
optionel

Comment classer les résultats triés (ex : ASC for ascending ou CRO pour croissant)

Validations:

  • Must be a String


POST /foreman_tasks/api/tasks/callback
Envoie les données à la tâche à partir d'un exécuteur exérieur (tel que smart_proxy_dynflow)

Paramètres

Nom du paramètre Description
location_id
optionel

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
optionel

Définir le contexte organisationnel actuel de la demande

Validations:

  • Must be a Integer

callback
optionel

Validations:

  • Must be a Hash

callback[task_id]
optionel

UUID de la tâche

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

callback[step_id]
optionel

L'ID de l'étape qui se trouve dans le plan d'exécution auquel envoyer l'événement

Validations:

  • Must be a String

data
optionel

Données à envoyer à l'action

Validations:

  • Must be a Hash

callbacks
optionel

Validations:

  • Must be an Array of nested elements

callbacks[callback]
optionel

Validations:

  • Must be a Hash

callbacks[callback][task_id]
optionel

UUID de la tâche

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

callbacks[callback][step_id]
optionel

L'ID de l'étape qui se trouve dans le plan d'exécution auquel envoyer l'événement

Validations:

  • Must be a String

callbacks[data]
optionel

Données à envoyer à l'action

Validations:

  • Must be a Hash