orchestrator
2021.10
false
- Démarrage
- Définition Swagger
- API Orchestrator
- Demandes d'alertes
- Requêtes relatives aux actifs
- Requêtes de calendriers
- Requêtes relatives aux environnements
- Requêtes de dossiers
- Requêtes de tâches génériques
- Requêtes relatives aux tâches
- Requêtes relatives aux bibliothèques
- Requêtes relatives aux licences
- Requêtes relatives aux paquets (Packages Requests)
- Requêtes relatives aux autorisations
- Requêtes relatives aux processus
- Requêtes relatives aux Robots
- Requêtes relatives aux rôles (Roles Requests)
- Requêtes relatives aux planifications
- Requêtes relatives aux paramètres
- Requêtes de tâches
- Demandes de catalogues de tâches
- Demandes de formulaires de tâches
- Requêtes relatives aux locataires
- Requêtes relatives aux transactions
- Requêtes relatives aux utilisateurs
- Requêtes relatives aux Webhooks
Requêtes relatives aux Webhooks
Important :
Veuillez noter que ce contenu a été localisé en partie à l’aide de la traduction automatique.
Guide de l'API Orchestrator
Last updated 22 juin 2024
Requêtes relatives aux Webhooks
L'exemple suivant permet de récupérer tous les Webhooks qui envoient des informations à l'URL
http://documentation.azurewebsites.net/webhook/documentation
.
Obtenir
{OrchestratorURL}/odata/Webhooks?$filter=Url eq 'http://documentation.azurewebsites.net/webhook/documentation'
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Webhooks",
"@odata.count": 1,
"value": [{
"Url": "http://documentation.azurewebsites.net/webhook/documentation",
"Enabled": true,
"Secret": "1234567890",
"SubscribeToAllEvents": false,
"AllowInsecureSsl": false,
"Id": 4,
"Events": [{
"EventType": "job.started"
},
{
"EventType": "process.created"
},
{
"EventType": "process.deleted"
},
{
"EventType": "process.updated"
},
{
"EventType": "queue.created"
}
]
}]
}
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Webhooks",
"@odata.count": 1,
"value": [{
"Url": "http://documentation.azurewebsites.net/webhook/documentation",
"Enabled": true,
"Secret": "1234567890",
"SubscribeToAllEvents": false,
"AllowInsecureSsl": false,
"Id": 4,
"Events": [{
"EventType": "job.started"
},
{
"EventType": "process.created"
},
{
"EventType": "process.deleted"
},
{
"EventType": "process.updated"
},
{
"EventType": "queue.created"
}
]
}]
}
La requête suivante permet de récupérer les informations sur un Webhook spécifique, en fonction de son
Id
.
Obtenir
{OrchestratorURL}/odata/Webhooks(10)
En-têtes de requête.
Clé (Key) |
Valeur (Value) |
---|---|
Autorisation |
Porteur |
Codes de réponse
200 OK
Corps de la réponse
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Webhooks/$entity",
"Url": "https://orchestrator.uipath.com",
"Enabled": false,
"Secret": "1234567890",
"SubscribeToAllEvents": true,
"AllowInsecureSsl": false,
"Id": 10,
"Events": []
}
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Webhooks/$entity",
"Url": "https://orchestrator.uipath.com",
"Enabled": false,
"Secret": "1234567890",
"SubscribeToAllEvents": true,
"AllowInsecureSsl": false,
"Id": 10,
"Events": []
}
L'exemple ci-dessous permet de récupérer tous les types d'événements auxquels il est possible de s'abonner dans Orchestrator.
Obtenir
{OrchestratorURL}/odata/Webhooks/UiPath.Server.Configuration.OData.GetEventTypes()
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Application.Dto.Webhooks.WebhookEventTypeDto)",
"value": [
{
"Name": "process.created",
"Group": "process"
},
{
"Name": "process.updated",
"Group": "process"
},
{
"Name": "process.deleted",
"Group": "process"
},
{
"Name": "schedule.failed",
"Group": "schedule"
},
{
"Name": "robot.status",
"Group": "robot"
},
{
"Name": "job.started",
"Group": "job"
},
{
"Name": "job.completed",
"Group": "job"
},
{
"Name": "job.faulted",
"Group": "job"
},
{
"Name": "job.stopped",
"Group": "job"
},
{
"Name": "job.created",
"Group": "job"
},
{
"Name": "queue.created",
"Group": "queue"
},
{
"Name": "queue.updated",
"Group": "queue"
},
{
"Name": "queue.deleted",
"Group": "queue"
},
{
"Name": "queueItem.added",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionStarted",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionFailed",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionCompleted",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionAbandoned",
"Group": "queueItem"
},
{
"Name": "robot.created",
"Group": "robot"
},
{
"Name": "robot.updated",
"Group": "robot"
},
{
"Name": "robot.deleted",
"Group": "robot"
}
]
}
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Collection(UiPath.Application.Dto.Webhooks.WebhookEventTypeDto)",
"value": [
{
"Name": "process.created",
"Group": "process"
},
{
"Name": "process.updated",
"Group": "process"
},
{
"Name": "process.deleted",
"Group": "process"
},
{
"Name": "schedule.failed",
"Group": "schedule"
},
{
"Name": "robot.status",
"Group": "robot"
},
{
"Name": "job.started",
"Group": "job"
},
{
"Name": "job.completed",
"Group": "job"
},
{
"Name": "job.faulted",
"Group": "job"
},
{
"Name": "job.stopped",
"Group": "job"
},
{
"Name": "job.created",
"Group": "job"
},
{
"Name": "queue.created",
"Group": "queue"
},
{
"Name": "queue.updated",
"Group": "queue"
},
{
"Name": "queue.deleted",
"Group": "queue"
},
{
"Name": "queueItem.added",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionStarted",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionFailed",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionCompleted",
"Group": "queueItem"
},
{
"Name": "queueItem.transactionAbandoned",
"Group": "queueItem"
},
{
"Name": "robot.created",
"Group": "robot"
},
{
"Name": "robot.updated",
"Group": "robot"
},
{
"Name": "robot.deleted",
"Group": "robot"
}
]
}
L'exemple ci-dessous modifie l'état de
Url
, de Enabled
, Secret
, AllowInsecureSsl
et le Webhook Events
avec le 10 comme Id
auquel il est abonné.
METTRE
{OrchestratorURL}/odata/Webhooks(10)
{
"Url": "https://orchestrator.uipath.com/reference",
"Enabled": false,
"Secret": "This is a new secret.",
"AllowInsecureSsl": true,
"Events": [{
"EventType": "process.created"
},
{
"EventType": "queue.created"
},
{
"EventType": "robot.deleted"
}
]
}
{
"Url": "https://orchestrator.uipath.com/reference",
"Enabled": false,
"Secret": "This is a new secret.",
"AllowInsecureSsl": true,
"Events": [{
"EventType": "process.created"
},
{
"EventType": "queue.created"
},
{
"EventType": "robot.deleted"
}
]
}
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Webhooks/$entity",
"Url": "https://orchestrator.uipath.com/reference",
"Enabled": false,
"Secret": "This is a new secret.",
"SubscribeToAllEvents": false,
"AllowInsecureSsl": true,
"Id": 10,
"Events": [
{
"EventType": "process.created"
},
{
"EventType": "queue.created"
},
{
"EventType": "robot.deleted"
}
]
}
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#Webhooks/$entity",
"Url": "https://orchestrator.uipath.com/reference",
"Enabled": false,
"Secret": "This is a new secret.",
"SubscribeToAllEvents": false,
"AllowInsecureSsl": true,
"Id": 10,
"Events": [
{
"EventType": "process.created"
},
{
"EventType": "queue.created"
},
{
"EventType": "robot.deleted"
}
]
}
La requête suivante permet de tester l'URL cible, et en cas de réussite, elle renvoie un type d'événement
ping
, son ID TenantId
, OrganizationUnitId
et UserId
.
Publier
{OrchestratorURL}/odata/Webhooks(11)/UiPath.Server.Configuration.OData.Ping
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Webhooks.Dto.PingEventDto",
"Type": "ping",
"EventId": "c3319a2d83c44b2f989bdd7eba1f0297",
"Timestamp": "2018-11-19T14:32:47.6024779Z",
"TenantId": 57,
"OrganizationUnitId": null,
"UserId": 583
}
{
"@odata.context": "{OrchestratorURL}/odata/$metadata#UiPath.Webhooks.Dto.PingEventDto",
"Type": "ping",
"EventId": "c3319a2d83c44b2f989bdd7eba1f0297",
"Timestamp": "2018-11-19T14:32:47.6024779Z",
"TenantId": 57,
"OrganizationUnitId": null,
"UserId": 583
}
- Récupération des Webhooks
- En fonction de l'URL
- En fonction de l'ID
- Récupération de tous les types d'événements disponibles
- En-têtes de requête.
- Codes de réponse
- Corps de la réponse
- Modification d'un Webhook
- En-têtes de requête.
- Corps de la requête
- Codes de réponse
- Corps de la réponse
- Test de l'URL cible du Webhook
- En-têtes de requête.
- Codes de réponse
- Corps de la réponse