AWA-Routing-API

Die AWA-Routing- API bietet Endpunkte zum Weiterleiten eines Dokuments an eine Warteschlange.

Diese API erfordert das Plugin Erweiterte Arbeitszuweisung (com.glide.awa) und die Rolle awa_integration_user.

AWA-Routing: POST /now/awa/queues/{queue_sys_id}/work_item

Wenn ein aktives Arbeitselement besteht, wird ein Dokument an eine Warteschlange weitergeleitet. Wenn für das angegebene Dokument kein aktives Arbeitselement vorhanden ist, wird ein Arbeitselement erstellt und die entsprechenden Felder festgelegt.

URL-Format

URL mit Versionsnummer: /api/now/{api_version}/awa/queues/{queue_sys_id}/work_item

Standard-URL: /api/now/awa/queues/{queue_sys_id}/work_item

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
queue_sys_id	Sys_id des Warteschlangendatensatzes aus der Tabelle „Warteschlange“ [awa_queue]. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
document_sys_id	Sys_id des Dokuments, das an die Warteschlange weitergeleitet werden soll. Datentyp: Zeichenfolge
document_table	Name der Tabelle, die dem Dokument zugeordnet ist, z. B. „Incident“. Datentyp: Zeichenfolge

Header

Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.

Tabelle : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 5. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Parameter des Antworttexts (JSON oder XML)

Name	Beschreibung
display_name	Name des Dokuments, das von diesem Arbeitselement weitergeleitet werden soll, z. B. ein Falldatensatz. Datentyp: Zeichenfolge
document_sys_id	Sys_id des Dokuments, das an die Warteschlange weitergeleitet werden soll. Datentyp: Zeichenfolge
document_table	Name der Tabelle, die dem Dokument zugeordnet ist. Datentyp: Zeichenfolge
queue_sys_id	Sys_id der Warteschlange, in der ein Dokument weitergeleitet werden soll. Datentyp: Zeichenfolge
sys_id	Sys_id des Arbeitselements, das der Warteschlange zugewiesen ist. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

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