AWA-Routing-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 2 Minuten Lesedauer
  • Die AWA-Weiterleitung Die API stellt Endpunkte bereit, um ein Dokument an eine Warteschlange weiterzuleiten.

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

    AWA-Weiterleitung: /Now/Awa/Queues/{Queue_sys_ID}/work_item VERÖFFENTLICHEN

    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 seine Felder entsprechend festgelegt.

    URL-Format

    Versionierte URL: /api/now/{api_Version}/Awa/Queues/{Queue_sys_ID}/work_item

    Standard-URL: /api/now/Awa/Queues/{Queue_sys_ID}/work_item

    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

    Warteschlange_sys_ID SYS_ID des Warteschlangendatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Warteschlange [Awa_Queue]

    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

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

    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.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    display_name Name des Dokuments, das nach diesem Arbeitselement weitergeleitet werden soll, z. B. 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

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