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


---

# API für aktive Einbindung

# API für aktive Einbindung {#ariaid-title1}

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

Die Aktive Einbindung Die API stellt einen Endpunkt zum Erstellen von Problemen mit der digitalen Experience bereit.
Diese API ist als anwenderdefinierte geskriptete REST-API verfügbar. Erfordert das Plugin „aktive Einbindung" (proaktive Interaktion) und die sn_pren.experience_issue_create-Rolle. Diese API gehört zu `sn_pren `Namespace.

Verwenden Sie Aktive Einbindung API zum Erstellen eines Experience-Problems, wenn ein Problem in der Instanz eines Anwenders erkannt wird. Das erstellte Experience-Problem fördert die Interaktion mit dem Anwender und hilft ihm, das Problem selbst zu lösen.

Stellen Sie zur Verwendung dieser API sicher, dass die folgenden Tabellen mit Datensätzen ausgefüllt sind:

* Problemregistrierungsvorlage \[sn_pren_issue_registry_template\]
* Problemregistrierung \[sn_pren_issue_registry\]
* Auflösung \[sn_pren_Resolution\]
* Benachrichtigungsinhalt \[sn_pren_notification_content\]
* Anbieter \[sn_pren_Provider\]

{#proactive-engagement-api__ul_chl_3cx_4zb}

Weitere Informationen finden Sie unter [Proactive Engagement](https://www.servicenow.com/docs/access?context=proactive-engagement-landing-page&version=yokohama&pubname=yokohama-it-service-management&ft:locale=en-US)

## Aktive Einbindung -- ERSTELLT /api/sn_pren/Self_Remediation/Experience_issue/create {#ariaid-title2}

Erstellt ein Experience-Problem, wenn ein Problem auf dem Endpunkt des Anwenders erkannt wird. Aktualisiert die Tabelle „Experience-Probleme" \[sn_pren_experience_issue\].

### URL-Format

Standard-URL: /api/sn_pren/Self_Remediation/Experience_issue/create

### Unterstützte Anforderungsparameter

{#proactiveengagement-CREATE-expissue__entry__2}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 1. Pfad-Parameter]

{#proactiveengagement-CREATE-expissue__entry__6}

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

{#proactiveengagement-CREATE-expissue__entry__10}

| Name | Beschreibung |
|-|-|
| endpoint | Erforderlich. Konfigurationselement (CI) und Anwenderinformationen, die zum Erkennen von Problemdetails verwendet werden. Hinweis: Alle Parameter in diesem Objekt sind optional. Sie müssen mindestens einen Parameter innerhalb des Objekts übergeben, um den Anwender oder das Gerät zu identifizieren." Datentyp: Objekt "endpoint": { "CI": "String", "email": "String", "user_id": "String", "user_name": "String" } |
| Endpunkt.CI | SYS_ID des CI-Geräts, auf dem das Problem erkannt wurde. Datentyp: Zeichenfolge Tabelle: Computer \[cmdb_ci_Computer\] |
| Endpunkt.E-Mail | E-Mail-Adresse des Anwenders, für den das Problem erkannt wurde. Datentyp: Zeichenfolge |
| endpoint.user_id | SYS_ID des Anwenders, für den das Problem erkannt wurde. Datentyp: Zeichenfolge Tabelle: Anwender \[sys_user\] |
| endpoint.user_name | Anwendername des Anwenders, für den das Problem erkannt wurde. Datentyp: Zeichenfolge Tabelle: Anwender \[sys_user\] |
| Experience_ID | Anwenderdefinierte ID, die dem erstellten Problem zugewiesen werden soll. Datentyp: Zahl Standard: Eine ID wird automatisch generiert. |
| input_parameters | Parameter, die an die Aktion übergeben werden sollen, die auf dem Gerät ausgeführt wird. Die gesendeten Eingabeparameter werden an die konfigurierte Lösungskorrekturaktion übergeben, z. B. einen Subflow, eine Flow-Aktion oder eine CI-Aktion. Datentyp: Objekt "input_parameters": { "process_id": "String" } |
| input_parameters.process_id | SYS_ID des Prozesses, der beendet oder neu gestartet werden soll. Datentyp: Zeichenfolge |
| Investigative_Details | Details, die für eine manuelle Untersuchung nützlich sein können, wenn die Lösung für die Stromnutzungseffektivität (PUE) fehlschlägt. Die Untersuchungsdetails werden in den Incident kopiert, der als Fallback erstellt wird, wenn die PUE-Lösung fehlschlägt. Datentyp: Objekt "investigative_details": { "cpu_usage": "String", "processes_running": "String", "available_memory": "String" } |
| Investigative_Details.cpu_usage | CPU-Auslastung auf dem Gerät. Datentyp: Zahl (als Zeichenfolge analysiert) |
| investigative_details.processes_running | Anzahl der auf dem Gerät ausgeführten Prozesse. Datentyp: Zahl (als Zeichenfolge analysiert) |
| Investigative_Details.available_Memory | Verfügbarer Arbeitsspeicher auf dem Gerät. Datentyp: Zahl (als Zeichenfolge analysiert) |
| Problem_Code | Erforderlich. Problemcode, der dem Problem zugeordnet werden soll. Der Problemcode muss verfügbar und in der Instanz bereitgestellt sein. Die API gibt einen Fehler zurück, wenn ein leeres oder ungültiges Problem angegeben wird. Datentyp: Zeichenfolge Tabelle: Problemregistrierung \[sn_pren_issue_registry\] |
| Anbieter | Erforderlich. Eindeutiger Code für den Anbieter. Dieser Code muss mit übereinstimmen provider_codeFeld in der Tabelle „sn_pren_Provider" in der Instanz. Datentyp: Zeichenfolge |
[Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#proactiveengagement-CREATE-expissue__entry__40}{#proactiveengagement-CREATE-expissue__accept-RESTAPI}

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

{#proactiveengagement-CREATE-expissue__entry__44}{#proactiveengagement-CREATE-expissue__content_type-RESTAPI}

| Header | Beschreibung |
|-|-|
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 5. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#proactiveengagement-CREATE-expissue__table_wrm_33x_4zb__entry__2}

| Statuscode | Beschreibung |
|-|-|
| 200 | Ein Experience-Problem wurde erfolgreich erstellt. |
| 400 | Ungültige Anforderung. Geben Sie Endpunktdetails an. Ein leerer endpointObjekt wurde in der Anforderung gesendet. |
| 400 | Ungültiger Problemcode. Geben Sie einen gültigen Problemcode an. Ein leerer issue_codeWurde in der Anforderung gesendet. |
| 400 | Ungültiger Anbieter. Geben Sie einen gültigen Anbieter an. In der Anforderung wurde ein leerer Anbieter gesendet. |
| 400 | Ungültiger Problemcode oder Anbieter. Geben Sie gültige Details an. Problem kann in der Instanz nicht erkannt werden. Verifizieren issue_codeUnd providerDetails. |
| 400 | Problemcode hat keine richtige Lösung. Für das identifizierte Problem ist im PUE-Framework keine gültige Lösung konfiguriert. |
| 400 | Anwender konnte nicht aus Endpunktdetails aufgelöst werden. Geben Sie gültige Details an. Dieser Fehler wird zurückgegeben, wenn die PUE-Framework-ID den Anwender anhand der angegebenen Endpunktdetails nicht identifizieren kann. |
| 400 | Ein Experience-Problem wird mit dem angegebenen Problemcode für den angegebenen Anwender gelöst. Das angegebene Experience-Problem befindet sich derzeit im Status „in Bearbeitung" oder „Offen". |
| 400 | Vorhandenes Experience-Problem mit angegeben experience_idWird noch ausgeführt oder ist geschlossen. Dieser Fehler tritt auf, wenn sich ein Experience-Problem in einem Verkettungsszenario befindet. Beispiel: Wenn neu issue_codeSchlüssel wird mit einem vorhandenen gesendet experience_id, Und das frühere Experience-Problem wird ausgeführt oder befindet sich im Status „Geschlossen". Das Experience-Problem mit dieser Experience_ID muss sich im Status „action_wait" befinden, um einen neuen issue_Code mit der vorherigen Experience_ID zu senden |
| 400 | Fehler beim Erstellen des Experience-Problems. Dies weist auf einen technischen Fehler hin. |
[ ]

{#proactiveengagement-CREATE-expissue__table_wrm_33x_4zb}

### Antworttext-Parameter (JSON oder XML)

{#proactiveengagement-CREATE-expissue__entry__70}

| Name | Beschreibung |
|-|-|
| experienceId | Experience-ID des erstellten Experience-Problems. Generiert aus experience_idAnforderungsparameter. Wenn experience_idParameter wird nicht übergeben, die resultierende ID ist immer die sys_ID des erstellten Datensatzes. Tabelle: Experience-Probleme \[sn_pren_experience_issue\] |
[ ]

### Curl-Anforderung

Das folgende Beispiel erstellt ein Experience-Problem für den Anwender Abel Tuter. Der Problemcode im Textkörper ermöglicht es proaktiver Einbindung, die Lösung aus der Problemregistrierungsvorlage zu identifizieren und über Virtual Agent mit dem Endanwender zusammenzuarbeiten, um ihm bei der Selbstlösung des Problems zu helfen.

    curl  "http://instance.servicenow.com//api/sn_srf/self_remediation/experience_issue/create" \
    --request POST \
    --header "Accept:application/json" \
    --user 'username':'password'
    --data "{
      "endpoint": {
        "CI": "d049b28e936aa1106f98f6db5cba10d5",
        "user_id": "62826bf03710200044e0bfc8bcbe5df1",
        "user_name": "abel.tuter",
        "email": ""
      },
      "issue_code": "100",
      "provider": "sn",
      "experience_id": "09ed4830f393739df33",
      "input_parameters": {
        "process_id": "10644"
      },
      "investigative_details": {
        "cpu usage": "78%",
        "processes running": "35",
        "available memory": "23%"
      }
    }"\

Der Antworttext gibt die Experience-ID zurück, was angibt, dass das Problem erfolgreich erstellt wurde.

    { 
      "result": { 
        "experience_id": "09ed4830f393739df33"
      } 
    }


