AWA-Agenten-API

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 .

AWA Agent – GET /now/awa/Agents/{user_ID}

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

URL-Format

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 . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 1. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . 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. Datentyp: Zeichenfolge Tabelle: AWA-Arbeitselement [Awa_work_item]

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)

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

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 .

Tabelle : 4. Anforderungskopfzeilen.

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 : 5. Antwort-Header

Header	Beschreibung
Keine

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 .

Tabelle : 6. Statuscodes

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

Antworttext-Parameter (JSON oder XML)

Tabelle : 7. Antworttext-Parameter (JSON oder XML)

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

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

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}/CapactiesMethode zum Ändern des Kanals und der universellen Kapazitäten eines Service Desk-Mitarbeiters.

Siehe auch:

• Kapazität und Auslastung des Servicekanals
• Erstellen oder konfigurieren Sie einen Servicekanal
• Konfigurieren Sie die maximale universelle Kapazität eines Service Desk-Mitarbeiters

URL-Format

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 . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 8. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . 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 : 9. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 10. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

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 .

Tabelle : 11. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 12. Antwort-Header

Header	Beschreibung
Keine

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 .

Tabelle : 13. Statuscodes

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

Antworttext-Parameter (JSON oder XML)

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

Beispiel für Curl-Anforderung

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

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

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 . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 14. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . 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 : 15. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 16. Anforderungstext-Parameter (XML oder JSON)

Name	Beschreibung
Keine

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 .

Tabelle : 17. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 18. Antwort-Header

Header	Beschreibung
Keine

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 .

Tabelle : 19. Statuscodes

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

Antworttext-Parameter (JSON oder XML)

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. 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. 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. Datentyp: Boolescher Wert Standard: Falsch Informationen zum Ändern dieser Einstellung finden Sie unter Konfigurieren Sie die anwesenheitsstatus des Service Desk .
<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. 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

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}

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

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 . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 20. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . 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 : 21. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 22. Anforderungstext-Parameter (XML oder JSON)

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

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 .

Tabelle : 23. Anforderungskopfzeilen.

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 : 24. Antwort-Header

Header	Beschreibung
Keine

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 .

Tabelle : 25. Statuscodes

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“. 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 .
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 : 26. Antworttext-Parameter (JSON oder XML)

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

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

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 ABMethode zum Abrufen des aktuellen Kanals und der universellen Kapazitäten eines Agenten.

Siehe auch:

• Kapazität und Auslastung des Servicekanals
• Erstellen oder konfigurieren Sie einen Servicekanal
• Konfigurieren Sie die maximale universelle Kapazität eines Service Desk-Mitarbeiters

URL-Format

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 . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf Geskriptetes REST-Service-Formular .

Unterstützte Anforderungsparameter

Tabelle : 27. Pfad-Parameter

Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . 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 : 28. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 29. Anforderungstext-Parameter (XML oder JSON)

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

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 .

Tabelle : 30. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json

Tabelle : 31. Antwort-Header

Header	Beschreibung
Keine

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 .

Tabelle : 32. Statuscodes

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.

Antworttext-Parameter (JSON oder XML)

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

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