API für AWA-Mitarbeiterberatung

Verarbeitet Arbeitselemente für Mitarbeiterberatung.

Diese API erfordert Erweiterte Arbeitszuweisung Plugin (com.Glide.awa) und die Rolle Awa_Integration_user.

Für weitere Informationen zu AWA, Siehe Erweiterte Arbeitszuweisung .

Verwenden Sie AWA-Angebots-Arbeits-API Dient zum Initiieren einer Konsultationsübertragung an einen Service Desk-Mitarbeiter oder eine Warteschlange.

AWA-Mitarbeiterberatung – PUT /now/Awa/Consult/end

Beendet ein Beratungs-Arbeitselement.

Wenn ein Dokument an einen Service Desk-Mitarbeiter übertragen wird, muss das jeweilige Arbeitselement entweder mit dem entsprechenden Konsultationsstatus geschlossen werden Übertragen Oder Beendet .

Ein Arbeitselement ist eine einzelne Arbeit, die von einem AWA-Mitarbeiter von Anfang bis Ende bearbeitet wird. Ein Arbeitselement wird basierend auf einem Dokument erstellt, z. B. einer Interaktion oder Aufgabe.

URL-Format

Versionierte URL: /api/now/{api_Version}/Awa/Consult/end

Standard-URL: /api/now/awa/consult/end

Hinweis:

Verfügbare Versionen werden in angegeben REST-API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 1. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstext-Parameter (JSON oder XML)

Name	Beschreibung
Document_sys_ID	SYS_ID des Dokuments, das dem Beratungs-Arbeitselement zugeordnet ist. Ein Dokument ist ein beliebiger Datensatz in einer Tabelle, z. B. eine Interaktion, ein Fall oder ein Incident. Datentyp: Zeichenfolge
Übergabe_Over	Kennzeichnung, die angibt, ob eine Konsultationsübertragung beendet oder übertragen werden muss. Gültige Werte: „Wahr“: Übertragen Sie das Dokument an den Service Desk-Mitarbeiter, und legen Sie den Status „Konsultation“ des Beratungs-Arbeitselements auf fest Übertragen . Falsch: Beendet die Konsultationsübertragung, und legen Sie den Konsultationsstatus des Beratungs-Arbeitselements als fest Beendet . Hinweis: Wenn der Status „Konsultation“ des Beratungs-Arbeitselements lautet Angefordert , Der Status ändert sich in Abgebrochen . Datentyp: Boolesch

Header

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

Tabelle : 4. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 5. Antwortkopfzeilen

Header	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 REST-API-HTTP-Antwortcodes .

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben.
403	Unzulässig. Mögliche Gründe: Der Anwender verfügt nicht über die Rolle „Awa_Integration_user“. Der Wert der Eigenschaft „Glide.awa.enabled“ ist nicht Wahr . Diese Eigenschaft wird in der Tabelle „Systemeigenschaft“ [sys_property] aufgeführt, wenn das Plugin „Erweiterte Arbeitszuweisung“ (com.Glide.awa) installiert ist. Weitere Informationen finden Sie unter Komponenten mit erweiterter Arbeitszuweisung installiert .
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Erfolg	Kennzeichnung, die angibt, ob die abschließende Konsultation erfolgreich ist. Gültige Werte: Wahr: Die beendende Konsultation ist erfolgreich. Falsch: Die beendende Konsultation ist nicht erfolgreich. Datentyp: Boolesch
Nachricht	Erfolgs- oder Fehlerinformationen für die abschließende Konsultation. Mögliche Werte: Konsultation wurde erfolgreich beendet. – Erfolg. Das Arbeitselement für die Dokument-ID „<api_caller_sys_id>“ wurde nicht gefunden – Stellen Sie sicher, dass das aktive Beratungs-Arbeitselement für das Dokument vorhanden ist. Datentyp: Zeichenfolge

Beispiel für Curl-Anforderung

curl "https://instance.servicenow.com/api/now/awa/consult/end" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data '{
    "document_sys_id": "59616aba87bd5210be070d48dabb35e6",
    "hand_over": "true"
}' \
--user 'username':'password'

{
  "result": {
    "success": true,
    "message": "Consult is successfully ended."
  }
}