API d’acheminement AWA
L’API AWA Routing fournit des points de terminaison pour acheminer un document vers une file d’attente.
Cette API nécessite le module d’extension Affectation de travail avancée (com.glide.awa) et le rôle awa_integration_user.
Acheminement AWA : POST /now/awa/queues/{queue_sys_id}/work_item
Si un élément de travail actif existe, achemine un document vers une file d’attente. Si aucun élément de travail actif n’existe pour le document spécifié, crée un élément de travail et définit ses champs en conséquence.
Format d'URL
URL versionnée : /api/now/{api_version}/awa/queues/{queue_sys_id}/work_item
URL par défaut : /api/now/awa/queues/{queue_sys_id}/work_item
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 autre que la plus récente. Type de données : chaîne |
| queue_sys_id | Sys_id de l’enregistrement de file d’attente. Type de données : chaîne Table : File d’attente [awa_queue] |
| Nom | Description |
|---|---|
| Néant |
| Nom | Description |
|---|---|
| document_sys_id | Sys_id du document à acheminer vers la file d’attente. Type de données : chaîne |
| document_table | Nom de la table associée au document, par exemple incident. Type de données : chaîne |
En-têtes
Les en-têtes de demande et de réponse suivants s’appliquent uniquement à cette action HTTP 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 |
| Type de contenu | Format des 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 |
|---|---|
| Néant |
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é traitée avec succès. |
| 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. |
| 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 |
|---|---|
| display_name | Nom du document à acheminer par cet élément de travail, tel que l’enregistrement de ticket. Type de données : chaîne |
| document_sys_id | Sys_id du document à acheminer vers la file d’attente. Type de données : chaîne |
| document_table | Nom de la table associée au document. Type de données : chaîne |
| queue_sys_id | Sys_id de la file d’attente vers laquelle acheminer un document. Type de données : chaîne |
| sys_id | Sys_id de l’élément de travail affecté à la file d’attente. Type de données : chaîne |
Exemple de demande cURL
curl -X POST \
https://instance.servicenow.com/api/now/awa/queues/339eed3f3b892300a2bac9bb34efc4c3/work_item \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-u 'username':'password'
-d '{
"document_sys_id": "9c573169c611228700193229fff72400",
"document_table": "incident"
}'{
"result": {
"sys_id": "cd57f90ddbb26300db2051735e9619f0",
"document_table": "incident",
"document_sys_id": "9c573169c611228700193229fff72400",
"queue_sys_id": "339eed3f3b892300a2bac9bb34efc4c3",
"display_name": "Incident: INC0000001"
}
}