AWA API d’affectation

L’API d’affectation AWA fournit des points de terminaison pour affecter manuellement des éléments de travail aux agents.

Cette API nécessite le module d’extension (com.glide.awa) et awa_manager Affectation de travail avancée rôle.

Un élément de travail est un élément de 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, reportez-vous à Advanced Work Assignment.

Affectation manuelle AWA – POST /awa/workitems/{work_item_sys_id}/assignments

Affecte un élément de travail disponible à un agent disponible Affectation de travail avancée .

Le principal cas d’utilisation de ce point de terminaison est d’activer des systèmes d’acheminement externes pour acheminer des é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 de l’AWA. La tâche d’élément de travail peut être affectée en appelant ce point de terminaison. Pour plus d’informations, reportez-vous à la section Utiliser le routage 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

Tableau 1. Paramètres de chemin d'accès

Nom	Description
api_version	Facultatif. Version du point de terminaison auquel accéder. 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. Situé dans la table Éléments de travail [awa_work_item]. L’élément de travail doit être désaffecté et à l’état Acceptation en attente ou Mis en file d’attente . Pour plus d’informations, reportez-vous à la section Vérifier les éléments de tâche non affectés. Type : chaîne

Tableau 2. Paramètres de requête

Nom	Description
Néant

Tableau 3. Paramètres de corps de demande (XML ou JSON)

Nom	Description
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 dans la table Utilisateur [sys_user]. Pour plus d’informations sur la façon de déterminer si un agent est disponible, reportez-vous aux contrôles de la boîte de réception de l’agent. Type : chaîne

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 une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

Tableau 4. En-têtes de demandes

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

Tableau 5. En-têtes de réponses

En-tête	Description
Aucun

Codes d'état

Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

Tableau 6. Codes d'état

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 le sys_id d’agent fourni.
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 de corps de réponse (JSON ou XML)

Nom	Description
succès	Marqueur indiquant si l’affectation de l’élément de travail manuel est réussie. Valeurs valides : true : affectation de l’élément de travail réussie. false : échec de l’affectation de l’élément de travail. Type de données : booléennes Valeur par défaut : vrai
message	Message de réponse confirmant la réussite de l’affectation ou de l’exception. Exceptions: « L’élément de travail ne peut pas être affecté » : l’élément de travail fourni ne peut pas être affecté car son état est Accepté ou Annulé . Reportez-vous à la section Vérifier les éléments de travail et les événements AWA. « <agent_sys_id> n’est pas un agent valide » – L’agent n’a pas le rôle awa_agent. « <work_item_sys_id> n’est pas un élément de travail valide » : l’élément de travail fourni sys_id n’existe pas. « L’élément de travail est déjà affecté à <work_item_sys_id> » : l’élément de travail fourni est affecté à un autre agent. « L’agent n’est pas disponible » : l’agent n’est pas à l’état Disponible dans AWA. Consultez les contrôles de la boîte de réception de l’agent. Type de données : chaîne

Demande cURL

L’exemple suivant montre comment affecter un élément de travail à un agent AWA disponible.

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"
  }
}