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


---

# Service Desk-Mitarbeiter -- Global

# Service Desk-Mitarbeiter -- Global {#ariaid-title1}

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

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

Die Service Desk-Mitarbeiter API wird in bereitgestellt `sn_Awa `Namespace.  
Erfordert Folgendes:

* Plugin für erweiterte Arbeitszuweisung (com.Glide.awa)
* Rolle: awa_Integration_user oder admin
{#c_AgentAPI__ul_cgv_mtc_2gb}

## Agent -- GET(Zeichenfolge user_sys_ID) {#ariaid-title2}

Ruft einen Service Desk-Mitarbeiter nach sys_ID ab
{#r_agent_get__table_t4k_y54_3gb__entry__3}

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

{#r_agent_get__table_t4k_y54_3gb} {#r_agent_get__table_u4k_y54_3gb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | „Wahr", wenn der Anwender vorhanden ist, andernfalls „falsch". |
[Tabelle : 2. Rückgaben]

{#r_agent_get__table_u4k_y54_3gb}  

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

## Agent -- getPresence() {#ariaid-title3}

Ruft den aktuellen Anwesenheitsstatus und die Kanalverfügbarkeit eines angegebenen Service Desk-Mitarbeiters 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 | Sys_ID des Anwesenheitsstatus, Name des Anwesenheitsstatus und Kanalinformationen. Fehlermeldung andernfalls. |
[Tabelle : 4. Rückgaben]

{#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 |
|-|-|-|
| SetRequest | Objekt | Die setRequest.sys_ID und setRequest.channels. |
| SetRequest.sys_ID | Zeichenfolge | Die Presence_sys_ID aus der Tabelle „AWA-Anwesenheitsstatus" \[Awa_Presence_State\]. |
| setRequest.channels | Name/Wert-Paar | Optional. * sys_ID: Channel_sys_ID aus der Tabelle „Awa_Service_Channel". * Verfügbar: Verfügbarkeit des Service Desk-Mitarbeiters für den Empfang von Arbeiten für diesen Kanal (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 | „Wahr", wenn erfolgreich, andernfalls „falsch". |
[Tabelle : 6. Rückgaben]

{#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
        }]
    });


