API für AWA-Posteingangsaktionen

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 8 Minuten Lesedauer

    • Die AWA-Posteingangsaktionen Die API stellt Endpunkte bereit, um ein Arbeitselement im Namen eines Service Desk-Mitarbeiters zu akzeptieren oder abzulehnen. Diese API ruft auch Ablehnungsgründe für abgelehnte Arbeitselemente ab.

    Diese API erfordert Erweiterte Arbeitszuweisung Plugin (com.Glide.Awa) und Rolle Awa_Integration_user. Weitere Informationen finden Sie unter Erweiterte Arbeitszuweisung .

    AWA-Posteingangsaktionen – GET /Awa/inbox/actions/ject_reasons/{Channel_ID}

    Ruft die Ablehnungsgründe für Arbeitselemente für einen angegebenen Servicekanal ab.

    URL-Format

    Versionierte URL: /api/now/Awa/inbox/actions/ject_reasons/{Channel_ID}

    Standard-URL: /api/now/{api_Version}/Awa/inbox/actions/ject_reasons/{Channel_ID}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    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
    channel_id SYS_ID eines Servicekanals.

    Datentyp: Zeichenfolge

    Tabelle: Servicekanäle [Awa_Service_Channel]
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    401 Nicht autorisiert. Die Anmeldeinformationen 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 Mit der erweiterten Arbeitszuweisung installierte Komponenten .
    404 Datensatz nicht gefunden Die angegebene Kanal-ID ist ungültig.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    display_value Anzeigewert des Felds „Grund“ in der Tabelle „Ablehnungsgründe“ [Awa_ject_reason].

    Datentyp: Zeichenfolge
    Bestellen Reihenfolge, in der die Ablehnungsgründe im Posteingang des Service Desk-Mitarbeiters aufgeführt werden.

    Datentyp: Zahl
    Wert Wert des Felds „Ablehnungsgrund“, das in der Datenbank gespeichert ist.

    Datentyp: Zeichenfolge
    SYS_ID SYS_ID eines Ablehnungsgrunds für diesen Servicekanal.

    Datentyp: Zeichenfolge

    Tabelle: Ablehnungsgründe [Awa_reject_reason]

    Das folgende Beispiel zeigt, wie Ablehnungsgründe für den Chat-Servicekanal abgerufen werden.

    curl "https://instance.service-now.com/api/now/awa/inbox/actions/reject_reasons/27f675e3739713004a905ee515f6a7c3" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Antworttext, der abgelehnte Aufgaben mit Gründen für die Ablehnung anzeigt.

    {
  "result": [
    {
      "order": 2,
      "value": "Not my expertise",
      "display_value": "Not my expertise",
      "sys_id": "31e3fa29b38023002e7b6e5f26a8dc17"
    },
    {
      "order": 1,
      "value": "Busy",
      "display_value": "Busy",
      "sys_id": "4e93fa29b38023002e7b6e5f26a8dc20"
    }
  ]
}

    AWA-Posteingangsaktionen: VERÖFFENTLICHEN SIE /Awa/inbox/actions/accept

    Akzeptiert ein Arbeitselement in Annahme Ausstehend status im Namen eines Service Desk-Mitarbeiters.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/Awa/inbox/actions/accept

    Standard-URL: /api/now/Awa/inbox/actions/accept

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    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 : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    agent_id SYS_ID des aufgelisteten Agents.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    work_item_id SYS_ID des Arbeitselements.
    Das Arbeitselement muss die folgenden Kriterien erfüllen:
    • Arbeitselement muss dem angegebenen Service Desk-Mitarbeiter zugewiesen werden.
    • Arbeitselement muss sich in befinden Annahme Ausstehend status.

    Datentyp: Zeichenfolge

    Tabelle: AWA-Arbeitselement [Awa_work_item]

    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 : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 11. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung.
    Mögliche Gründe:
    • Agent-ID fehlt.
    • Arbeitselement-ID fehlt.
    • Arbeitselement ist einem anderen Service Desk-Mitarbeiter zugewiesen.
    • Arbeitselement befindet sich nicht im Status „Akzeptieren ausstehend“.
    401 Nicht autorisiert. Die Anmeldeinformationen 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 Mit der erweiterten Arbeitszuweisung installierte Komponenten .
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    documentTable Name der Tabelle, die das diesem Arbeitselement zugewiesene Dokument auflistet.

    Datentyp: Zeichenfolge
    documentSysId SYS_ID des Dokumentdatensatzes, der der Aufgabe zugewiesen ist.

    Datentyp: Zeichenfolge

    Tabelle: In der Tabelle, die in identifiziert wurde documentTableFeld.
    Fehler Details, die einen Fehler beschreiben, der während des Anforderungsprozesses aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Details des während des Anforderungsprozesses aufgetretenen Fehlers.
    Mögliche Werte:
    • Agent-ID fehlt : Die agent_idWurde im Anforderungstext nicht angegeben.
    • Arbeitselement-ID fehlt : Die work_item_idWurde im Anforderungstext nicht angegeben.
    • Arbeitselement ist einem anderen Service Desk-Mitarbeiter zugewiesen : Das angegebene Arbeitselement ist dem angegebenen Service Desk-Mitarbeiter nicht zugewiesen.
    • Falsche Arbeitselement-ID : Das im Anforderungstext angegebene Arbeitselement ist ungenau oder nicht vorhanden.
    • Arbeitselement befindet sich nicht im Status „Akzeptieren ausstehend“ : Das im Anforderungstext bereitgestellte Arbeitselement befindet sich in einem anderen Status als Annahme Ausstehend .

    Datentyp: Zeichenfolge
    Fehler.Nachricht Meldung für den während des Anforderungsprozesses aufgetretenen Fehler.Die Beschreibung wird in bereitgestellt error.detailEigenschaft.

    Datentyp: Zeichenfolge
    status Status einer nicht erfolgreichen Anforderung. Diese Eigenschaft ist nur bei einem Fehler in der Antwort enthalten.

    Gültiger Wert: Fehler

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Beispiel zeigt, wie Sie den Status des Arbeitselements eines ausgewählten Service Desk-Mitarbeiters in ändern Annahme Ausstehend Bis Akzeptiert .

    curl "https://instance.service-now.com/api/now/awa/inbox/actions/accept" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
 \"agent_id\":\"46c9e158a9fe198101d44d0d22cb640d\",
 \"work_item_id\":\"fd69abfc878b01101ae365b83cbb35fe\"
}" \
--user 'username':'password'

    Der Antworttext listet die sys_ID und die Tabelle des Dokuments auf, das sich auf das Arbeitselement bezieht.

    {
  "result": {
    "documentSysId": "57af7aec73d423002728660c4cf6a71c",
    "documentTable": "incident"
  }
}

    AWA-Posteingangsaktionen: VERÖFFENTLICHEN SIE /Awa/inbox/actions/reject

    Lehnt ein Arbeitselement in ab Annahme Ausstehend status im Namen eines Service Desk-Mitarbeiters. Bei Erfolg Zugewiesen an Feld ist leer und der Wert von Abgelehnt Feld ist für das angegebene Arbeitselement „wahr“.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/Awa/inbox/actions/reject

    Standard-URL: /api/now/Awa/inbox/actions/reject

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    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 : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    agent_id SYS_ID des aufgelisteten Agents.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    Ablehnungsgrund_ID SYS_ID eines Ablehnungsgrunds für diesen Servicekanal.

    Datentyp: Zeichenfolge

    Tabelle: Ablehnungsgründe [Awa_reject_reason]
    work_item_id SYS_ID des Arbeitselements.
    Das Arbeitselement muss die folgenden Kriterien erfüllen:
    • Arbeitselement muss dem angegebenen Service Desk-Mitarbeiter zugewiesen werden.
    • Arbeitselement muss sich in befinden Annahme Ausstehend status.

    Datentyp: Zeichenfolge

    Tabelle: AWA-Arbeitselement [Awa_work_item]

    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 : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 17. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Ungültige Anforderung.
    Mögliche Gründe:
    • Agent-ID fehlt.
    • Arbeitselement-ID fehlt.
    • ID des Ablehnungsgrunds fehlt.
    • Arbeitselement ist einem anderen Service Desk-Mitarbeiter zugewiesen.
    • Arbeitselement befindet sich nicht im Status „Akzeptieren ausstehend“.
    401 Nicht autorisiert. Die Anmeldeinformationen 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 Mit der erweiterten Arbeitszuweisung installierte Komponenten .
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    Mögliche Gründe:
    • Falsche Agent-ID: Für den angegebenen Anwender ist kein Datensatz vorhanden.
    • Falsche Ablehnungsgrund-ID: Für den angegebenen Ablehnungsgrund ist kein Datensatz vorhanden.
    • Falsche Arbeitselement-ID: Für das angegebene Arbeitselement ist kein Datensatz vorhanden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    agent_id SYS_ID des aufgelisteten Agents.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    Fehler Details, die einen Fehler beschreiben, der während des Anforderungsprozesses aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Details des während des Anforderungsprozesses aufgetretenen Fehlers.
    Mögliche Werte:
    • Agent-ID fehlt – Die agent_idWurde im Anforderungstext nicht angegeben.
    • Element-ID für Ablehnungsgrund fehlt – Die reject_reason_idWurde im Anforderungstext nicht angegeben.
    • Arbeitselement-ID fehlt : Die work_item_idWurde im Anforderungstext nicht angegeben.
    • Es gibt keinen Datensatz für Awa_rejject_reason: <reason_sys_id> – Die reject_reason_idDer im Anforderungstext angegebene Datensatz hat keinen übereinstimmenden Datensatz in der Tabelle „Ablehnungsgründe“ [Awa_reject_reason].
    • Es gibt keinen Datensatz für Awa_work_item: <work_item_sys_id> – Die work_item_idDer im Anforderungstext angegebene Datensatz hat keinen übereinstimmenden Datensatz in der Tabelle „AWA-Arbeitselement“ [Awa_work_item].
    • Es ist kein Datensatz für sys_user vorhanden: <agent_sys_id> – Die agent_idDer im Anforderungstext angegebene Datensatz hat keinen übereinstimmenden Datensatz in der Anwendertabelle [sys_user].
    • Arbeitselement befindet sich nicht im Status „Akzeptieren ausstehend“ : Das im Anforderungstext bereitgestellte Arbeitselement befindet sich in einem anderen Status als Annahme Ausstehend .

    Datentyp: Zeichenfolge
    Fehler.Nachricht Meldung für den während des Anforderungsprozesses aufgetretenen Fehler.Die Beschreibung wird in bereitgestellt error.detailEigenschaft.

    Datentyp: Zeichenfolge
    status Status einer nicht erfolgreichen Anforderung. Diese Eigenschaft ist nur bei einem Fehler in der Antwort enthalten.

    Gültiger Wert: Fehler

    Datentyp: Zeichenfolge
    Ablehnungsgrund_ID SYS_ID eines Ablehnungsgrunds für diesen Servicekanal.

    Datentyp: Zeichenfolge

    Tabelle: Ablehnungsgründe [Awa_reject_reason]
    work_item_id SYS_ID des Arbeitselements.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie ein zugewiesenes Arbeitselement mit dem Grund „nicht meine Kompetenz“ abgelehnt wird.

    curl "https://instance.service-now.com/api/now/awa/inbox/actions/reject" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"agent_id\":\"46c9e158a9fe198101d44d0d22cb640d\",
    \"work_item_id\":\"3ed5df4d87cf01101ae365b83cbb35af\",
    \"reject_reason_id\":\"31e3fa29b38023002e7b6e5f26a8dc17\"
}" \
--user 'username':'password'

    Erfolgreiche Ausgabe zeigt dasselbe Arbeitselement, denselben Ablehnungsgrund und dieselbe Anwender-ID an, die im Anforderungstext angegeben wurden. Das in der Tabelle „AWA-Arbeitselement“ [Awa_work_item] angegebene Arbeitselement hat ein leeres Element Zugewiesen an Feld und der Wert von Abgelehnt Feld ist „wahr“.

    {
  "result": {
    "work_item_id": "3ed5df4d87cf01101ae365b83cbb35af",
    "reject_reason_id": "31e3fa29b38023002e7b6e5f26a8dc17",
    "agent_id": "46c9e158a9fe198101d44d0d22cb640d"
  }
}