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


---

# Agent : Global

# Agent : Global {#ariaid-title1}

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

Die Agent API bietet Methoden zum Abrufen oder Festlegen der Anwesenheit von Service Desk-Mitarbeitern und Kanalverfügbarkeit.

Die Agent API wird im Namespace `sn_awa` bereitgestellt.  
Folgendes ist erforderlich:

* Plugin „Advanced Work Assignment" (com.glide.awa)
* Rolle: awa_integration_user oder admin
{#c_AgentAPI__ul_cgv_mtc_2gb}

## Agent -- get(String user_sys_id) {#ariaid-title2}

Ruft einen Agenten nach sys_id ab.
{#r_agent_get__table_t4k_y54_3gb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| user_sys_id | Zeichenfolge | Die sys_id des Benutzers, der in der Tabelle „sys_user" aufgeführt wird. |
[Tabelle : 1. Parameter]

{#r_agent_get__table_t4k_y54_3gb} {#r_agent_get__table_u4k_y54_3gb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | „True", wenn der Benutzer vorhanden ist, andernfalls „false". |
[Tabelle : 2. Ergebnisse]

{#r_agent_get__table_u4k_y54_3gb}  

    var agent = sn_awa.Agent.get("<user_sys_id>");
    var presence  = agent.getPresence();

## Service Desk-Mitarbeiter -- getPresence () {#ariaid-title3}

Ruft den aktuellen Anwesenheitsstatus und die Kanalverfügbarkeit eines bereitgestellten Agenten ab.
{#r_getPresence__table_kt3_zrc_2gb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 3. Parameter]

{#r_getPresence__table_kt3_zrc_2gb} {#r_getPresence__table_lt3_zrc_2gb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Anwesenheitsstatus sys_id, Name des Anwesenheitsstatus und Kanalinformationen. Andernfalls Fehlermeldung. |
[Tabelle : 4. Ergebnisse]

{#r_getPresence__table_lt3_zrc_2gb}  

    var agent = sn_awa.Agent.get("<user_sys_id>");
            var presence  = agent.getPresence();

## Agent -- setPresence(Object setRequest) {#ariaid-title4}

Legt den Status der Anwesenheit eines angegebenen Service Desk-Mitarbeiters fest und legt die Kanalverfügbarkeit des Service Desk-Mitarbeiters für diesen Status fest.
{#r_setPresence__table_hqw_pbm_yfb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| festlegenAnforderung | Objekt | setRequest.sys_id und setRequest.channels |
| festlegenAnforderung.sys_id | Zeichenfolge | Die „presence_sys_id" aus der Tabelle „AWA-Anwesenheitsstatus" \[awa_presence_state\] |
| festlegenAnforderung.Kanäle | Name/Wert-Paar | Optional. * sys_id: Channel_sys_id aus der Tabelle „awa_service_channel". * available: Verfügbarkeit des Service Desk-Mitarbeiters, um Arbeit für diesen Kanal zu erhalten (wahr oder falsch). {#r_setPresence__ul_vsh_tqn_kgb} |
[Tabelle : 5. Parameter]

{#r_setPresence__table_hqw_pbm_yfb} {#r_setPresence__table_iqw_pbm_yfb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | „True", falls erfolgreich, andernfalls „false". |
[Tabelle : 6. Ergebnisse]

{#r_setPresence__table_iqw_pbm_yfb}  

    var agent = sn_awa.Agent.get("<user_sys_id>");
    var presence = agent.setPresence({
        sys_id: <presence_sys_id>,
        channels: [{
            sys_id: "<channel_sys_id>",
            available: true // or false
        }]
    });