---
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-Agenten-API

# AWA-Agenten-API {#ariaid-title1}

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

Die AWA-Mitarbeiter (erweiterte Arbeitszuweisung) Die API stellt Endpunkte zur Verwaltung der Service Desk-Mitarbeiter-Anwesenheit, Kanalverfügbarkeit und Arbeitsauslastung bereit.
Diese API erfordert Erweiterte ArbeitszuweisungPlugin (com.Glide.awa) und die Rolle „Awa_Integration_user". Weitere Informationen finden Sie unter [Erweiterte Arbeitszuweisung](https://www.servicenow.com/docs/access?context=awa-overview&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US).

## AWA Agent -- GET /now/awa/Agents/{user_ID} {#ariaid-title2}

Gibt den aktuellen Anwesenheitsstatus des Service Desk-Mitarbeiters und die Kanalverfügbarkeit zurück.

### URL-Format {#awa-GET-agents__section_hsf_jvl_cmb}

Versionierte URL: /api/now/{api_Version}/Awa/Agents/{user_ID}

Standard-URL: /api/now/awa/Agents/{user_ID}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#awa-GET-agents__entry__2}{#awa-GET-agents__version-not_optional-RESTAPI}{#awa-GET-agents__awa-api-ph-work_item_id}

| 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 |
| user_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 Steht Aus status. {#awa-GET-agents__ul_zcs_rh3_htb} Datentyp: Zeichenfolge Tabelle: AWA-Arbeitselement \[Awa_work_item\] |
[Tabelle : 1. Pfad-Parameter]

{#awa-GET-agents__entry__8}

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

{#awa-GET-agents__presence__entry__2}{#awa-GET-agents__ph-presence_channels_avail-awa}{#awa-GET-agents__ph-presence_channels_sys_id-awa}{#awa-GET-agents__ph-presence_sys_id-awa}

| Header | Beschreibung |
|-|-|
| presence.channels.available | Kennzeichnung, die angibt, ob der Kanal verfügbar ist. Mögliche Werte: * Wahr: Kanal ist verfügbar. * Falsch: Kanal ist nicht verfügbar. {#awa-GET-agents__ul_qps_xwl_cmb} Datentyp: Boolescher Wert |
| presence.channels.sys_id | Kanal-sys_ID Datentyp: Zeichenfolge Tabelle: Servicekanäle \[Awa_Service_Channel\] |
| Presence.sys_ID | Anwesenheitsstatus sys_ID Datentyp: Zeichenfolge Tabelle: Anwesenheitsstatus \[Awa_presence_State\] |
[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-GET-agents__entry__20}{#awa-GET-agents__accept-RESTAPI}{#awa-GET-agents__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-GET-agents__entry__26}

| 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-GET-agents__entry__30}{#awa-GET-agents__entry-200-status-code}{#awa-GET-agents__entry-400-status-code}{#awa-GET-agents__entry-401-status-code}{#awa-GET-agents__entry-403-status-code-awa}{#awa-GET-agents__entry-404-status-code}{#awa-GET-agents__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte 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".{#awa-GET-agents__li-403-role} * 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](https://www.servicenow.com/docs/access?context=installed-with-awa&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). {#awa-GET-agents__li-403-awa-disabled} {#awa-GET-agents__ul_gch_n34_tsb} |
| 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. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#awa-GET-agents__table_r2q_fbm_cmb__entry__2}{#awa-GET-agents__awa-api-entry-error}{#awa-GET-agents__awa-api-ph-error_detail}{#awa-GET-agents__awa-api-ph-error_message}{#awa-GET-agents__ph-presence-awa}{#awa-GET-agents__ph-presence_available-awa}{#awa-GET-agents__ph-presence_channels-awa}{#awa-GET-agents__d6562e341}{#awa-GET-agents__ph-presence_channels_name-awa}{#awa-GET-agents__d6562e409}{#awa-GET-agents__ph-presence_name-awa}{#awa-GET-agents__ph-presence_restrict_update-awa}{#awa-GET-agents__d6562e471}{#awa-GET-agents__awa-api-entry_status}{#awa-GET-agents__ph-sys_id-awa}{#awa-GET-agents__open-workItem_document-ph}{#awa-GET-agents__open-workItem_document_sysid-ph}{#awa-GET-agents__open-workItem_document_table-ph}{#awa-GET-agents__open-workItem_previousWorkItem-ph}{#awa-GET-agents__open-workItem_serviceChannel-ph}{#awa-GET-agents__open-workItem_serviceChannel_name-ph}{#awa-GET-agents__open-workItem_serviceChannel_sys_id-ph}{#awa-GET-agents__open-workItem_size-ph}{#awa-GET-agents__open-workItem_sysid-ph}{#awa-GET-agents__open-workItem_isQueueTransferred-ph}{#awa-GET-agents__open-workItem_isAutoAccepted-ph}

| Parameter | Beschreibung |
|-|-|
| 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. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht für den während des Anforderungsprozesses aufgetretenen Fehler. Jede Fehlermeldung hat eine entsprechende Beschreibung in detailEigenschaft. Mögliche Werte: * Datensatz Nicht Gefunden : Die im Anforderungstext angegebenen Informationen sind ungenau oder nicht vorhanden. * Anwender Nicht Authentifiziert : Anwender hat nicht die Rolle „Awa_Integration_user". {#awa-GET-agents__ul_om3_5sq_tsb} Datentyp: Zeichenfolge |
| Anwesenheit | Informationen zum aktuellen Anwesenheitsstatus und -Kanal eines Service Desk-Mitarbeiters. Datentyp: Objekt "presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" } |
| Anwesenheit.verfügbar | Kennzeichnung, die angibt, ob der Agent verfügbar ist. Mögliche Werte: * Wahr: Agent ist verfügbar. * Falsch: Agent ist nicht verfügbar. {#awa-GET-agents__ul_ezb_kwl_cmb} Datentyp: Boolescher Wert |
| presence.channels | Liste von Objekten, die die verfügbaren Kommunikationskanäle mit dem Service Desk-Mitarbeiter beschreiben. Datentyp: Array von Objekten "channels": [ { "available": Boolean, "name": "String", "sys_id": "String" } ] |
| presence.channels.available | Kennzeichnung, die angibt, ob der Kanal verfügbar ist. Mögliche Werte: * Wahr: Kanal ist verfügbar. * Falsch: Kanal ist nicht verfügbar. {#awa-GET-agents__d6562e346} Datentyp: Boolescher Wert |
| presence.channels.name | Kanalname, z. B. Chat oder Telefon. Datentyp: Zeichenfolge |
| presence.channels.restrict_update | Kennzeichnung, die angibt, ob der Anwender Updates einschränken kann, d. h. den Kanal für die Verfügbarkeit auswählen kann. Mögliche Werte: * Wahr: Der Anwender kann diesen Kanal aus Verfügbarkeitsgründen auswählen. * Falsch: Der Anwender kann diesen Kanal nicht für die Verfügbarkeit auswählen. {#awa-GET-agents__ul_xjk_kn4_tsb} Datentyp: Boolescher Wert |
| presence.channels.service_channel_type | Servicekanaltyp, z. B. Chat. Mögliche Werte variieren je nach installierten Plugins. Datentyp: Zeichenfolge |
| presence.channels.sys_id | Kanal-sys_ID Datentyp: Zeichenfolge Tabelle: Servicekanäle \[Awa_Service_Channel\] |
| presence.name | Name des Anwesenheitsstatus des Service Desk-Mitarbeiters. Mögliche Werte: * Verfügbar * Nicht verfügbar {#awa-GET-agents__ul_mlm_mxl_cmb} Datentyp: Zeichenfolge |
| Presence.Restrict_Update | Kennzeichnung, die angibt, ob der Anwender Updates einschränken kann. Mögliche Werte: * Wahr: Anwender kann Updates einschränken. * Falsch: Anwender kann Aktualisierungen nicht einschränken. {#awa-GET-agents__ul_dfh_cxl_cmb} Datentyp: Boolescher Wert |
| Presence.sys_ID | Anwesenheitsstatus sys_ID Datentyp: Zeichenfolge Tabelle: Anwesenheitsstatus \[Awa_presence_State\] |
| Status | Status einer nicht erfolgreichen Anforderung. Diese Eigenschaft ist nur in der Antwort enthalten, wenn ein Fehler auftritt. Gültiger Wert: Fehler Datentyp: Zeichenfolge |
| sys_id | Sys_ID des Service Desk-Mitarbeiters Datentyp: Zeichenfolge |
| workItem | workItem: Informationen zum Arbeitselement, das dem Ereignis zugeordnet ist.{#awa-GET-agents__open-workItem-p} Datentyp: Zeichenfolge |
| Arbeitselement.Dokument | workItem.document: Liste der Dokumente, die der Arbeitselementaufgabe zugeordnet sind. Datentyp: Zeichenfolge |
| Arbeitselement.document.sys_ID | workItem.document.sys_id: SYS_ID des Dokuments, das der Arbeitselementaufgabe zugewiesen ist. Datentyp: Zeichenfolge |
| Arbeitselement.Dokument.Tabelle | workItem.document.table: Name der Dokumenttabelle, die der Aufgabe zugewiesen ist. Datentyp: Zeichenfolge |
| Arbeitselement.vorherige Arbeitselement | workItem.previousWorkItem: SYS_ID des vorherigen Arbeitselements für dieselbe Dokument-ID. Für die nicht übertragenen Arbeitselemente ist dieser Wert leer. Datentyp: Zeichenfolge |
| workItem.serviceChannel | workItem.serviceChannel: Liste der Servicekanäle, die der Arbeitselementaufgabe zugeordnet sind. Datentyp: Zeichenfolge |
| workItem.serviceChannel.name | workItem.serviceChannel.name: Name des Servicekanals, z. B. Chat oder Telefon. Datentyp: Zeichenfolge |
| workItem.serviceChannel.sys_id | workItem.serviceChannel.sys_id: SYS_ID des Servicekanals. Datentyp: Zeichenfolge |
| Arbeitselement.Größe | workItem.size: Kapazität des Service Desk-Mitarbeiters, die verwendet wird, wenn dieses Arbeitselement dem Service Desk-Mitarbeiter zugewiesen wird. Datentyp: Zeichenfolge |
| Arbeitselement.sys_ID | workItem.sys_id: SYS_ID des Arbeitselements, das akzeptiert oder angeboten wurde. Datentyp: Zeichenfolge |
| Arbeitselement.isQueueTransferred | workItem.isQueueTransferred: Kennzeichnung, die angibt, ob das Arbeitselement in der Warteschlange übertragen wurde. Legen Sie den Wert auf „wahr" fest, wenn das Arbeitselement in der Warteschlange übertragen wird, oder auf „falsch", wenn dies nicht der Fall ist Weitere Informationen zu Warteschlangenübertragungen finden Sie unter [Transfer a chat to another queue](https://www.servicenow.com/docs/access?context=transfer-chat-queue&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US). Datentyp: Boolescher Wert |
| arbeitselement.isautomatisch akzeptiert | workItem.isAutoAccepted: Kennzeichnung, die angibt, ob das Arbeitselement automatisch vom System akzeptiert wurde. Auf „wahr" festlegen, wenn das Arbeitselement automatisch akzeptiert wurde. Datentyp: Boolescher Wert |
[Tabelle : 7. Antworttext-Parameter (JSON oder XML)]

{#awa-GET-agents__table_r2q_fbm_cmb}  

### Beispiel für Curl-Anforderung

    curl -X GET \
    https://instance.servicenow.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666 \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -u 'username':'password'\

    {
      "result": {
        "presence": {
          "name": "Available",
          "sys_id": "0b10223c57a313005baaaa65ef94f970",
          "available": true,
          "channels": [
            {
              "name": "Chat",
              "available": true,
              "sys_id": "27f675e3739713004a905ee515f6a7c3"
            }
          ]
        },
        "sys_id": "46d44a23a9fe19810012d100cca80666"
      }
    }

## AWA Agent -- RUFT /now/awa/Agents/{user_ID}/Capacties AB {#ariaid-title3}

Gibt die Kanalkapazitäten eines Service Desk-Mitarbeiters, die universelle Kapazität und die aktuelle Arbeitsauslastung zurück, um zu sehen, ob der Service Desk-Mitarbeiter einen Fall bearbeiten kann.
Verwenden Sie [AWA Service Desk-Mitarbeiter -- PUT /now/awa/Agents/{user_ID}/Capacties](https://servicenow-prod.fluidtopics.net/pkYpt7WgN2eAVuYGyvkTDg#awa-PUT-capacities "Ermöglicht das Aktualisieren der maximalen Kapazität (Arbeitsauslastung) eines Service Desk-Mitarbeiters für Kanalkapazitäten und universelle Kapazität.")Methode zum Ändern des Kanals und der universellen Kapazitäten eines Service Desk-Mitarbeiters.  
Siehe auch:

* [Kapazität und Auslastung des Servicekanals](https://www.servicenow.com/docs/access?context=awa-service-channel-capacity&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)
* [Erstellen oder konfigurieren Sie einen Servicekanal](https://www.servicenow.com/docs/access?context=awa-create-service-channel&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)
* [Konfigurieren Sie die maximale universelle Kapazität eines Service Desk-Mitarbeiters](https://www.servicenow.com/docs/access?context=awa-universal-capacity&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)
{#awa-GET-capacities__ul_rl1_2wg_jtb}

### URL-Format {#awa-GET-capacities__section_hsf_jvl_cmb}

Versionierte URL: /api/now/{api_Version}/Awa/Agents/{user_ID}/Capacties

Standard-URL: /api/now/Awa/Agents/{user_ID}/Capacties  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter {#awa-GET-capacities__section_vg3_ydq_htb}

{#awa-GET-capacities__table_wg3_ydq_htb__entry__2}{#awa-GET-capacities__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 |
| user_id | SYS_ID des aufgelisteten Agenten. Datentyp: Zeichenfolge Tabelle: Anwender \[sys_user\] |
[Tabelle : 8. Pfad-Parameter]

{#awa-GET-capacities__table_wg3_ydq_htb} {#awa-GET-capacities__table_xg3_ydq_htb__entry__2}

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

{#awa-GET-capacities__table_xg3_ydq_htb} {#awa-GET-capacities__table_yg3_ydq_htb__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 10. Anforderungstext-Parameter (XML oder JSON)]

{#awa-GET-capacities__table_yg3_ydq_htb}

### Header {#awa-GET-capacities__section_zg3_ydq_htb}

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-GET-capacities__table_ah3_ydq_htb__entry__2}{#awa-GET-capacities__accept-RESTAPI}

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

{#awa-GET-capacities__table_ah3_ydq_htb} {#awa-GET-capacities__table_bh3_ydq_htb__entry__2}

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

{#awa-GET-capacities__table_bh3_ydq_htb}

### Statuscodes {#awa-GET-capacities__section_ch3_ydq_htb}

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-GET-capacities__table_dh3_ydq_htb__entry__2}{#awa-GET-capacities__entry-200-status-code}{#awa-GET-capacities__entry-400-status-code}{#awa-GET-capacities__entry-401-status-code}{#awa-GET-capacities__entry-403-status-code-awa}{#awa-GET-capacities__entry-404-status-code}{#awa-GET-capacities__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte 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".{#awa-GET-capacities__li-403-role} * 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](https://www.servicenow.com/docs/access?context=installed-with-awa&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). {#awa-GET-capacities__li-403-awa-disabled} {#awa-GET-capacities__ul_gch_n34_tsb} |
| 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. |
[Tabelle : 13. Statuscodes]

{#awa-GET-capacities__table_dh3_ydq_htb}

### Antworttext-Parameter (JSON oder XML) {#awa-GET-capacities__section_agk_dmp_htb}

{#awa-GET-capacities__table_bgk_dmp_htb__entry__2}{#awa-GET-capacities__ph-presence_channels_sys_id-awa}{#awa-GET-capacities__ordr-row-error}{#awa-GET-capacities__awa-api-ph-universal_capacity}

| Name | Beschreibung |
|-|-|
| Kanäle | Liste von Objekten, die die verfügbaren Kommunikationskanäle mit dem Service Desk-Mitarbeiter beschreiben. "channels": [ { "channel_sys_id": "String", "current_workload": Number, "max_capacity": Number } ] Datentyp: Array |
| channels.channel_sys_id | Kanal-sys_ID Datentyp: Zeichenfolge Tabelle: Servicekanäle \[Awa_Service_Channel\] |
| Channels.current_Workload | Anzahl der Arbeitselemente in einem bestimmten Servicekanal, die dem Service Desk-Mitarbeiter derzeit zugewiesen sind. Datentyp: Zahl |
| Channels.max_Capacity | Maximale Arbeitsauslastung in einem bestimmten Servicekanal, dem der Service Desk-Mitarbeiter gleichzeitig aktiv zugewiesen werden kann. Datentyp: Zeichenfolge |
| 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. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht 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 in der Antwort enthalten, wenn ein Fehler auftritt. Gültiger Wert: Fehler Datentyp: Zeichenfolge |
| Universal_Capacity | Maximale Kapazität für den Service Desk-Mitarbeiter in allen Servicekanälen. Wenn die aktuelle Arbeitsauslastung eines Service Desk-Mitarbeiters der maximalen universellen Kapazität entspricht, werden dem Service Desk-Mitarbeiter keine zusätzlichen Arbeitselemente zugewiesen. Diese Eigenschaft gibt nur zurück, wenn für diesen Service Desk-Mitarbeiter ein universelle Kapazitätsdatensatz vorhanden ist. Datentyp: Zahl |
| Universal_Workload | Anzahl der Arbeitselemente in allen Servicekanälen, die derzeit dem angegebenen Service Desk-Mitarbeiter zugewiesen sind. Diese Eigenschaft gibt nur zurück, wenn für den Service Desk-Mitarbeiter ein Datensatz für die universelle Kapazität vorhanden ist. Datentyp: Zahl |
[ ]

{#awa-GET-capacities__table_bgk_dmp_htb}  

### Beispiel für Curl-Anforderung {#awa-GET-capacities__example_eh3_ydq_htb}

Das folgende Beispiel zeigt, wie die Werte für Kapazität und Arbeitsauslastung für einen Anwender abgerufen werden.

    curl "https://instance.service-now.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666/capacities" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

Eine erfolgreiche Antwort enthält Kapazitätswerte und Arbeitsauslastung für jeden Kanal.

    {
      "result": {
        "universal_workload": 2,
        "channels": [
          {
            "channel_sys_id": "27f675e3739713004a905ee515f6a7c3",
            "current_workload": 2,
            "max_capacity": 4
          }
        ],
        "universal_capacity": 10
      }
    }

## AWA Agent -- RUFT /now/awa/Agents/{user_ID}/presence_states AB {#ariaid-title4}

Gibt die anwesenheitsstatus eines Service Desk-Mitarbeiters zurück und gibt an, ob der Service Desk-Mitarbeiter verfügbar ist oder sich in einem anderen Anwesenheitsstatus befindet.

### URL-Format {#awa-GET-presence_states__section_hsf_jvl_cmb}

Versionierte URL: /api/now/{api_Version}/Awa/Agents/{user_ID}/presence_states

Standard-URL: /api/now/Awa/Agents/{user_ID}/presence_states  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#awa-GET-presence_states__entry__2}{#awa-GET-presence_states__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 |
| user_id | SYS_ID des aufgelisteten Agenten. Datentyp: Zeichenfolge Tabelle: Anwender \[sys_user\] |
[Tabelle : 14. Pfad-Parameter]

{#awa-GET-presence_states__entry__8}

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

{#awa-GET-presence_states__entry__12}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 16. 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-GET-presence_states__entry__16}{#awa-GET-presence_states__accept-RESTAPI}

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

{#awa-GET-presence_states__entry__20}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 18. 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-GET-presence_states__entry__24}{#awa-GET-presence_states__entry-200-status-code}{#awa-GET-presence_states__entry-400-status-code}{#awa-GET-presence_states__entry-401-status-code}{#awa-GET-presence_states__entry-403-status-code-awa}{#awa-GET-presence_states__entry-404-status-code}{#awa-GET-presence_states__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte 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".{#awa-GET-presence_states__li-403-role} * 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](https://www.servicenow.com/docs/access?context=installed-with-awa&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). {#awa-GET-presence_states__li-403-awa-disabled} {#awa-GET-presence_states__ul_gch_n34_tsb} |
| 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. |
[Tabelle : 19. Statuscodes]

### Antworttext-Parameter (JSON oder XML) {#awa-GET-presence_states__section_agk_dmp_htb}

{#awa-GET-presence_states__table_bgk_dmp_htb__entry__2}{#awa-GET-presence_states__ordr-row-error}{#awa-GET-presence_states__ph-presence_available-awa}{#awa-GET-presence_states__ph-presence_channels_avail-awa}{#awa-GET-presence_states__ph-presence_channels_name-awa}{#awa-GET-presence_states__ph-presence_channels_sys_id-awa}{#awa-GET-presence_states__ph-presence_sys_id-awa}

| Name | Beschreibung |
|-|-|
| 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. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht für den während des Anforderungsprozesses aufgetretenen Fehler.Die Beschreibung wird in bereitgestellt error.detailEigenschaft. Datentyp: Zeichenfolge |
| \<presence state\> | Liste der Anwesenheitsstatusdefinitionen des Service Desk-Mitarbeiters als Objekte. Jedes Objekt beschreibt den Status und enthält die Kanäle des Service Desk-Mitarbeiters. Datentyp: Array { "available": Boolean, "channels": [Array], "disable_inactivity_check": Boolean, "name": "String", "show_channels": Boolean, "sys_id": "String" } |
| \<presence state\>.verfügbar | Kennzeichnung, die angibt, ob der Agent verfügbar ist. Mögliche Werte: * Wahr: Agent ist verfügbar. * Falsch: Agent ist nicht verfügbar. {#awa-GET-presence_states__ul_ezb_kwl_cmb} Datentyp: Boolescher Wert |
| \<presence state\>.Kanäle | Liste von Objekten, die die verfügbaren Kommunikationskanäle mit dem Service Desk-Mitarbeiter beschreiben. Datentyp: Array "channels": [ { "available": Boolean, "name": "String", "restrict_update": Boolean, "service_channel_type": "String", "sys_id": "String" } ] |
| \<presence state\>.Kanäle.verfügbar | Kennzeichnung, die angibt, ob der Kanal verfügbar ist. Mögliche Werte: * Wahr: Kanal ist verfügbar. * Falsch: Kanal ist nicht verfügbar. {#awa-GET-presence_states__ul_qps_xwl_cmb} Datentyp: Boolescher Wert |
| \<presence state\>.channels.name | Kanalname, z. B. Chat oder Telefon. Datentyp: Zeichenfolge |
| \<presence state\>.Kanäle.sys_ID | Kanal-sys_ID Datentyp: Zeichenfolge Tabelle: Servicekanäle \[Awa_Service_Channel\] |
| \<presence state\>.disable_inactivity_Check | Kennzeichnung, die angibt, ob auf Inaktivität dieses Anwesenheitsstatus geprüft werden soll. Gültige Werte: * Wahr: Die Prüfung der Inaktivität des Anwesenheitsstatus ist deaktiviert. * Falsch: Die Inaktivitätsprüfung des Anwesenheitsstatus ist aktiviert. {#awa-GET-presence_states__ul_alm_cjn_jtb} Datentyp: Boolescher Wert Standard: Falsch Informationen zum Ändern dieser Einstellung finden Sie unter [Konfigurieren Sie die anwesenheitsstatus des Service Desk](https://www.servicenow.com/docs/access?context=awa-configure-agent-presence&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). |
| \<presence state\>.Name | Name des Anwesenheitsstatus des Service Desk-Mitarbeiters.Die standardmäßig installierten anwesenheitsstatus sind Verfügbar , Abwesend , Und Offline . Datentyp: Zeichenfolge |
| \<presence state\>.Reihenfolge | Reihenfolge, in der dieser Status im Posteingang des Service Desk-Mitarbeiters angezeigt wird. Datentyp: Zahl |
| \<presence state\>.Show_channels | Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter die Berechtigung zum Ändern des Anwesenheitsstatus hat, z. B. von „verfügbar" in „Abwesend". Gültige Werte: * Wahr: Der Anwender hat die Berechtigung, die Anwesenheit zu ändern. * Falsch: Der Anwender darf die Anwesenheit nicht ändern. {#awa-GET-presence_states__ul_qlh_xlh_jtb} Datentyp: Boolescher Wert |
| \<presence state\>.sys_ID | Anwesenheitsstatus sys_ID Datentyp: Zeichenfolge Tabelle: Anwesenheitsstatus \[Awa_presence_State\] |
| Status | Status einer nicht erfolgreichen Anforderung. Diese Eigenschaft ist nur in der Antwort enthalten, wenn ein Fehler auftritt. Gültiger Wert: Fehler Datentyp: Zeichenfolge |
[ ]

{#awa-GET-presence_states__table_bgk_dmp_htb}  

### Beispiel für Curl-Anforderung

Das folgende Beispiel zeigt, wie die anwesenheitsstatus für einen angegebenen Service Desk-Mitarbeiter abgerufen werden.

    curl "https://instance.service-now.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666/presence_states" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

Der Antworttext listet die möglichen anwesenheitsstatus des Service Desk-Mitarbeiters auf und gibt an, dass der Service Desk-Mitarbeiter verfügbar ist.

    {
      "result": [
        {
          "name": "Available",
          "order": 0,
          "show_channels": false,
          "sys_id": "0b10223c57a313005baaaa65ef94f970",
          "available": true,
          "channels": [
            {
              "name": "Chat",
              "available": true,
              "sys_id": "27f675e3739713004a905ee515f6a7c3",
              "restrict_update": false,
              "service_channel_type": "chat"
            }
          ],
          "disable_inactivity_check": false
        },
        {
          "name": "Away",
          "order": 1000,
          "show_channels": false,
          "sys_id": "41f9b8dfb31313005baa6e5f26a8dcac",
          "available": false,
          "channels": [],
          "disable_inactivity_check": false
        },
        {
          "name": "Offline",
          "order": 2000,
          "show_channels": false,
          "sys_id": "9cd83267575313005baaaa65ef94f98b",
          "available": false,
          "channels": [],
          "disable_inactivity_check": false
        }
      ]
    }

## AWA Agent -- PUT /now/awa/Agents/{user_ID} {#ariaid-title5}

Legt den Status der Anwesenheit eines angegebenen Service Desk-Mitarbeiters fest und, falls angegeben, die Kanalverfügbarkeit des Service Desk-Mitarbeiters für diesen Status.

### URL-Format {#awa-PUT-agents__section_qzs_ncm_cmb}

Versionierte URL: /api/now/{api_Version}/Awa/Agents/{user_ID}

Standard-URL: /api/now/awa/Agents/{user_ID}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#awa-PUT-agents__entry__2}{#awa-PUT-agents__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 |
| user_id | SYS_ID des Agenten. Datentyp: Zeichenfolge Tabelle: Anwender \[sys_user\] |
[Tabelle : 20. Pfad-Parameter]

{#awa-PUT-agents__entry__8}

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

{#awa-PUT-agents__entry__12}{#awa-PUT-agents__ph-presence_channels_sys_id-awa}{#awa-PUT-agents__ph-presence_sys_id-awa}

| Name | Beschreibung |
|-|-|
| presence.channels | Liste von Objekten, die definieren, welche Kanäle für den Service Desk-Mitarbeiter verfügbar sind. Datentyp: Array von Objekten "channels": [ { "available": Boolean, "sys_id": "String" } ] |
| presence.channels.available | Kennzeichnung, die angibt, ob der Kanal verfügbar ist. Mögliche Werte: * Wahr: Kanal ist verfügbar. * Falsch: Kanal ist nicht verfügbar. {#awa-PUT-agents__ul_qps_xwl_cmb} Hinweis: Diese Einstellung muss angegeben werden, um Kanäle in den Antworttext einzubeziehen. Datentyp: Boolescher Wert Standard: Falsch |
| presence.channels.sys_id | Kanal-sys_ID Datentyp: Zeichenfolge Tabelle: Servicekanäle \[Awa_Service_Channel\] |
| Presence.sys_ID | Anwesenheitsstatus sys_ID Datentyp: Zeichenfolge Tabelle: Anwesenheitsstatus \[Awa_presence_State\] |
[Tabelle : 22. 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-PUT-agents__entry__22}{#awa-PUT-agents__accept-RESTAPI}{#awa-PUT-agents__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 : 23. Anforderungskopfzeilen.]

{#awa-PUT-agents__entry__28}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 24. 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-PUT-agents__entry__32}{#awa-PUT-agents__entry-200-status-code}{#awa-PUT-agents__entry-400-status-code}{#awa-PUT-agents__entry-401-status-code}{#awa-PUT-agents__entry-403-status-code-awa}{#awa-PUT-agents__entry-404-status-code}{#awa-PUT-agents__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte 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".{#awa-PUT-agents__li-403-role} * 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](https://www.servicenow.com/docs/access?context=installed-with-awa&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US). {#awa-PUT-agents__li-403-awa-disabled} {#awa-PUT-agents__ul_gch_n34_tsb} |
| 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. |
[Tabelle : 25. Statuscodes]

{#awa-PUT-agents__table_rcs_b2m_cmb__entry__2}{#awa-PUT-agents__awa-api-entry-error}{#awa-PUT-agents__awa-api-ph-error_detail}{#awa-PUT-agents__awa-api-ph-error_message}{#awa-PUT-agents__ph-presence-awa}{#awa-PUT-agents__ph-presence_available-awa}{#awa-PUT-agents__ph-presence_channels-awa}{#awa-PUT-agents__ph-presence_channels_avail-awa}{#awa-PUT-agents__ph-presence_channels_name-awa}{#awa-PUT-agents__d6562e409}{#awa-PUT-agents__ph-presence_name-awa}{#awa-PUT-agents__ph-presence_restrict_update-awa}{#awa-PUT-agents__d6562e471}{#awa-PUT-agents__awa-api-entry_status}{#awa-PUT-agents__ph-sys_id-awa}{#awa-PUT-agents__open-workItem_document-ph}{#awa-PUT-agents__open-workItem_document_sysid-ph}{#awa-PUT-agents__open-workItem_document_table-ph}{#awa-PUT-agents__open-workItem_previousWorkItem-ph}{#awa-PUT-agents__open-workItem_serviceChannel-ph}{#awa-PUT-agents__open-workItem_serviceChannel_name-ph}{#awa-PUT-agents__open-workItem_serviceChannel_sys_id-ph}{#awa-PUT-agents__open-workItem_size-ph}{#awa-PUT-agents__open-workItem_sysid-ph}{#awa-PUT-agents__open-workItem_isQueueTransferred-ph}{#awa-PUT-agents__open-workItem_isAutoAccepted-ph}

| Parameter | Beschreibung |
|-|-|
| 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. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht für den während des Anforderungsprozesses aufgetretenen Fehler. Jede Fehlermeldung hat eine entsprechende Beschreibung in detailEigenschaft. Mögliche Werte: * Datensatz Nicht Gefunden : Die im Anforderungstext angegebenen Informationen sind ungenau oder nicht vorhanden. * Anwender Nicht Authentifiziert : Anwender hat nicht die Rolle „Awa_Integration_user". {#awa-PUT-agents__ul_om3_5sq_tsb} Datentyp: Zeichenfolge |
| Anwesenheit | Informationen zum aktuellen Anwesenheitsstatus und -Kanal eines Service Desk-Mitarbeiters. Datentyp: Objekt "presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" } |
| Anwesenheit.verfügbar | Kennzeichnung, die angibt, ob der Agent verfügbar ist. Mögliche Werte: * Wahr: Agent ist verfügbar. * Falsch: Agent ist nicht verfügbar. {#awa-PUT-agents__ul_ezb_kwl_cmb} Datentyp: Boolescher Wert |
| presence.channels | Liste von Objekten, die die verfügbaren Kommunikationskanäle mit dem Service Desk-Mitarbeiter beschreiben. Datentyp: Array von Objekten "channels": [ { "available": Boolean, "name": "String", "sys_id": "String" } ] |
| presence.channels.available | Kennzeichnung, die angibt, ob der Kanal verfügbar ist. Mögliche Werte: * Wahr: Kanal ist verfügbar. * Falsch: Kanal ist nicht verfügbar. {#awa-PUT-agents__d6562e346} Datentyp: Boolescher Wert |
| presence.channels.name | Kanalname, z. B. Chat oder Telefon. Datentyp: Zeichenfolge |
| presence.channels.restrict_update | Kennzeichnung, die angibt, ob der Anwender Updates einschränken kann, d. h. den Kanal für die Verfügbarkeit auswählen kann. Mögliche Werte: * Wahr: Der Anwender kann diesen Kanal aus Verfügbarkeitsgründen auswählen. * Falsch: Der Anwender kann diesen Kanal nicht für die Verfügbarkeit auswählen. {#awa-PUT-agents__ul_xjk_kn4_tsb} Datentyp: Boolescher Wert |
| presence.channels.service_channel_type | Servicekanaltyp, z. B. Chat. Mögliche Werte variieren je nach installierten Plugins. Datentyp: Zeichenfolge |
| presence.channels.sys_id | Kanal-sys_ID Datentyp: Zeichenfolge Tabelle: Servicekanäle \[Awa_Service_Channel\] |
| presence.name | Name des Anwesenheitsstatus des Service Desk-Mitarbeiters. Mögliche Werte: * Verfügbar * Nicht verfügbar {#awa-PUT-agents__ul_mlm_mxl_cmb} Datentyp: Zeichenfolge |
| Presence.Restrict_Update | Kennzeichnung, die angibt, ob der Anwender Updates einschränken kann. Mögliche Werte: * Wahr: Anwender kann Updates einschränken. * Falsch: Anwender kann Aktualisierungen nicht einschränken. {#awa-PUT-agents__ul_dfh_cxl_cmb} Datentyp: Boolescher Wert |
| Presence.sys_ID | Anwesenheitsstatus sys_ID Datentyp: Zeichenfolge Tabelle: Anwesenheitsstatus \[Awa_presence_State\] |
| Status | Status einer nicht erfolgreichen Anforderung. Diese Eigenschaft ist nur in der Antwort enthalten, wenn ein Fehler auftritt. Gültiger Wert: Fehler Datentyp: Zeichenfolge |
| sys_id | Sys_ID des Service Desk-Mitarbeiters Datentyp: Zeichenfolge |
| workItem | workItem: Informationen zum Arbeitselement, das dem Ereignis zugeordnet ist.{#awa-PUT-agents__open-workItem-p} Datentyp: Zeichenfolge |
| Arbeitselement.Dokument | workItem.document: Liste der Dokumente, die der Arbeitselementaufgabe zugeordnet sind. Datentyp: Zeichenfolge |
| Arbeitselement.document.sys_ID | workItem.document.sys_id: SYS_ID des Dokuments, das der Arbeitselementaufgabe zugewiesen ist. Datentyp: Zeichenfolge |
| Arbeitselement.Dokument.Tabelle | workItem.document.table: Name der Dokumenttabelle, die der Aufgabe zugewiesen ist. Datentyp: Zeichenfolge |
| Arbeitselement.vorherige Arbeitselement | workItem.previousWorkItem: SYS_ID des vorherigen Arbeitselements für dieselbe Dokument-ID. Für die nicht übertragenen Arbeitselemente ist dieser Wert leer. Datentyp: Zeichenfolge |
| workItem.serviceChannel | workItem.serviceChannel: Liste der Servicekanäle, die der Arbeitselementaufgabe zugeordnet sind. Datentyp: Zeichenfolge |
| workItem.serviceChannel.name | workItem.serviceChannel.name: Name des Servicekanals, z. B. Chat oder Telefon. Datentyp: Zeichenfolge |
| workItem.serviceChannel.sys_id | workItem.serviceChannel.sys_id: SYS_ID des Servicekanals. Datentyp: Zeichenfolge |
| Arbeitselement.Größe | workItem.size: Kapazität des Service Desk-Mitarbeiters, die verwendet wird, wenn dieses Arbeitselement dem Service Desk-Mitarbeiter zugewiesen wird. Datentyp: Zeichenfolge |
| Arbeitselement.sys_ID | workItem.sys_id: SYS_ID des Arbeitselements, das akzeptiert oder angeboten wurde. Datentyp: Zeichenfolge |
| Arbeitselement.isQueueTransferred | workItem.isQueueTransferred: Kennzeichnung, die angibt, ob das Arbeitselement in der Warteschlange übertragen wurde. Legen Sie den Wert auf „wahr" fest, wenn das Arbeitselement in der Warteschlange übertragen wird, oder auf „falsch", wenn dies nicht der Fall ist Weitere Informationen zu Warteschlangenübertragungen finden Sie unter [Transfer a chat to another queue](https://www.servicenow.com/docs/access?context=transfer-chat-queue&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US). Datentyp: Boolescher Wert |
| arbeitselement.isautomatisch akzeptiert | workItem.isAutoAccepted: Kennzeichnung, die angibt, ob das Arbeitselement automatisch vom System akzeptiert wurde. Auf „wahr" festlegen, wenn das Arbeitselement automatisch akzeptiert wurde. Datentyp: Boolescher Wert |
[Tabelle : 26. Antworttext-Parameter (JSON oder XML)]

{#awa-PUT-agents__table_rcs_b2m_cmb}  

    curl -X PUT \
     https://instance.servicenow.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666 \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -u 'username':'password'\
    -d '{"presence": {\
      "sys_id": "0b10223c57a313005baaaa65ef94f970",\
      "channels": [{ \
      "sys_id": "0bbdedbb3b892300a2bac9bb34efc445",\
      "available": true
    }] 
    }}

    {
      "result": {
        "presence": {
          "name": "Available",
          "sys_id": "0b10223c57a313005baaaa65ef94f970",
          "available": true,
          "channels": [
            {
              "name": "Chat",
              "available": true,
              "sys_id": "27f675e3739713004a905ee515f6a7c3"
            }
          ]
        },
        "sys_id": "46d44a23a9fe19810012d100cca80666"
      }
    }

## AWA Service Desk-Mitarbeiter -- PUT /now/awa/Agents/{user_ID}/Capacties {#ariaid-title6}

Ermöglicht das Aktualisieren der maximalen Kapazität (Arbeitsauslastung) eines Service Desk-Mitarbeiters für Kanalkapazitäten und universelle Kapazität.
Verwenden Sie [AWA Agent -- RUFT /now/awa/Agents/{user_ID}/Capacties AB](https://servicenow-prod.fluidtopics.net/pkYpt7WgN2eAVuYGyvkTDg#awa-GET-capacities "Gibt die Kanalkapazitäten eines Service Desk-Mitarbeiters, die universelle Kapazität und die aktuelle Arbeitsauslastung zurück, um zu sehen, ob der Service Desk-Mitarbeiter einen Fall bearbeiten kann.")Methode zum Abrufen des aktuellen Kanals und der universellen Kapazitäten eines Agenten.  
Siehe auch:

* [Kapazität und Auslastung des Servicekanals](https://www.servicenow.com/docs/access?context=awa-service-channel-capacity&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)
* [Erstellen oder konfigurieren Sie einen Servicekanal](https://www.servicenow.com/docs/access?context=awa-create-service-channel&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)
* [Konfigurieren Sie die maximale universelle Kapazität eines Service Desk-Mitarbeiters](https://www.servicenow.com/docs/access?context=awa-universal-capacity&version=yokohama&pubname=yokohama-servicenow-platform&ft:locale=en-US)
{#awa-PUT-capacities__ul_rl1_2wg_jtb}

### URL-Format {#awa-PUT-capacities__section_hsf_jvl_cmb}

Versionierte URL: /api/now/{api_Version}/Awa/Agents/{user_ID}/Capacties

Standard-URL: /api/now/Awa/Agents/{user_ID}/Capacties  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#awa-PUT-capacities__entry__2}{#awa-PUT-capacities__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 |
| user_id | SYS_ID des aufgelisteten Agenten. Datentyp: Zeichenfolge Tabelle: Anwender \[sys_user\] |
[Tabelle : 27. Pfad-Parameter]

{#awa-PUT-capacities__entry__8}

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

{#awa-PUT-capacities__entry__12}

| Name | Beschreibung |
|-|-|
| Kanäle | Obligatorisch, wenn der Höchstwert eines oder mehrerer Kanäle für den angegebenen Service Desk-Mitarbeiter aktualisiert wird. JSON-Objekt, das ein oder mehrere Schlüssel-Wert-Paare enthält, die den Kanal seiner maximalen Kapazität für jeden Kanal zuordnen, der dem Agent zugewiesen ist. Datentyp: Objekt Das Paar hat das folgende Format: * Schlüssel (Kanal-sys_ID) -- Kanal-sys_ID Datentyp: Zeichenfolge * Wert (maximale Kapazität) -- Maximale Arbeitsauslastung in einem bestimmten Servicekanal, dem der Service Desk-Mitarbeiter gleichzeitig aktiv zugewiesen werden kann. Datentyp: Zahl {#awa-PUT-capacities__ul_e35_r3g_jtb} channels: {"<channel_sys_id>": <max_capacity>} |
| Universal_Capacity | Obligatorisch, wenn die universelle Kapazität aktualisiert wird. Maximale Kapazität für den Service Desk-Mitarbeiter in allen Servicekanälen. Wenn die aktuelle Arbeitsauslastung eines Service Desk-Mitarbeiters der maximalen universellen Kapazität entspricht, werden dem Service Desk-Mitarbeiter keine zusätzlichen Arbeitselemente zugewiesen. Datentyp: Zahl |
[Tabelle : 29. 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-PUT-capacities__entry__18}{#awa-PUT-capacities__accept-RESTAPI}

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

{#awa-PUT-capacities__entry__22}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 31. 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-PUT-capacities__entry__26}{#awa-PUT-capacities__entry-200-status-code}{#awa-PUT-capacities__entry-400-status-code}{#awa-PUT-capacities__entry-404-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
[Tabelle : 32. Statuscodes]

### Antworttext-Parameter (JSON oder XML) {#awa-PUT-capacities__section_agk_dmp_htb}

{#awa-PUT-capacities__table_bgk_dmp_htb__entry__2}{#awa-PUT-capacities__ph-presence_channels_sys_id-awa}{#awa-PUT-capacities__ordr-row-error}{#awa-PUT-capacities__awa-api-ph-universal_capacity}

| Name | Beschreibung |
|-|-|
| Kanäle | Liste von Objekten, die die verfügbaren Kommunikationskanäle mit dem Service Desk-Mitarbeiter beschreiben. "channels": [ { "channel_sys_id": "String", "max_capacity": Number } ] Datentyp: Array |
| channels.channel_sys_id | Kanal-sys_ID Datentyp: Zeichenfolge Tabelle: Servicekanäle \[Awa_Service_Channel\] |
| Channels.max_Capacity | Maximale Arbeitsauslastung in einem bestimmten Servicekanal, dem der Service Desk-Mitarbeiter gleichzeitig aktiv zugewiesen werden kann. Datentyp: Zeichenfolge |
| 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. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht 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 in der Antwort enthalten, wenn ein Fehler auftritt. Gültiger Wert: Fehler Datentyp: Zeichenfolge |
| Universal_Capacity | Maximale Kapazität für den Service Desk-Mitarbeiter in allen Servicekanälen. Wenn die aktuelle Arbeitsauslastung eines Service Desk-Mitarbeiters der maximalen universellen Kapazität entspricht, werden dem Service Desk-Mitarbeiter keine zusätzlichen Arbeitselemente zugewiesen. Diese Eigenschaft gibt nur zurück, wenn für diesen Service Desk-Mitarbeiter ein universelle Kapazitätsdatensatz vorhanden ist. Datentyp: Zahl |
[ ]

{#awa-PUT-capacities__table_bgk_dmp_htb}  

### Beispiel für Curl-Anforderung

Das folgende Beispiel zeigt, wie die universelle Kapazität des Service Desk-Mitarbeiters und die maximale Kapazität für einen angegebenen Kanal geändert werden.

    curl "https://instance.service-now.com/api/now/awa/agents/46d44a23a9fe19810012d100cca80666/capacities" \
    --request PUT \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{
     \"channels\": { \"27f675e3739713004a905ee515f6a7c3\": 6 },
     \"universal_capacity\" : 12
    }" \
    --user 'username':'password'

Eine erfolgreiche Antwort enthält die aktualisierten Kapazitätswerte.

    {
      "result": {
        "channels": [
          {
            "channel_sys_id": "27f675e3739713004a905ee515f6a7c3",
            "max_capacity": 6
          }
        ],
        "universal_capacity": 12
      }
    }


