Aller au contenu principal

Automatisations

Règles d’automatisation : déclencheurs, actions, historique d’exécution.

GET /api/v1/entities/{entityId}/automation-rules

Accès
Permission tâches : lecture (Tasks.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —

Réponse 200 · application/json

Schéma AutomationRuleListResponse

Champ Type Contraintes
data AutomationRuleResponse[] —

POST /api/v1/entities/{entityId}/automation-rules

Accès
Permission tâches : écriture (Tasks.Write) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —

Corps de la requête application/json, requis

Schéma CreateAutomationRuleRequest

Champ Type Contraintes
name requis string max. 255 caractères
isEnabled boolean —
triggerType requis string max. 100 caractères
triggerConditions AutomationRuleTriggerConditionsRequest | null —
actions AutomationRuleActionRequest[] au moins 1 élément(s)

Réponse 200 · application/json

Schéma AutomationRuleResponse

Champ Type Contraintes
id string (uuid) —
entityId string (uuid) —
name string —
isEnabled boolean —
triggerType string —
triggerConditions AutomationRuleTriggerConditionsResponse | null —
actions AutomationRuleActionResponse[] —
createdByUserId string (uuid) —
updatedByUserId string (uuid) —
createdAt string (date-time) —
updatedAt string (date-time) —

GET /api/v1/entities/{entityId}/automation-rules/{ruleId}

Accès
Permission tâches : lecture (Tasks.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
ruleId requis chemin string (uuid) —

Réponse 200 · application/json

Schéma AutomationRuleResponse

Champ Type Contraintes
id string (uuid) —
entityId string (uuid) —
name string —
isEnabled boolean —
triggerType string —
triggerConditions AutomationRuleTriggerConditionsResponse | null —
actions AutomationRuleActionResponse[] —
createdByUserId string (uuid) —
updatedByUserId string (uuid) —
createdAt string (date-time) —
updatedAt string (date-time) —

PUT /api/v1/entities/{entityId}/automation-rules/{ruleId}

Accès
Permission tâches : écriture (Tasks.Write) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
ruleId requis chemin string (uuid) —

Corps de la requête application/json, requis

Schéma UpdateAutomationRuleRequest

Champ Type Contraintes
name string | null max. 255 caractères
isEnabled boolean | null —
triggerType string | null max. 100 caractères
triggerConditions AutomationRuleTriggerConditionsRequest | null —
actions AutomationRuleActionRequest[] | null —

Réponse 200 · application/json

Schéma AutomationRuleResponse

Champ Type Contraintes
id string (uuid) —
entityId string (uuid) —
name string —
isEnabled boolean —
triggerType string —
triggerConditions AutomationRuleTriggerConditionsResponse | null —
actions AutomationRuleActionResponse[] —
createdByUserId string (uuid) —
updatedByUserId string (uuid) —
createdAt string (date-time) —
updatedAt string (date-time) —

DELETE /api/v1/entities/{entityId}/automation-rules/{ruleId}

Accès
Permission tâches : écriture (Tasks.Write) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
ruleId requis chemin string (uuid) —

Réponse 200

Réponse non décrite dans le document OpenAPI (le code de l’action ne déclare pas son type de retour).

POST /api/v1/entities/{entityId}/automation-rules/{ruleId}/enabled

Accès
Permission tâches : écriture (Tasks.Write) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
60 requêtes d’écriture par minute et par utilisateur (budget partagé entre tous les points d’accès concernés ; GET non comptés)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
ruleId requis chemin string (uuid) —

Corps de la requête application/json, requis

Schéma SetAutomationRuleEnabledRequest

Champ Type Contraintes
isEnabled requis boolean —

Réponse 200 · application/json

Schéma AutomationRuleResponse

Champ Type Contraintes
id string (uuid) —
entityId string (uuid) —
name string —
isEnabled boolean —
triggerType string —
triggerConditions AutomationRuleTriggerConditionsResponse | null —
actions AutomationRuleActionResponse[] —
createdByUserId string (uuid) —
updatedByUserId string (uuid) —
createdAt string (date-time) —
updatedAt string (date-time) —

GET /api/v1/entities/{entityId}/automation-rules/executions

Accès
Permission tâches : lecture (Tasks.Read) , accordée par le rôle de l’utilisateur sur l’entité du chemin.
Limite de débit
aucune (les lectures ne sont pas limitées)

Paramètres

Nom Où Type Contraintes
entityId requis chemin string (uuid) —
ruleId requête string (uuid) —

Réponse 200 · application/json

Schéma AutomationRuleExecutionListResponse

Champ Type Contraintes
data AutomationRuleExecutionResponse[] —

Schémas

Objets utilisés par les opérations de cette page. Les nombres sont écrits en JSON comme des nombres ; les énumérations, comme des chaînes.

AutomationRuleListResponse

Champ Type Contraintes
data AutomationRuleResponse[] —

AutomationRuleResponse

Champ Type Contraintes
id string (uuid) —
entityId string (uuid) —
name string —
isEnabled boolean —
triggerType string —
triggerConditions AutomationRuleTriggerConditionsResponse | null —
actions AutomationRuleActionResponse[] —
createdByUserId string (uuid) —
updatedByUserId string (uuid) —
createdAt string (date-time) —
updatedAt string (date-time) —

AutomationRuleTriggerConditionsResponse

Champ Type Contraintes
controlStatus string | null —
incidentSeverityLte string | null —
riskScoreGte number | null —
requiresNoTreatmentPlan boolean | null —
deadlineWithinDays integer | null —
assessmentOlderThanDays integer | null —

AutomationRuleActionResponse

Champ Type Contraintes
type string —
titleTemplate string | null —
descriptionTemplate string | null —
priority string | null —
dueInDays integer | null —
assigneeStrategy string | null —
specificUserId string (uuid) | null —
subjectTemplate string | null —
bodyTemplate string | null —
recipientStrategy string | null —
recipientUserId string (uuid) | null —

CreateAutomationRuleRequest

Champ Type Contraintes
name requis string max. 255 caractères
isEnabled boolean —
triggerType requis string max. 100 caractères
triggerConditions AutomationRuleTriggerConditionsRequest | null —
actions AutomationRuleActionRequest[] au moins 1 élément(s)

AutomationRuleTriggerConditionsRequest

Champ Type Contraintes
controlStatus string | null max. 100 caractères
incidentSeverityLte string | null max. 100 caractères
riskScoreGte number | null ≥ 0 · ≤ 25
requiresNoTreatmentPlan boolean | null —
deadlineWithinDays integer | null ≥ 1 · ≤ 365
assessmentOlderThanDays integer | null ≥ 1 · ≤ 1095

AutomationRuleActionRequest

Champ Type Contraintes
type requis string max. 100 caractères
titleTemplate string | null max. 255 caractères
descriptionTemplate string | null max. 2000 caractères
priority TaskPriority | null —
dueInDays integer | null ≥ 0 · ≤ 365
assigneeStrategy string | null max. 100 caractères
specificUserId string (uuid) | null —
subjectTemplate string | null max. 255 caractères
bodyTemplate string | null max. 255 caractères
recipientStrategy string | null max. 100 caractères
recipientUserId string (uuid) | null —

TaskPriority

Énumération (chaîne) : Critical, High, Medium, Low

UpdateAutomationRuleRequest

Champ Type Contraintes
name string | null max. 255 caractères
isEnabled boolean | null —
triggerType string | null max. 100 caractères
triggerConditions AutomationRuleTriggerConditionsRequest | null —
actions AutomationRuleActionRequest[] | null —

SetAutomationRuleEnabledRequest

Champ Type Contraintes
isEnabled requis boolean —

AutomationRuleExecutionListResponse

Champ Type Contraintes
data AutomationRuleExecutionResponse[] —

AutomationRuleExecutionResponse

Champ Type Contraintes
id string (uuid) —
ruleId string (uuid) —
triggeredAt string (date-time) —
status string —
triggerPayloadJson string | null —
resultJson string | null —
errorMessage string | null —
createdTaskId string (uuid) | null —

Mise à jour : 10 octobre 2026. Signaler une inexactitude