---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# AWA-Angebots-Arbeits-API

# AWA-Angebots-Arbeits-API {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 8 Minuten Lesedauer

Die AWA-Angebotsarbeit Die API stellt einen Endpunkt zum Zuweisen oder Übertragen von Arbeitselementen an Service Desk-Mitarbeiter bereit.
Diese API ist für die Verwendung mit CCAAS-Integrationen (Contact Center as a Service) vorgesehen, bei denen die Weiterleitungs- und Zuweisungsentscheidung im externen CCAAS-System erfolgt. Diese API ermöglicht eine [Posteingangskarte](https://www.servicenow.com/docs/access?context=awa-inbox-layout&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)Soll einem Service Desk-Mitarbeiter in angezeigt werden ServiceNow MitarbeiterbereichAls Benachrichtigung zum Akzeptieren des Arbeitselements.

Diese API erfordert Erweiterte ArbeitszuweisungPlugin (com.Glide.awa). Um diese API aufzurufen, müssen Sie entweder über die Rolle „Awa_Manager" oder „Awa_Integration_user" verfügen.

Für weitere Informationen zu AWA, Siehe [Erweiterte Arbeitszuweisung](https://www.servicenow.com/docs/access?context=awa-overview&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US).

## AWA-Angebotsarbeit -- POSTEN SIE /now/Awa/documents/{document_table}/{document_sys_ID}/Offer {#ariaid-title2}

Weist Arbeitselemente zu oder überträgt sie an Service Desk-Mitarbeiter.
Ein Arbeitselement ist eine einzelne Arbeit, die von einem bearbeitet wird AWAService Desk-Mitarbeiter von Start bis Ende. Ein Arbeitselement wird basierend auf einem Dokument erstellt, z. B. einer Interaktion oder Aufgabe.

Alle Service Desk-Mitarbeiter, die Arbeitselemente mit dieser API empfangen oder übertragen, müssen über die Rollen „Awa_Agent" und „Awa_external_user" verfügen.

### URL-Format

Versionierte URL: /api/now/{api_Version}/Awa/documents/{document_table}/{document_sys_ID}/Angebot

Standard-URL: /api/now/Awa/documents/{document_table}/{document_sys_ID}/offer

### Unterstützte Anforderungsparameter

{#awa-offer-work-POST-docs-offer__entry__2}{#awa-offer-work-POST-docs-offer__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Document_table | Name der Tabelle, die dem Dokument zugeordnet ist, z. B. Tabelle „Interaktion" \[Interaktion\] oder Tabelle „Aufgabe \[Aufgabe\]". Datentyp: Zeichenfolge |
| Document_sys_ID | SYS_ID des Dokuments, das an den Agent oder die Warteschlange weitergeleitet werden soll. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfad-Parameter]

{#awa-offer-work-POST-docs-offer__entry__10}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 2. Abfrageparameter]

{#awa-offer-work-POST-docs-offer__entry__14}

| Name | Beschreibung |
|-|-|
| Zuweisung | Erforderlich für neue Zuweisungen. Objekt mit Informationen zur Zuweisung. Datentyp: Objekt { "after_timeout_presence": "String", "agent_sys_id": "String", "allowed_to_decline": Boolean, "display_option": "String", "enable_auto_assign": Boolean, "offered_on": "String", "timeout": Number } |
| Zuweisung.After_timeout_presence | SYS_ID des Anwesenheitsstatus, zu dem der Service Desk-Mitarbeiter wechselt, wenn dies der Fall ist timeoutParameter läuft ab. Wenn timeoutParameter wurde nicht übergeben, dieser Parameter wird ignoriert. Weitere Informationen zu anwesenheitsstatus finden Sie unter [Configure agent presence states](https://www.servicenow.com/docs/access?context=awa-configure-agent-presence&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). Datentyp: Zeichenfolge Standard: Leere Zeichenfolge (Anwesenheitsstatus des Service Desk-Mitarbeiters ändert sich nicht). Tabelle: AWA-Anwesenheitsstatus \[Awa_presence_State\] |
| Assignment.Agent_sys_ID | Erforderlich für neue Zuweisungen. SYS_ID des verfügbaren Service Desk-Mitarbeiters, der das Arbeitselement empfangen soll. Der Agent muss die Rollen „Awa_Agent" und „Awa_external_user" haben. Informationen dazu, wie Sie bestimmen, ob ein Service Desk-Mitarbeiter verfügbar ist, finden Sie unter [Steuerungen für Posteingang des Service Desk-Mitarbeiters](https://www.servicenow.com/docs/access?context=agent-experience&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). Datentyp: Zeichenfolge Tabelle: Anwender \[sys_user\] |
| Assignment.allowed_to_Decly | Kennzeichnung, die angibt, ob Service Desk-Mitarbeiter Arbeitselemente ablehnen dürfen. Wenn dieser Parameter ist `Wahr `, Die Posteingangskarte zeigt beide an Akzeptieren Und Ablehnen Schaltflächen auf der Posteingangskarte. Gültige Werte: * Wahr/ja/1: Service Desk-Mitarbeiter kann Arbeitselemente ablehnen. * Falsch/nein/0: Service Desk-Mitarbeiter kann Arbeitselemente nicht ablehnen. {#awa-offer-work-POST-docs-offer__ul_f35_d5n_5dc} Datentyp: Boolescher Wert Standard: Wahr |
| Assignment.Display_Option | Anzeigeoption für die Karte und Registerkarte, wenn ein Arbeitselement automatisch zugewiesen wird. Dieser Parameter ist nur gültig, wenn enable_auto_assignIst <kbd class="ph userinput">Wahr </kbd>. Gültige Werte: * Card_and_tab: Karte und Registerkarte anzeigen. * Card_only: Zeigt nur die Karte an. {#awa-offer-work-POST-docs-offer__ul_m35_d5n_5dc} Datentyp: Zeichenfolge Standard: Card_only |
| Assignment.enable_Auto_assign | Kennzeichnung, die angibt, ob das Arbeitselement automatisch akzeptiert werden soll oder dem Service Desk-Mitarbeiter ermöglichen soll, das Arbeitselement manuell zu akzeptieren oder abzulehnen. Gültige Werte: * Wahr/ja/1: Automatisch akzeptieren. * Falsch/nein/0: Zulassen, dass Service Desk-Mitarbeiter manuell akzeptieren oder ablehnen. {#awa-offer-work-POST-docs-offer__ul_o35_d5n_5dc} Datentyp: Boolescher Wert Standard: Falsch |
| Zuweisung.angeboten_am | Angebotszeit des Arbeitselements. Die Angebotszeit wird verwendet, um die verbleibende Zeit zu berechnen, die dem Service Desk-Mitarbeiter verbleibt, um das Arbeitselement im Posteingang zu akzeptieren. Es hilft, die Diskrepanz zwischen dem Zeitpunkt, zu dem die API-Anforderung verarbeitet wird, und dem Zeitpunkt, zu dem das Weiterleitungssystem der Drittpartei die API-Anforderung aufruft, zu berücksichtigen. Mit diesem Parameter können externe Systeme, die diesen Endpunkt aufrufen, die Angebotszeit des Arbeitselements so konfigurieren, dass sie mit der internen Nachverfolgung des Arbeitselements des externen Systems synchronisiert bleibt. Wenn das Arbeitselement beispielsweise am 11:30:30 angeboten wurde, die Zeitüberschreitung 30 Sekunden beträgt und die aktuelle Zeit 11:30:45 ist, zeigt der Countdown-Timer 00:15 an (wie in 15 Sekunden verbleibend). Dieser Wert wird im Feld Offered_on des Arbeitselements gespeichert. Dieser Parameter wird ignoriert, wenn timeoutParameter wurde nicht übergeben. Datentyp: Zeichenfolge Format: UTC-Zeitstempel (jjjj-MM-tt'T'HH:mm:ss.SSS) |
| Zuweisung.Zeitüberschreitung | Zeit, die das Arbeitselement im Posteingang des Service Desk-Mitarbeiters verbleibt und darauf wartet, dass der Service Desk-Mitarbeiter die Arbeitszuweisung akzeptiert. Datentyp: Zahl Einheit: Sekunden Standard: Leere Zeichenfolge (keine Zeitbegrenzung). |
| External_Segment_ID | Externer Bezeichner aus dem CCAAS-System des Anrufsegments, das dem Service Desk-Mitarbeiter angeboten wird. Datentyp: Zeichenfolge |
| queue_id | Erforderlich für neue Zuweisungen. SYS_ID des Warteschlangendatensatzes oder des Warteschlangenbezeichners in einem externen System. Wenn eine Warteschlange_ID aus einem externen System verwendet wird, muss sie dem Feld „Provider-Warteschlangen-ID" (external_ID) im Datensatz „Awa_Queue" zugeordnet werden. Datentyp: Zeichenfolge Tabelle: Warteschlange \[Awa_Queue\] |
| Übertragen | Erforderlich für Transferzuweisungen. Objekt mit Informationen zur Übertragung. Wenn für diesen Parameter ein Wert angegeben wird, wird die Zuweisung als Übertragungszuweisung betrachtet. Datentyp: Objekt { "source_queue_id": "String", "target_id": "String", "target_type": "String", "transfer_type": "String" } |
| Transfer.Source_Queue_ID | Erforderlich für Transferzuweisungen. Quellwarteschlange, aus der die Übertragung initiiert wird. SYS_ID des Warteschlangendatensatzes oder des Warteschlangenbezeichners in einem externen System. Wenn eine Warteschlange_ID aus einem externen System verwendet wird, muss sie dem Feld „Provider-Warteschlangen-ID" (external_ID) im Datensatz „Awa_Queue" zugeordnet werden. Dieser Parameter wird verwendet, um ein Arbeitselement zu erstellen, bevor die Übertragung initiiert wird, wenn kein aktives Arbeitselement gefunden wird. Ermöglicht die Durchführung von Übertragungen, wenn die ursprüngliche Interaktion ohne Weiterleitung erstellt wurde, z. B. für ausgehende Anrufe. Datentyp: Zeichenfolge Tabelle: Warteschlange \[Awa_Queue\] |
| Transfer.target_ID | Erforderlich für Transferzuweisungen. SYS_ID des Agenten- oder Warteschlangendatensatzes, an den die Zuweisung übertragen werden soll. * Wenn target_typeIst `Service Desk-Mitarbeiter `, target_idIst die sys_ID des Agenten-Anwenderdatensatzes in der Anwendertabelle \[sys_user\]. * Wenn target_typeIst `Warteschlange `, target_idIst die sys_ID des Warteschlangendatensatzes in der Tabelle „Warteschlange \[Awa_Queue\]" oder der Warteschlangenbezeichner in einem externen System. {#awa-offer-work-POST-docs-offer__ul_arh_1zw_c2c} Datentyp: Zeichenfolge |
| Transfer.target_type | Erforderlich für Transferzuweisungen. Typ des Datensatzes, an den die Zuweisung übertragen werden soll. Gültige Werte: * Service Desk-Mitarbeiter * Warteschlange {#awa-offer-work-POST-docs-offer__ul_irj_lwv_sdc} Datentyp: Zeichenfolge |
| Transfer.Transfer_type | Erforderlich für Transferzuweisungen. Typ der Übertragung. Gültige Werte: * Blind * Konsultieren {#awa-offer-work-POST-docs-offer__ul_nds_zbw_sdc} Datentyp: Zeichenfolge |
[Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)]

### 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](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#awa-offer-work-POST-docs-offer__entry__46}{#awa-offer-work-POST-docs-offer__accept-RESTAPI}{#awa-offer-work-POST-docs-offer__content_type-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 4. Anforderungskopfzeilen.]

{#awa-offer-work-POST-docs-offer__entry__52}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### 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](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#awa-offer-work-POST-docs-offer__entry__56}{#awa-offer-work-POST-docs-offer__entry-200-status-code}{#awa-offer-work-POST-docs-offer__entry-401-status-code}{#awa-offer-work-POST-docs-offer__entry-404-status-code}{#awa-offer-work-POST-docs-offer__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 409 | Konflikt. Die Anforderung konnte aufgrund eines Fehlers mit dem Arbeitselement oder der sys_ID des angegebenen Mitarbeiters nicht verarbeitet werden |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#awa-offer-work-POST-docs-offer__entry__68}

| Name | Beschreibung |
|-|-|
| Nachricht | Antwortnachricht mit Informationen zum Erfolg oder Fehler der Zuweisung. Mögliche Werte: * `Manuelle Zuweisung erfolgreich angefordert `-- Erfolg. * `Anrufer-<API_caller_sys_id> hat nicht die Rolle „Awa_Manager" oder „Awa_Integration_user" `-- Der authentifizierte Anwender, der die API-Anforderung stellt, muss entweder die Rolle „Awa_Manager" oder „Awa_Integration_user" haben. * `Akzeptiertes Arbeitselement kann nicht zugewiesen werden `-- Arbeitselement kann nicht zugewiesen werden, da es bereits von einem Service Desk-Mitarbeiter akzeptiert wurde. Weitere Informationen finden Sie unter [Check work items and AWA events](https://www.servicenow.com/docs/access?context=awa-work-items-all&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). * `<agent_sys_id> ist kein gültiger Agent `-- Service Desk-Mitarbeiter hat nicht die Rolle „Awa_Agent". * `Übertragung fehlgeschlagen -- blinde Übertragung an Service Desk-Mitarbeiter konnte nicht durchgeführt werden `-- Zuweisung wurde nicht übertragen, da sich der Service Desk-Mitarbeiter nicht im Status „verfügbar" in AWA befindet. * `Arbeitselement ist bereits <agent_sys_id> zugewiesen `-- Angegebenes Arbeitselement ist einem anderen Service Desk-Mitarbeiter zugewiesen. * `Agent ist nicht verfügbar `-- Service Desk-Mitarbeiter befindet sich nicht im Status „verfügbar" in AWA. Weitere Informationen finden Sie unter [Steuerungen für Posteingang des Service Desk-Mitarbeiters](https://www.servicenow.com/docs/access?context=agent-experience&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). * `Zeitüberschreitungswert darf nicht negativ sein `-- Angegebener Zeitüberschreitungswert darf nicht negativ sein. * `<presence_state_sys_id> ist kein gültiger Anwesenheitsstatus `-- Angegebene sys_ID des Anwesenheitsstatus ist in der Tabelle „AWA-Anwesenheitsstatus" \[Awa_presence_State\] nicht vorhanden. * `Angebotene Zeit (<offered_on_timestamp>) muss das folgende Format haben: jjjj-MM-tt'T'HH:mm:ss.SSS `-- Angegebener Offered_on-Zeitstempel muss das angegebene Format verwenden. * `Die angebotene Zeit (<offered_on_timestamp>) muss vor der aktuellen Zeit liegen, andernfalls hat der Service Desk-Mitarbeiter mehr Zeit, um das Arbeitselement zu akzeptieren `-- Angegebener Offered_on-Zeitstempel darf nicht vor dem Zeitpunkt liegen, zu dem die Anforderung gestellt wird. * `Der Zeitstempel nach der Zeitüberschreitung (<offered_on_timestamp >) muss nach der aktuellen Zeit liegen, andernfalls hat der Service Desk-Mitarbeiter keine Zeit, das Arbeitselement zu akzeptieren `-- Der Zeitstempel nach dem Hinzufügen des Zeitüberschreitungswerts zum angegebenen Zeitstempel von „Offered_on" muss nach dem Zeitpunkt liegen, zu dem die Anforderung gestellt wurde. * `<display_option> ist keine gültige Anzeigeoption `-- Angegebene Display_Option muss einer der folgenden Werte sein: `Karte_nur `Oder `Karte_und_Registerkarte `. * `%S ist kein gültiger boolescher Wert `-- Angegebener boolescher Wert muss eines der folgenden Formate verwenden: `ja/Nein `, `Wahr/falsch `, `1/0 `. * `Der Anwender hat nicht die Rolle „Awa_external_user" `-- Der Service Desk-Mitarbeiter, der die Zuweisung erhält, muss über die Rolle „Awa_external_user" verfügen. * `Dokument ist nicht aktiv `-- Angegebenes Dokument muss aktiv sein und darf sich nicht im Status „Geschlossen" befinden. {#awa-offer-work-POST-docs-offer__ul_lrr_2nw_sdc} |
| Erfolg | Kennzeichnung, die angibt, ob die Zuweisung erfolgreich ist. Mögliche Werte: * Wahr: Zuweisung erfolgreich. * Falsch: Zuweisung nicht erfolgreich. {#awa-offer-work-POST-docs-offer__ul_pz5_tmw_sdc} Datentyp: Boolescher Wert |
| Work_item | Details zum erstellten oder aktualisierten Arbeitselement. Datentyp: Objekt { "display_name": "String", "document_id": "String", "document_table": "String", "queue": "String", "sys_id": "String" } |
| Work_item.Display_Name | Anzeigename des Dokumentdatensatzes. Datentyp: Zeichenfolge |
| Work_item.document_ID | SYS_ID des Dokumentdatensatzes. Datentyp: Zeichenfolge |
| Work_item.document_table | Name der Tabelle, die dem Dokument zugeordnet ist. Datentyp: Zeichenfolge |
| Work_item.Queue | SYS_ID des Warteschlangendatensatzes oder des Warteschlangenbezeichners in einem externen System. Datentyp: Zeichenfolge Tabelle: Warteschlange \[Awa_Queue\] |
| Work_item.sys_ID | SYS_ID des Arbeitselements. Datentyp: Zeichenfolge Tabelle: Arbeitselement \[Awa_work_item\] |
[ ]

### Curl-Anforderung

Dieses Beispiel zeigt, wie einem Service Desk-Mitarbeiter ein Arbeitselement zugewiesen wird.

    curl "https://instance.servicenow.com/api/now/awa/documents/interaction/59616aba87bd5210be070d48dabb35e6/offer" \ 
    --request POST \ 
    --header "Accept:application/json" \ 
    --header "Content-Type:application/json" \ 
    --data '{ 
        "external_segment_id": "segment_59616aba87bd5210be070d48dabb35e6", 
        "queue_id": "92f8942787851210be070d48dabb35fb", 
        "assignment": { 
            "agent_sys_id": "0d584509c323120095ccd02422d3ae5b", 
            "allowed_to_decline": "true", 
            "enable_auto_assign": "false", 
            "timeout": 30, 
            "offered_on":"2024-04-03T23:09:31.000" 
        } 
    }' 
    --user 'username':'password'

Die Antwort zeigt an, dass das Arbeitselement dem Service Desk-Mitarbeiter erfolgreich zugewiesen wurde. Sie können das Ergebnis im Feld Zugewiesen an des Arbeitselement-Datensatzes \[Awa_work_item\] überprüfen.

    { 
       "result": { 
          "work_item": { 
             "display_name": "Interaction: IMS0000221", 
             "sys_id": "bfa3a27e87bd5210be070d48dabb3588", 
             "document_id": "59616aba87bd5210be070d48dabb35e6", 
             "document_table": "interaction", 
             "queue": "92f8942787851210be070d48dabb35fb" 
          }, 
          "success": true, 
          "message": "Manual assignment successfully requested." 
       } 
    }


