---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# AWA-Agent-API

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

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 19 Minuten Lesedauer

Die AWA-Agent-API (Advanced Work Assignment) bietet Endpunkte für die Verwaltung der Anwesenheit von Service Desk-Mitarbeitern, der Kanalverfügbarkeit und der Arbeitsauslastung.
Diese API erfordert das Plugin Erweiterte Arbeitszuweisung (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=xanadu&pubname=xanadu-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}

URL mit Versionsnummer: /api/now/{api_version}/awa/agents/{user_id}

Standard-URL: /api/now/awa/agents/{user_id}

### Unterstützte Anforderungsparameter

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

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 in der Tabelle „AWA-Arbeitselement" \[awa_work_item\] aufgeführten Arbeitselements. Das Arbeitselement muss die folgenden Kriterien erfüllen: * Das Arbeitselement muss dem angegebenen Service Desk-Mitarbeiter zugewiesen werden. * Das Arbeitselement muss sich im Status „ Akzeptanz ausstehend " befinden. {#awa-GET-agents__ul_zcs_rh3_htb} Datentyp: Zeichenfolge |
[Tabelle : 1. Pfadparameter]

{#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. * false: Kanal ist nicht verfügbar. {#awa-GET-agents__ul_qps_xwl_cmb} Datentyp: Boolesch |
| presence.channels.sys_id | sys_id des Kanals Befindet sich in der Tabelle „Servicekanäle" \[awa_service_channel\]. Datentyp: Zeichenfolge |
| presence.sys_id | Anwesenheitsstatus-sys_id. Befindet sich in der Tabelle „Anwesenheitsstatus" \[awa_presence_state\]. Datentyp: Zeichenfolge |
[Tabelle : 3. Anforderungstextparameter (XML oder JSON)]

### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#awa-GET-agents__entry__20}{#awa-GET-agents__accept-RESTAPI}{#awa-GET-agents__content_type-RESTAPI}

| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
[Tabelle : 4. Anforderungskopfzeilen]

{#awa-GET-agents__entry__26}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwortkopfzeilen]

### 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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#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 | 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 Benutzer verfügt nicht über die Rolle awa_integration_user.{#awa-GET-agents__li-403-role} * Der Wert der Eigenschaft „glide.awa.enabled" ist nicht „ true". 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](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-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. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Parameter des Antworttexts (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__d3393e337}{#awa-GET-agents__ph-presence_channels_name-awa}{#awa-GET-agents__d3393e405}{#awa-GET-agents__ph-presence_name-awa}{#awa-GET-agents__ph-presence_restrict_update-awa}{#awa-GET-agents__d3393e465}{#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}

| Parameter | Beschreibung |
|-|-|
| Fehler | Details, die einen während des Anforderungsprozesses aufgetretenen Fehler beschreiben. Datentyp: Objekt "error": { "detail": "String", "message": "String" } |
| Fehler.detail | Details des Fehlers, der während des Anforderungsprozesses aufgetreten ist. Datentyp: Zeichenfolge |
| Fehlernachricht | Meldung für den Fehler, der während des Anforderungsprozesses aufgetreten ist. Jede Fehlermeldung hat eine entsprechende Beschreibung in der Eigenschaft detail. Mögliche Werte: * Datensatz nicht gefunden: Die im Anforderungstext angegebenen Informationen sind ungenau oder nicht vorhanden. * Anwender nicht authentifiziert: Der Anwender verfügt nicht über die Rolle „awa_integration_user". {#awa-GET-agents__ul_om3_5sq_tsb} Datentyp: Zeichenfolge |
| presence | Informationen über den aktuellen Anwesenheitsstatus und Kanal eines Service Desk-Mitarbeiters. Datentyp: Objekt "presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" } |
| presence.available | Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter verfügbar ist. Mögliche Werte: * wahr: Service Desk-Mitarbeiter ist verfügbar. * „falsch": Service Desk-Mitarbeiter ist nicht verfügbar. {#awa-GET-agents__ul_ezb_kwl_cmb} Datentyp: Boolesch |
| presence.channels | Liste von Objekten, die die verfügbaren Kommunikationskanäle mit dem Service Desk-Mitarbeiter beschreiben. Datentyp: Array "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. * false: Kanal ist nicht verfügbar. {#awa-GET-agents__d3393e342} Datentyp: Boolesch |
| presence.channels.name | Kanalname, z. B. Chat oder Telefon. Datentyp: Zeichenfolge |
| „präsenz.kanäle.beschränken_aktualisieren" | Kennzeichnung, die angibt, ob der Anwender Aktualisierungen einschränken, d. h. den Kanal für die Verfügbarkeit auswählen kann. Mögliche Werte: * wahr: Der Anwender kann diesen Kanal für die Verfügbarkeit auswählen. * „falsch": Der Anwender kann diesen Kanal nicht für die Verfügbarkeit auswählen. {#awa-GET-agents__ul_xjk_kn4_tsb} Datentyp: Boolesch |
| präsenz.kanäle.service_kanal_typ | Servicekanaltyp, z. B. Chat. Die möglichen Werte variieren je nach installierten Plugins. Datentyp: Zeichenfolge |
| presence.channels.sys_id | sys_id des Kanals Befindet sich in der Tabelle „Servicekanäle" \[awa_service_channel\]. Datentyp: Zeichenfolge |
| 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 Aktualisierungen einschränken kann. Mögliche Werte: * wahr: Der Anwender kann Updates einschränken. * „falsch": Anwender kann Updates nicht einschränken. {#awa-GET-agents__ul_dfh_cxl_cmb} Datentyp: Boolesch |
| presence.sys_id | Anwesenheitsstatus-sys_id. Befindet sich in der Tabelle „Anwesenheitsstatus" \[awa_presence_state\]. Datentyp: Zeichenfolge |
| status | Status einer nicht erfolgreichen Anforderung. Diese Eigenschaft ist nur in der Antwort enthalten, wenn ein Fehler vorliegt. Gültiger Wert: Fehler Datentyp: Zeichenfolge |
| sys_id | sys_id des Agenten. Datentyp: Zeichenfolge |
| workItem | workItem: Informationen zum Arbeitselement, das dem Ereignis zugeordnet ist.{#awa-GET-agents__open-workItem-p} |
| workItem.document | workItem.document: Liste der Dokumente, die der Arbeitselementaufgabe zugeordnet sind. |
| workItem.document.sys_id | workItem.document.sys_id: Sys_id des Dokuments, das der Arbeitselementaufgabe zugewiesen ist. |
| workItem.document.table (Arbeitselement.Dokument.Tabelle) | workItem.document.table: Name der Dokumenttabelle, die der Aufgabe zugewiesen ist. |
| workItem.vorherigesArbeitselement | workItem.previousWorkItem: Sys_id des vorherigen Arbeitselements für dieselbe Dokument-ID. Für die Nicht-Transfer-Arbeitselemente ist dieser Wert leer. |
| workItem.serviceChannel | workItem.serviceChannel: Liste der Servicekanäle, die der Arbeitselementaufgabe zugeordnet sind. |
| workItem.serviceChannel.name | workItem.serviceChannel.name: Name des Servicekanals, z. B. Chat oder Telefon. |
| workItem.serviceChannel.sys_id | workItem.serviceChannel.sys_id: Sys_id des Servicekanals. |
| workItem.size | workItem.size: Kapazität des Service Desk-Mitarbeiters, die verwendet wird, wenn dem Service Desk-Mitarbeiter dieses Arbeitselement zugewiesen wird. |
| workItem.sys_id | workItem.sys_id: Sys_id des Arbeitselements, das akzeptiert oder angeboten wurde. |
| workItem.isQueueTransfer | workItem.isQueueTransferred: Gibt an, ob das Arbeitselement in der Warteschlange übertragen wird. Auf „wahr" festlegen, wenn das Arbeitselement in der Warteschlange übertragen wird, andernfalls auf „falsch". 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=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). |
[Tabelle : 7. Parameter des Antworttexts (JSON oder XML)]

{#awa-GET-agents__table_r2q_fbm_cmb}  

### Beispiel für eine 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: GET /now/awa/agents/{user_id}/capacities {#ariaid-title3}

Gibt die Kanalkapazitäten, die universelle Kapazität und die aktuelle Arbeitsauslastung eines Service Desk-Mitarbeiters zurück, um zu sehen, ob der Service Desk-Mitarbeiter einen Fall bearbeiten kann.
Verwenden Sie die Methode [AWA Agent: PUT /now/awa/agents/{user_id}/capacities](https://www.servicenow.com/docs/PWIZlXKk60nhuQ070mK~Rg#awa-PUT-capacities "Ermöglicht die Aktualisierung der maximalen Kapazität (Arbeitsauslastung) eines Service Desk-Mitarbeiters für Kanalkapazitäten und universelle Kapazität."), um den Kanal und die universellen Kapazitäten eines Service Desk-Mitarbeiters zu ändern.  
Siehe auch:

* [Kapazität und Nutzung von Servicekanälen](https://www.servicenow.com/docs/access?context=awa-service-channel-capacity&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* [Erstellen oder konfigurieren Sie einen Servicekanal](https://www.servicenow.com/docs/access?context=awa-create-service-channel&version=xanadu&pubname=xanadu-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=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
{#awa-GET-capacities__ul_rl1_2wg_jtb}

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

URL mit Versionsnummer: /api/now/{api_version}/awa/agents/{user_id}/capacities

Standard-URL: /api/now/awa/agents/{user_id}/capacities

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

{#awa-GET-capacities__table_wg3_ydq_htb__entry__2}{#awa-GET-capacities__version-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 in der Benutzertabelle \[sys_user\] aufgeführten Agents. Datentyp: Zeichenfolge |
[Tabelle : 8. Pfadparameter]

{#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. Anforderungstextparameter (XML oder JSON)]

{#awa-GET-capacities__table_yg3_ydq_htb}

### Kopfzeilen {#awa-GET-capacities__section_zg3_ydq_htb}

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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#awa-GET-capacities__table_ah3_ydq_htb__entry__2}{#awa-GET-capacities__accept-RESTAPI}

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

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

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 12. Antwortkopfzeilen]

{#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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#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 | 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 Benutzer verfügt nicht über die Rolle awa_integration_user.{#awa-GET-capacities__li-403-role} * Der Wert der Eigenschaft „glide.awa.enabled" ist nicht „ true". 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](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-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. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 13. Statuscodes]

{#awa-GET-capacities__table_dh3_ydq_htb}

### Parameter des Antworttexts (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" | sys_id des Kanals Befindet sich in der Tabelle „Servicekanäle" \[awa_service_channel\]. Datentyp: Zeichenfolge |
| „channels.current_workload" | Anzahl der Arbeitselemente in einem bestimmten Servicekanal, die dem Service Desk-Mitarbeiter derzeit zugewiesen sind. Datentyp: Zahl |
| „channels.max_capacity" | Die maximale Auslastung für einen bestimmten Servicekanal, der der Service Desk-Mitarbeiter gleichzeitig aktiv zugewiesen werden kann. Datentyp: Zeichenfolge |
| Fehler | Details, die einen während des Anforderungsprozesses aufgetretenen Fehler beschreiben. Datentyp: Objekt "error": { "detail": "String", "message": "String" } |
| Fehler.detail | Details des Fehlers, der während des Anforderungsprozesses aufgetreten ist. Datentyp: Zeichenfolge |
| Fehlernachricht | Meldung für den Fehler, der während des Anforderungsprozesses aufgetreten ist. Die Beschreibung wird in der Eigenschaft error.detail angegeben. Datentyp: Zeichenfolge |
| status | Status einer nicht erfolgreichen Anforderung. Diese Eigenschaft ist nur in der Antwort enthalten, wenn ein Fehler vorliegt. Gültiger Wert: Fehler Datentyp: Zeichenfolge |
| universell_kapazität | 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 wird nur zurückgegeben, wenn für diesen Service Desk-Mitarbeiter ein Datensatz für die universelle Kapazität vorhanden ist. Datentyp: Zahl |
| universell_workload | Anzahl der Arbeitselemente in allen Servicekanälen, die dem angegebenen Service Desk-Mitarbeiter derzeit zugewiesen sind. Diese Eigenschaft wird nur zurückgegeben, 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 eine cURL-Anforderung {#awa-GET-capacities__example_eh3_ydq_htb}

Das folgende Beispiel zeigt, wie die Kapazitäts- und Arbeitsauslastungswerte für einen Benutzer 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: GET /now/awa/agents/{user_id}/presence_states {#ariaid-title4}

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

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

URL mit Versionsnummer: /api/now/{api_version}/awa/agents/{user_id}/presence_states

Standard-URL: /api/now/awa/agents/{user_id}/presence_states

### Unterstützte Anforderungsparameter

{#awa-GET-presence_states__entry__2}{#awa-GET-presence_states__version-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 in der Benutzertabelle \[sys_user\] aufgeführten Agents. Datentyp: Zeichenfolge |
[Tabelle : 14. Pfadparameter]

{#awa-GET-presence_states__entry__8}

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

{#awa-GET-presence_states__entry__12}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 16. Anforderungstextparameter (XML oder JSON)]

### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#awa-GET-presence_states__entry__16}{#awa-GET-presence_states__accept-RESTAPI}

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

{#awa-GET-presence_states__entry__20}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 18. Antwortkopfzeilen]

### 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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#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 | 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 Benutzer 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 „ true". 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](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-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. Der Antworttext enthält Informationen zum Fehler. |
[Tabelle : 19. Statuscodes]

### Parameter des Antworttexts (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 während des Anforderungsprozesses aufgetretenen Fehler beschreiben. Datentyp: Objekt "error": { "detail": "String", "message": "String" } |
| Fehler.detail | Details des Fehlers, der während des Anforderungsprozesses aufgetreten ist. Datentyp: Zeichenfolge |
| Fehlernachricht | Meldung für den Fehler, der während des Anforderungsprozesses aufgetreten ist. Die Beschreibung wird in der Eigenschaft error.detail angegeben. 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 Service Desk-Mitarbeiter verfügbar ist. Mögliche Werte: * wahr: Service Desk-Mitarbeiter ist verfügbar. * „falsch": Service Desk-Mitarbeiter ist nicht verfügbar. {#awa-GET-presence_states__ul_ezb_kwl_cmb} Datentyp: Boolesch |
| \<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. * false: Kanal ist nicht verfügbar. {#awa-GET-presence_states__ul_qps_xwl_cmb} Datentyp: Boolesch |
| \<presence state\>.channels.name | Kanalname, z. B. Chat oder Telefon. Datentyp: Zeichenfolge |
| \<presence state\>.channels.sys_id | sys_id des Kanals Befindet sich in der Tabelle „Servicekanäle" \[awa_service_channel\]. Datentyp: Zeichenfolge |
| \<presence state\>.disable_inactivity_check | Kennzeichnung, die angibt, ob die Inaktivität dieses Anwesenheitsstatus überprüft werden soll. Gültige Werte: * wahr: Die Inaktivitätsprüfung des Anwesenheitsstatus ist deaktiviert. * „falsch": Die Inaktivitätsprüfung des Anwesenheitsstatus ist aktiviert. {#awa-GET-presence_states__ul_alm_cjn_jtb} Datentyp: Boolesch Standardwert: false Informationen zum Ändern dieser Einstellung finden Sie unter [Anwesenheitsstatus von Service Desk-Mitarbeitern konfigurieren](https://www.servicenow.com/docs/access?context=awa-configure-agent-presence&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US). |
| \<presence state\>.name | Name des Anwesenheitsstatus des Service Desk-Mitarbeiters Die standardmäßig installierten Anwesenheitsstatus sind Verfügbar, Abwesendund Offline. Datentyp: Zeichenfolge |
| \<presence state\>.auftrag | 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 berechtigt ist, den Anwesenheitsstatus zu ändern, z. B. von verfügbar in abwesend. Gültige Werte: * „wahr": Der Anwender hat die Berechtigung zum Ändern der Anwesenheit. * „falsch": Der Anwender kann die Anwesenheit nicht ändern. {#awa-GET-presence_states__ul_qlh_xlh_jtb} Datentyp: Boolesch |
| \<presence state\>.sys_id | Anwesenheitsstatus-sys_id. Befindet sich in der Tabelle „Anwesenheitsstatus" \[awa_presence_state\]. Datentyp: Zeichenfolge |
| status | Status einer nicht erfolgreichen Anforderung. Diese Eigenschaft ist nur in der Antwort enthalten, wenn ein Fehler vorliegt. Gültiger Wert: Fehler Datentyp: Zeichenfolge |
[ ]

{#awa-GET-presence_states__table_bgk_dmp_htb}  

### Beispiel für eine cURL-Anforderung

Das folgende Beispiel zeigt, wie die Anwesenheitsstatus für einen bestimmten 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 und, falls angegeben, die Kanalverfügbarkeit des Service Desk-Mitarbeiters für diesen Status fest.

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

URL mit Versionsnummer: /api/now/{api_version}/awa/agents/{user_id}

Standard-URL: /api/now/awa/agents/{user_id}

### Unterstützte Anforderungsparameter

{#awa-PUT-agents__entry__2}{#awa-PUT-agents__version-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 Agent. Befindet sich in der Tabelle „Benutzer" \[sys_user\]. Datentyp: Zeichenfolge |
[Tabelle : 20. Pfadparameter]

{#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 "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. * false: Kanal ist nicht verfügbar. {#awa-PUT-agents__ul_qps_xwl_cmb} Hinweis: Diese Einstellung muss angegeben werden, um Kanäle in den Antworttext aufzunehmen. Datentyp: Boolesch Standardwert: false |
| presence.channels.sys_id | sys_id des Kanals Befindet sich in der Tabelle „Servicekanäle" \[awa_service_channel\]. Datentyp: Zeichenfolge |
| presence.sys_id | Anwesenheitsstatus-sys_id. Befindet sich in der Tabelle „Anwesenheitsstatus" \[awa_presence_state\]. Datentyp: Zeichenfolge |
[Tabelle : 22. Anforderungstextparameter (XML oder JSON)]

### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#awa-PUT-agents__entry__22}{#awa-PUT-agents__accept-RESTAPI}{#awa-PUT-agents__content_type-RESTAPI}

| Kopfzeile | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
[Tabelle : 23. Anforderungskopfzeilen]

{#awa-PUT-agents__entry__28}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 24. Antwortkopfzeilen]

### 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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#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 | 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 Benutzer verfügt nicht über die Rolle awa_integration_user.{#awa-PUT-agents__li-403-role} * Der Wert der Eigenschaft „glide.awa.enabled" ist nicht „ true". 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](https://www.servicenow.com/docs/access?context=installed-with-awa&version=xanadu&pubname=xanadu-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. Der Antworttext enthält 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__d3393e405}{#awa-PUT-agents__ph-presence_name-awa}{#awa-PUT-agents__ph-presence_restrict_update-awa}{#awa-PUT-agents__d3393e465}{#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}

| Parameter | Beschreibung |
|-|-|
| Fehler | Details, die einen während des Anforderungsprozesses aufgetretenen Fehler beschreiben. Datentyp: Objekt "error": { "detail": "String", "message": "String" } |
| Fehler.detail | Details des Fehlers, der während des Anforderungsprozesses aufgetreten ist. Datentyp: Zeichenfolge |
| Fehlernachricht | Meldung für den Fehler, der während des Anforderungsprozesses aufgetreten ist. Jede Fehlermeldung hat eine entsprechende Beschreibung in der Eigenschaft detail. Mögliche Werte: * Datensatz nicht gefunden: Die im Anforderungstext angegebenen Informationen sind ungenau oder nicht vorhanden. * Anwender nicht authentifiziert: Der Anwender verfügt nicht über die Rolle „awa_integration_user". {#awa-PUT-agents__ul_om3_5sq_tsb} Datentyp: Zeichenfolge |
| presence | Informationen über den aktuellen Anwesenheitsstatus und Kanal eines Service Desk-Mitarbeiters. Datentyp: Objekt "presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" } |
| presence.available | Kennzeichnung, die angibt, ob der Service Desk-Mitarbeiter verfügbar ist. Mögliche Werte: * wahr: Service Desk-Mitarbeiter ist verfügbar. * „falsch": Service Desk-Mitarbeiter ist nicht verfügbar. {#awa-PUT-agents__ul_ezb_kwl_cmb} Datentyp: Boolesch |
| presence.channels | Liste von Objekten, die die verfügbaren Kommunikationskanäle mit dem Service Desk-Mitarbeiter beschreiben. Datentyp: Array "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. * false: Kanal ist nicht verfügbar. {#awa-PUT-agents__d3393e342} Datentyp: Boolesch |
| presence.channels.name | Kanalname, z. B. Chat oder Telefon. Datentyp: Zeichenfolge |
| „präsenz.kanäle.beschränken_aktualisieren" | Kennzeichnung, die angibt, ob der Anwender Aktualisierungen einschränken, d. h. den Kanal für die Verfügbarkeit auswählen kann. Mögliche Werte: * wahr: Der Anwender kann diesen Kanal für die Verfügbarkeit auswählen. * „falsch": Der Anwender kann diesen Kanal nicht für die Verfügbarkeit auswählen. {#awa-PUT-agents__ul_xjk_kn4_tsb} Datentyp: Boolesch |
| präsenz.kanäle.service_kanal_typ | Servicekanaltyp, z. B. Chat. Die möglichen Werte variieren je nach installierten Plugins. Datentyp: Zeichenfolge |
| presence.channels.sys_id | sys_id des Kanals Befindet sich in der Tabelle „Servicekanäle" \[awa_service_channel\]. Datentyp: Zeichenfolge |
| 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 Aktualisierungen einschränken kann. Mögliche Werte: * wahr: Der Anwender kann Updates einschränken. * „falsch": Anwender kann Updates nicht einschränken. {#awa-PUT-agents__ul_dfh_cxl_cmb} Datentyp: Boolesch |
| presence.sys_id | Anwesenheitsstatus-sys_id. Befindet sich in der Tabelle „Anwesenheitsstatus" \[awa_presence_state\]. Datentyp: Zeichenfolge |
| status | Status einer nicht erfolgreichen Anforderung. Diese Eigenschaft ist nur in der Antwort enthalten, wenn ein Fehler vorliegt. Gültiger Wert: Fehler Datentyp: Zeichenfolge |
| sys_id | sys_id des Agenten. Datentyp: Zeichenfolge |
| workItem | workItem: Informationen zum Arbeitselement, das dem Ereignis zugeordnet ist.{#awa-PUT-agents__open-workItem-p} |
| workItem.document | workItem.document: Liste der Dokumente, die der Arbeitselementaufgabe zugeordnet sind. |
| workItem.document.sys_id | workItem.document.sys_id: Sys_id des Dokuments, das der Arbeitselementaufgabe zugewiesen ist. |
| workItem.document.table (Arbeitselement.Dokument.Tabelle) | workItem.document.table: Name der Dokumenttabelle, die der Aufgabe zugewiesen ist. |
| workItem.vorherigesArbeitselement | workItem.previousWorkItem: Sys_id des vorherigen Arbeitselements für dieselbe Dokument-ID. Für die Nicht-Transfer-Arbeitselemente ist dieser Wert leer. |
| workItem.serviceChannel | workItem.serviceChannel: Liste der Servicekanäle, die der Arbeitselementaufgabe zugeordnet sind. |
| workItem.serviceChannel.name | workItem.serviceChannel.name: Name des Servicekanals, z. B. Chat oder Telefon. |
| workItem.serviceChannel.sys_id | workItem.serviceChannel.sys_id: Sys_id des Servicekanals. |
| workItem.size | workItem.size: Kapazität des Service Desk-Mitarbeiters, die verwendet wird, wenn dem Service Desk-Mitarbeiter dieses Arbeitselement zugewiesen wird. |
| workItem.sys_id | workItem.sys_id: Sys_id des Arbeitselements, das akzeptiert oder angeboten wurde. |
| workItem.isQueueTransfer | workItem.isQueueTransferred: Gibt an, ob das Arbeitselement in der Warteschlange übertragen wird. Auf „wahr" festlegen, wenn das Arbeitselement in der Warteschlange übertragen wird, andernfalls auf „falsch". 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=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). |
[Tabelle : 26. Parameter des Antworttexts (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 Agent: PUT /now/awa/agents/{user_id}/capacities {#ariaid-title6}

Ermöglicht die Aktualisierung der maximalen Kapazität (Arbeitsauslastung) eines Service Desk-Mitarbeiters für Kanalkapazitäten und universelle Kapazität.
Mit der Methode [AWA Agent: GET /now/awa/agents/{user_id}/capacities](https://www.servicenow.com/docs/PWIZlXKk60nhuQ070mK~Rg#awa-GET-capacities "Gibt die Kanalkapazitäten, die universelle Kapazität und die aktuelle Arbeitsauslastung eines Service Desk-Mitarbeiters zurück, um zu sehen, ob der Service Desk-Mitarbeiter einen Fall bearbeiten kann.") können Sie den aktuellen Kanal und die universellen Kapazitäten eines Service Desk-Mitarbeiters abrufen.  
Siehe auch:

* [Kapazität und Nutzung von Servicekanälen](https://www.servicenow.com/docs/access?context=awa-service-channel-capacity&version=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
* [Erstellen oder konfigurieren Sie einen Servicekanal](https://www.servicenow.com/docs/access?context=awa-create-service-channel&version=xanadu&pubname=xanadu-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=xanadu&pubname=xanadu-servicenow-platform&ft:locale=en-US)
{#awa-PUT-capacities__ul_rl1_2wg_jtb}

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

URL mit Versionsnummer: /api/now/{api_version}/awa/agents/{user_id}/capacities

Standard-URL: /api/now/awa/agents/{user_id}/capacities

### Unterstützte Anforderungsparameter

{#awa-PUT-capacities__entry__2}{#awa-PUT-capacities__version-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum 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 in der Benutzertabelle \[sys_user\] aufgeführten Agents. Datentyp: Zeichenfolge |
[Tabelle : 27. Pfadparameter]

{#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 Agent aktualisiert wird. JSON-Objekt, das mindestens ein Schlüssel-Wert-Paar enthält, das den Kanal seiner maximalen Kapazität für jeden dem Agent zugewiesenen Kanal zuordnet. Datentyp: Objekt Das Paar hat das folgende Format: * Schlüssel (Kanal-sys_id) -- sys_id des Kanals Befindet sich in der Tabelle „Servicekanäle" \[awa_service_channel\]. Datentyp: Zeichenfolge * Wert (maximale Kapazität) -- Die maximale Auslastung für einen bestimmten Servicekanal, der der Service Desk-Mitarbeiter gleichzeitig aktiv zugewiesen werden kann. Datentyp: Zahl {#awa-PUT-capacities__ul_e35_r3g_jtb} channels: {"<channel_sys_id>": <max_capacity>} |
| universell_kapazität | 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. Anforderungstextparameter (XML oder JSON)]

### 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](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.").
{#awa-PUT-capacities__entry__18}{#awa-PUT-capacities__accept-RESTAPI}

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

{#awa-PUT-capacities__entry__22}

| Kopfzeile | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 31. Antwortkopfzeilen]

### 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 [HTTP-Antwortcodes](https://www.servicenow.com/docs/bHLogaRspC43ztA1sd~MJg "REST (REpresentational State Transfer) ist eine einfache zustandslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, sodass sie leichter miteinander kommunizieren können.")der REST-API.
{#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 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
[Tabelle : 32. Statuscodes]

### Parameter des Antworttexts (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" | sys_id des Kanals Befindet sich in der Tabelle „Servicekanäle" \[awa_service_channel\]. Datentyp: Zeichenfolge |
| „channels.max_capacity" | Die maximale Auslastung für einen bestimmten Servicekanal, der der Service Desk-Mitarbeiter gleichzeitig aktiv zugewiesen werden kann. Datentyp: Zeichenfolge |
| Fehler | Details, die einen während des Anforderungsprozesses aufgetretenen Fehler beschreiben. Datentyp: Objekt "error": { "detail": "String", "message": "String" } |
| Fehler.detail | Details des Fehlers, der während des Anforderungsprozesses aufgetreten ist. Datentyp: Zeichenfolge |
| Fehlernachricht | Meldung für den Fehler, der während des Anforderungsprozesses aufgetreten ist. Die Beschreibung wird in der Eigenschaft error.detail angegeben. Datentyp: Zeichenfolge |
| status | Status einer nicht erfolgreichen Anforderung. Diese Eigenschaft ist nur in der Antwort enthalten, wenn ein Fehler vorliegt. Gültiger Wert: Fehler Datentyp: Zeichenfolge |
| universell_kapazität | 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 wird nur zurückgegeben, wenn für diesen Service Desk-Mitarbeiter ein Datensatz für die universelle Kapazität vorhanden ist. Datentyp: Zahl |
[ ]

{#awa-PUT-capacities__table_bgk_dmp_htb}  

### Beispiel für eine cURL-Anforderung

Das folgende Beispiel zeigt, wie die universelle Kapazität eines 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
      }
    }