AWA Zuweisungs-API

Die AWA-Zuweisungs- API bietet Endpunkte für die manuelle Zuweisung von Arbeitselementen an Service Desk-Mitarbeiter.

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

Ein Arbeitselement ist ein einzelnes Stück Arbeit, das von einem AWA -Mitarbeiter von Anfang bis Ende bearbeitet wird. Zum Beispiel ist ein Chat oder ein Fall ein Objekt, das weitergeleitet und Service Desk-Mitarbeitern zugewiesen werden kann. Weitere Informationen finden Sie unter Advanced Work Assignment.

Manuelle AWA-Zuweisung – POST /awa/workitems/{work_item_sys_id}/assignments

Weist einem verfügbaren Erweiterte Arbeitszuweisung Service Desk-Mitarbeiter ein verfügbares Arbeitselement zu.

Der primäre Anwendungsfall für diesen Endpunkt besteht darin, externen Weiterleitungssystemen die Weiterleitung von Arbeitselementen zu ermöglichen. Wenn Erweiterte Arbeitszuweisung für die Verwendung von externer Weiterleitung konfiguriert ist, werden Arbeitselemente in der Warteschlange über externe Weiterleitung und nicht über AWA zugewiesen. Die Arbeitselementaufgabe kann durch Aufrufen dieses Endpunkts zugewiesen werden. Weitere Informationen finden Sie unter Externe Weiterleitung verwenden.

URL-Format

Versionierte URL: /now/{api_version}/awa/workitems/{sys_id}/assignments

Standard-URL: /now/awa/workitems/{sys_id}/assignments

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
work_item_sys_id	Sys_id des Arbeitselements, das einem verfügbaren Service Desk-Mitarbeiter zugewiesen werden soll. Befindet sich in der Tabelle „Arbeitselemente“ [awa_work_item]. Das Arbeitselement muss nicht zugewiesen sein und sich im Status Akzeptanz steht aus oder In der Warteschlange befinden. Weitere Informationen finden Sie unter Nicht zugewiesene Aufgabenarbeitselemente überprüfen. Typ: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
agent_sys_id	Erforderlich. Sys_id des verfügbaren Service Desk-Mitarbeiters, der das Arbeitselement erhalten soll. Service Desk-Mitarbeiter sind Benutzer mit der Rolle „awa_agent“ in der Benutzertabelle [sys_user]. Informationen dazu, wie Sie feststellen können, ob ein Service Desk-Mitarbeiter verfügbar ist, finden Sie unter Steuerungen des Posteingangsvon Service Desk-Mitarbeitern. Typ: 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.
409	Konflikt. Die Anforderung konnte aufgrund eines Fehlers beim angegebenen Arbeitselement oder der sys_id des Service Desk-Mitarbeiters nicht übergeben werden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttextparameter (JSON oder XML)

Name	Beschreibung
Erfolg	Kennzeichnung, die angibt, ob die manuelle Arbeitselementzuweisung erfolgreich ist. Gültige Werte: true: Zuweisung des Arbeitselements erfolgreich. false: Zuweisung des Arbeitselements nicht erfolgreich. Datentyp: Boolesch Standardwert: True
Nachricht	Antwortnachricht, die die erfolgreiche Zuweisung oder Ausnahme bestätigt. Ausnahmen: „Arbeitselement kann nicht zugewiesen werden“: Das bereitgestellte Arbeitselement kann nicht zugewiesen werden, da es sich im Status „ Akzeptiert “ oder „ Abgebrochen “ befindet. Weitere Informationen finden Sie unter Arbeitselemente und AWA-Ereignisse überprüfen. “<agent_sys_id> ist kein gültiger Agent“ – Agent hat nicht die Rolle awa_agent. “<work_item_sys_id> ist kein gültiges Arbeitselement“ – Angegebene sys_id des Arbeitselements ist nicht vorhanden. „Arbeitselement ist bereits zugewiesen<work_item_sys_id> " – Angegebenes Arbeitselement ist einem anderen Service Desk-Mitarbeiter zugewiesen. „Service Desk-Mitarbeiter ist nicht verfügbar“: Der Service Desk-Mitarbeiter befindet sich in AWA nicht im Status „ Verfügbar “. Weitere Informationen finden Sie unter Steuerungen des Posteingangsvon Service Desk-Mitarbeitern. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie einem verfügbaren AWA-Mitarbeiter ein Arbeitselement zuweisen.

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'

Das Ergebnis zeigt, dass die Aufgabe dem Service Desk-Mitarbeiter zugewiesen wurde. Sie können die Ergebnisse im Feld Zugewiesen an der Tabelle „Arbeitselemente“ [awa_work_item] überprüfen.

{
  "result": {
    "success": true,
    "message": "Manual assignment successfully requested"
  }
}