AWA API d’affectation manuelle
L’API d’affectation manuelle AWA fournit un point de terminaison pour affecter manuellement des éléments de travail disponibles à des agents disponibles Affectation de travail avancée (AWA).
Un élément de travail est un travail unique géré par un AWA agent du début à la fin. Par exemple, une messagerie instantanée ou un ticket est un objet qui peut être acheminé et affecté à des agents. Pour plus d’informations, consultez Affectation de travail avancée.
Cette API nécessite le module d’extension Affectation de travail avancée (com.glide.awa). Pour appeler cette API, vous devez avoir le rôle awa_manager ou awa_integration_user.
Affectation manuelle AWA : POST /now/awa/workitems/{work_item_sys_id}/assignments
Affecte un élément de travail disponible à un agent disponible Affectation de travail avancée (AWA).
Le cas d’utilisation primaire pour ce point de terminaison est de permettre aux systèmes d’acheminement externes d’acheminer les éléments de travail. S’il Affectation de travail avancée est configuré pour utiliser l’acheminement externe, les éléments de travail de la file d’attente sont affectés à l’aide de l’acheminement externe et non AWA. Vous pouvez affecter la tâche d’élément de travail en appelant ce point de terminaison. Pour plus d’informations, reportez-vous à la section Utiliser l’acheminement externe.
Format d'URL
URL versionnée : /now/{api_version}/awa/workitems/{sys_id}/assignments
URL par défaut : /now/awa/workitems/{sys_id}/assignments
Paramètres de demande pris en charge
| Nom | Description |
|---|---|
| api_version | Facultatif. Version du point de terminaison auquel accéder. Par exemple, v1 ou v2. Spécifiez uniquement cette valeur pour utiliser une version de point de terminaison différente de la dernière. Type de données : chaîne |
| work_item_sys_id | Sys_id de l’élément de travail à affecter à un agent disponible. L’élément de travail doit être désaffecté et dans l’état En attente d’acceptation ou Mis en file d’attente . Pour plus d’informations, reportez-vous à Vérifier les éléments de travail de tâche non affectés. Type de données : chaîne Table : éléments de travail [awa_work_item] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| after_timeout_presence | Sys_id de l’état de présence vers lequel l’agent bascule si le timeout paramètre expire. Si le timeout paramètre n’est pas transmis, il est ignoré. Pour plus d’informations sur les états de présence, reportez-vous à la section Configure agent presence states. Type de données : chaîne Par défaut : « » (chaîne vide) Table : État de présence AWA [awa_presence_state] |
| agent_sys_id | Requis. Sys_id de l’agent disponible pour recevoir l’élément de travail. Les agents sont des utilisateurs disposant du rôle awa_agent. Pour savoir comment déterminer si un agent est disponible, consultez Contrôles de la boîte de réception de l’agent. Type de données : chaîne Table : Utilisateur [sys_user] |
| allowed_to_decline | Marqueur indiquant si les agents sont autorisés à rejeter des éléments de travail. Si ce paramètre est vrai, la carte de boîte de réception affiche les boutons Accepter et Rejeter sur la carte de boîte de réception.Valeurs valides :
Type de données : booléennes Par défaut : true |
| display_option | Option d’affichage pour la carte et l’onglet lorsqu’un élément de travail est automatiquement affecté. Ce paramètre n’est valide que si la enable_auto_assign valeur est définie sur vrai. Valeurs valides :
Type de données : chaîne Par défaut : card_only |
| enable_auto_assign | Marqueur qui indique si l’élément de travail doit être automatiquement accepté ou doit permettre à l’agent d’accepter ou de rejeter manuellement l’élément de travail. Valeurs valides :
Type de données : booléennes Valeur par défaut : false |
| offered_on | Heure de l’offre d’élément de travail. La durée de l’offre est utilisée pour calculer le temps restant à l’agent pour accepter l’élément de travail dans la boîte de réception. Il permet de tenir compte de l’écart entre le moment où la demande d’API est traitée et le moment où le système de routage tiers appelle la demande d’API. Ce paramètre permet aux systèmes externes appelant ce point de terminaison de configurer la durée de l’offre de l’élément de travail afin qu’il reste synchronisé avec le suivi interne de l’élément de travail par le système externe. Par exemple, si l’élément de travail a été proposé le 11:30:30, le délai d’expiration est de 30 secondes et l’heure actuelle est 11:30:45, le compte à rebours affiche 00:15 (c’est-à-dire dans les 15 secondes restantes). Cette valeur est stockée dans le champ offered_on de l’élément de travail. Ce paramètre est ignoré s’il timeout n’est pas transmis. Type de données : chaîne Format : horodatage UTC (aaaa-MM-jj’T’HH :mm :ss. SSS) |
| timeout | Durée pendant laquelle l’élément de travail reste dans la boîte de réception de l’agent en attente de l’acceptation de l’affectation de travail par l’agent. Type de données : nombre Unité : Secondes |
En-têtes
Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.
| En-tête | Description |
|---|---|
| Accepter | Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| Content-Type | Format de données du corps de la demande. Types pris en charge : application/json ou application/xml. Valeur par défaut : application/json |
| En-tête | Description |
|---|---|
| Aucun |
Codes d'état
Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.
| Code d'état | Description |
|---|---|
| 200 | Réussi. La demande a été correctement traitée. |
| 401 | Non autorisé. Les informations d'identification de l'utilisateur sont incorrectes ou n'ont pas été transmises. |
| 404 | Introuvable. L’élément demandé est introuvable. |
| 409 | Conflit. La demande n’a pas pu être transmise en raison d’une erreur avec l’élément de travail ou l’agent fourni sys_id. |
| 500 | Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur. |
Paramètres du corps de la réponse (JSON ou XML)
| Nom | Description |
|---|---|
| succès | Marqueur indiquant si l’affectation manuelle d’éléments de travail a réussi. Valeurs possibles :
Type de données : booléennes |
| message | Message de réponse confirmant l’affectation réussie ou une exception. Réussite : « Affectation manuelle demandée avec succès. » Exceptions:
Type de données : chaîne |
Demande cURL
L’exemple suivant montre comment affecter un élément de travail à un agent AWA disponible en utilisant uniquement les paramètres requis.
curl "https://instance.servicenow.com/api/now/awa/workitems/<work_item_sys_id>/assignments" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"agent_sys_id\":\"<agent_sys_id>\"}" \
--user 'username':'password'Le résultat montre que la tâche a été affectée avec succès à l’agent. Vous pouvez vérifier les résultats dans le champ Affecté à de la table Éléments de travail [awa_work_item].
{
"result": {
"success": true,
"message": "Manual assignment successfully requested."
}
}Demande cURL
L’exemple suivant montre comment affecter un élément de travail à un agent AWA disponible, y compris les paramètres facultatifs.
curl "https://instance.servicenow.com/api/now/awa/workitems/<work_item_sys_id>/assignments" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data '{
"agent_sys_id": "46d44a23a9fe19810012d100cca80666",
"timeout":"10",
"offered_on":"2024-04-03T23:09:31.000"
}'
--user 'username':'password'Le résultat montre que la tâche a été affectée avec succès à l’agent. Vous pouvez vérifier les résultats dans le champ Affecté à de la table Éléments de travail [awa_work_item].
{
"result": {
"success": true,
"message": "Manual assignment successfully requested."
}
}