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

# API für Remote-Hilfeanforderung {#ariaid-title1}

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

Die Anforderung von Remote-Hilfe Die API stellt Endpunkte bereit, um Listen von IT-Serviceanfragen und deren Details aus einem System für elektronische Krankenakte (EMR) zu erstellen, anzuzeigen und abzurufen. Eine IT-Serviceanfrage ist einem Aufgabentyp wie einem Incident in zugeordnet ServiceNowInstanz.
Sie können diese API nur verwenden, wenn [EMR-Hilfe](https://www.servicenow.com/docs/access?context=emr-help&version=yokohama&pubname=yokohama-healthcare-life-sciences&ft:locale=en-US) Anwendung (sn_ind_rmt_help) wird über installiert ServiceNow Store. Besuchen Sie die [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home)-Website, um alle verfügbaren Apps anzuzeigen und Informationen zum Senden von Anforderungen an den Store zu erhalten. Kumulative Informationen zum Release für alle veröffentlichten Apps finden Sie in den Release-Hinweisen zum [ServiceNow Store-Versionsverlauf](https://www.servicenow.com/docs/bundle/store-release-notes/page/release-notes/store/sn-store-release-notes.html).

Rolle, die für den Zugriff auf die Endpunkte dieser API erforderlich ist: sn_ind_rmt_help.requester.

## Anforderung von Remote-Hilfe -- /Remote_help_Request/{req_defn_ID} POSTEN {#ariaid-title2}

Fügt Systemdaten der elektronischen Patientenakte (EMR) in die entsprechende ein ServiceNowTabellen.
Sie müssen angeben [Anforderungsdefinitions-ID](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=yokohama&pubname=yokohama-healthcare-life-sciences&ft:locale=en-US)Zusätzlich zu den Parametern für die Aufgabe und zusätzlichen Daten aus EMR-System In der Anforderungsdatentabelle beibehalten, die der Aufgabe zugeordnet ist. Sie übergeben zwei Datentypen an diesen Endpunkt. Die erste sind die Anforderungsdaten, die der Endpunkt in die Tabelle „Remote-Anforderungsdaten" \[sn_ind_rmt_help_request_data\] und die zugehörigen untergeordneten Tabellen einfügt. Der zweite ist die Aufgabenparameter der IT-Serviceanfrage, die der Endpunkt in die Tabelle „Remote-Anforderungsparameter" \[sn_ind_rmt_help_request_param\] einfügt. Nur Daten oder Felder, die in definiert sind [Anforderungsdefinitionen](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=yokohama&pubname=yokohama-healthcare-life-sciences&ft:locale=en-US)Werden vom Endpunkt verarbeitet. Weitere Informationen zu diesem Datenmodell finden Sie unter [EMR-Hilfe-Datenmodell](https://www.servicenow.com/docs/access?context=emr-data-model&version=yokohama&pubname=yokohama-healthcare-life-sciences&ft:locale=en-US).

Datensätze werden mithilfe der Anforderungsdefinitions-ID identifiziert.

### URL-Format

Versionierte URL: /api/sn_ind_rmt_help/{api_Version}/Remote_help_Request/{req_defn_ID}

Standard-URL: /api/sn_ind_rmt_help/Remote_help_Request/{req_defn_ID}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#remote_help_request-POST__entry__2}{#remote_help_request-POST__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 |
| req_defn_ID | Eindeutige ID der Anforderungsdefinition. Datentyp: Zeichenfolge Tabelle: In der ID-Spalte der Tabelle „Remote-Anforderungsdefinition" \[sn_ind_rmt_help_request_defn\]. |
[Tabelle : 1. Pfad-Parameter]

{#remote_help_request-POST__entry__8}

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

{#remote_help_request-POST__entry__12}

| Name | Beschreibung |
|-|-|
| request_data | Erforderlich. Name-Wert-Paare der Anforderungsdaten von EMR-System Zum Hinzufügen in die Tabelle „Remote-Anforderungsdaten" \[sn_ind_rmt_help_request_data\] und ihre untergeordneten Tabellen. Zum Beispiel: "request_data":{ "additional_info": "String", "application": "String", "environment": "String", "issue_type": "String", "millennium_username": "String", "position": "String", "server": "String", "session_recording_id": "String", "user_is_physician": "String", "work_station": "String" } Hinweis: Übergeben Sie nur Parameter, die in einer Anforderungsdefinition in konfiguriert sind request_dataObjekt. Alle anderen Parameter werden ignoriert. Weitere Informationen finden Sie unter [Konfigurieren Sie Anforderungsdefinitionen für EMR-Systeme](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=yokohama&pubname=yokohama-healthcare-life-sciences&ft:locale=en-US). Datentyp: Objekt |
| Quelle | Erforderlich. Name des EMR-Systems, das den Endpunkt aufruft, wie in einer Anforderungsdefinition angegeben. Zum Beispiel: "source":"Cerner" Datentyp: Zeichenfolge |
| Task_Parameters | Erforderlich. Name-Wert-Paare, die die Aufgabenparameter der IT-Serviceanfrage beschreiben. Jedes Element im Objekt entspricht einer Spalte in den entsprechenden Aufgabentabellen, z. B. der Tabelle „Incident \[Incident\]". Zum Beispiel: "task_parameters": { "caller_id": "String", "contact_type": "String", "impact": "String", "short_description": "String" } Hinweis: Übergeben Sie nur Parameter, die in einer Anforderungsdefinition in konfiguriert sind task_parametersObjekt. Alle anderen Parameter werden ignoriert. Weitere Informationen finden Sie unter [Konfigurieren Sie Anforderungsdefinitionen für EMR-Systeme](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=yokohama&pubname=yokohama-healthcare-life-sciences&ft:locale=en-US). Datentyp: Objekt |
[Tabelle : 3. Anforderungstext-Parameter (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.").
{#remote_help_request-POST__table_wvv_2yf_snb__entry__2}{#remote_help_request-POST__accept-JSON-only-entry-RESTAPI}{#remote_help_request-POST__content_type-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
[Tabelle : 4. Anforderungskopfzeilen.]

{#remote_help_request-POST__table_wvv_2yf_snb} {#remote_help_request-POST__entry__26}

| Header | Beschreibung |
|-|-|
| Keine |   |
[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.").
{#remote_help_request-POST__entry__30}{#remote_help_request-POST__entry-200-status-code}{#remote_help_request-POST__entry-401-status-code}{#remote_help_request-POST__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON)

{#remote_help_request-POST__entry__38}

| Name | Beschreibung |
|-|-|
| Ergebnis | Ergebnisobjekt. Datentyp: Objekt "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_id": "String", "task_table": "String", "warning": "String", "warningTranslated": "String" } |
| Ergebnis.Code | Anwendungsfehlercode, wenn result.statusWird als zurückgegeben Fehler . Datentyp: Zeichenfolge |
| Ergebnis.Fehler | Fehlermeldung, die enthalten ist, wenn result.statusIst Fehler. Diese Nachricht ist nur auf Englisch. Datentyp: Zeichenfolge |
| Ergebnis.Fehler übersetzt | Optionale lokalisierte Fehlermeldung. Datentyp: Zeichenfolge |
| Ergebnis.Status | Status der Antwort. Gültige Werte: * Fehler * Erfolg {#remote_help_request-POST__ul_awy_1dk_snb} Datentyp: Zeichenfolge |
| Ergebnis.Aufgabe_ID | SYS_ID der erstellten Aufgabe. Datentyp: Zeichenfolge |
| Ergebnis.Aufgabe_Tabelle | Name der Aufgabentabelle, in der die Aufgabe erstellt wurde, wie in der Anforderungsdefinition definiert. Datentyp: Zeichenfolge |
| Ergebnis.Warnung | Optionale Warnmeldung. Kann eingeschlossen werden, wenn result.statusIst Erfolg . Diese Nachricht ist nur auf Englisch. Datentyp: Zeichenfolge |
| Ergebnis.Warningübersetzt | Optionale lokalisierte Warnmeldung. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Fügen Sie Daten aus einem Zerner-EMR-System ein.

    curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request" 
    --request POST \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data "{
      "source":"Cerner",
      "task_parameters":{
        "short_description":"Unable to load patient data",
        "caller_id":"82d4ecb4db40e8100e28aa594b96195c",
        "impact":"2",
        "contact_type":"email"
      },
      "request_data":{
        "application":"Powerchart",
        "server":"CTXCHSITN453",
        "environment":"CTX24",
        "issue_type":"Helpdesk",
        "millennium_username":"JOHN JASON",
        "position":"Lab Tech",
        "session_recording_id":"s5ds34dd96491b959a35010651896k",
        "user_is_physician":"Yes",
        "work_station":"PC354FLR3STATION7",
        "additional_info":"MRN 222333"    
      }
    }" \
    --user "username":"password"

Die folgende Ausgabe zeigt sowohl eine erfolgreiche Antwort als auch eine Fehlerantwort an.

    // Successful response
    {
      "result": {
        "task_id": "75b09061db2cac100e28aa594b9619fa",
        "status": "success",
        "task_table": "incident",
        "warning": "Ignored invalid fields on table incident : test1",
        "warningTranslated": "Ignored invalid fields on table incident : test1"
      }
    }

    // Error response
    {  
          "result": {
          "status": "failure",
          "code": "1001",
          "error": "Invalid request definition: test_request1",
          "errorTranslated": "Invalid request definition: test_request1"
          }
          }

## Anforderung von Remote-Hilfe -- PUT /Remote_help_Request/{req_defn_ID/Task/{Task_ID} {#ariaid-title3}

Aktualisiert einen Datensatz in der angegebenen Remote-Anforderungsdatentabelle für die Aufgabe.
Ermöglicht Ihnen, zusätzlich zur sys_ID der Aufgabe eine Anforderungsdefinition-ID anzugeben, um eine Remote-Anforderung zu aktualisieren, die zuvor erstellt wurde.

### URL-Format

Versionierte URL: /api/sn_ind_rmt_help/{api_Version}/Remote_help_Request/{req_defn_ID/Task/{Task_ID}

Standard-URL: /api/sn_ind_rmt_help/Remote_help_Request/{req_defn_ID/Task/{Task_ID}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#remote_help_request-PUT__entry__2}{#remote_help_request-PUT__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 |
| req_defn_ID | Eindeutige ID der Anforderungsdefinition. Datentyp: Zeichenfolge Tabelle: In der ID-Spalte der Tabelle „Remote-Anforderungsdefinition" \[sn_ind_rmt_help_request_defn\]. |
| task_id | SYS_ID der zu aktualisierenden Aufgabe. Dieses Feld wird vom EMR-System bereitgestellt. Datentyp: Zeichenfolge |
[Tabelle : 7. Pfad-Parameter]

{#remote_help_request-PUT__entry__10}

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

{#remote_help_request-PUT__entry__14}

| Name | Beschreibung |
|-|-|
| request_data | Erforderlich. Name-Wert-Paare der Anforderungsdaten von EMR-System Dient zum Aktualisieren der Tabelle „Remote-Anforderungsdaten" \[sn_ind_rmt_help_request_data\] oder der zugehörigen untergeordneten Tabelle. Zum Beispiel: "request_data": { "additional_info" : "Please contact my office for more information." } Hinweis: Übergeben Sie nur Parameter, die in einer Anforderungsdefinition in konfiguriert sind request_dataObjekt. Alle anderen Parameter werden ignoriert. Weitere Informationen finden Sie unter [Konfigurieren Sie Anforderungsdefinitionen für EMR-Systeme](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=yokohama&pubname=yokohama-healthcare-life-sciences&ft:locale=en-US). Datentyp: Objekt |
| Quelle | Erforderlich. Name des EMR-Systems, das den Endpunkt aufruft, wie in einer Anforderungsdefinition angegeben. Zum Beispiel: "source":"Cerner" Datentyp: Zeichenfolge |
| Task_Parameters | Erforderlich. Name-Wert-Paare, die die Aufgabenparameter der IT-Serviceanfrage beschreiben. Jedes Element im Objekt entspricht einer Spalte in den entsprechenden Aufgabentabellen, z. B. der Tabelle „Incident \[Incident\]". Zum Beispiel: "task_parameters": { "impact":"1", "contact_type":"phone" } Hinweis: Übergeben Sie nur Parameter, die in einer Anforderungsdefinition in konfiguriert sind task_parametersObjekt. Alle anderen Parameter werden ignoriert. Weitere Informationen finden Sie unter [Konfigurieren Sie Anforderungsdefinitionen für EMR-Systeme](https://www.servicenow.com/docs/access?context=configure-emr-help-req-def&version=yokohama&pubname=yokohama-healthcare-life-sciences&ft:locale=en-US). Datentyp: Objekt |
[Tabelle : 9. Anforderungstext-Parameter (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.").
{#remote_help_request-PUT__table_wvv_2yf_snb__entry__2}{#remote_help_request-PUT__accept-JSON-only-entry-RESTAPI}{#remote_help_request-PUT__content_type-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Inhaltstyp | Datenformat des Anforderungstexts. Nur unterstützt application/json. |
[Tabelle : 10. Anforderungskopfzeilen.]

{#remote_help_request-PUT__table_wvv_2yf_snb} {#remote_help_request-PUT__entry__28}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. 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.").
{#remote_help_request-PUT__entry__32}{#remote_help_request-PUT__entry-200-status-code}{#remote_help_request-PUT__entry-401-status-code}{#remote_help_request-PUT__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 12. Statuscodes]

### Antworttext-Parameter (JSON)

{#remote_help_request-PUT__entry__40}

| Name | Beschreibung |
|-|-|
| Ergebnis | Ergebnisobjekt. Datentyp: Objekt "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "warning": "String", "warningTranslated": "String" } |
| Ergebnis.Code | Anwendungsfehlercode, wenn result.statusWird als zurückgegeben Fehler . Datentyp: Zeichenfolge |
| Ergebnis.Fehler | Fehlermeldung, die enthalten ist, wenn result.statusIst Fehler. Diese Nachricht ist nur auf Englisch. Datentyp: Zeichenfolge |
| Ergebnis.Fehler übersetzt | Optionale lokalisierte Fehlermeldung. Datentyp: Zeichenfolge |
| Ergebnis.Status | Status der Antwort. Gültige Werte: * Fehler * Erfolg {#remote_help_request-PUT__ul_awy_1dk_snb} Datentyp: Zeichenfolge |
| Ergebnis.Warnung | Optionale Warnmeldung. Kann eingeschlossen werden, wenn result.statusIst Erfolg . Diese Nachricht ist nur auf Englisch. Datentyp: Zeichenfolge |
| Ergebnis.Warningübersetzt | Optionale lokalisierte Warnmeldung. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Aktualisieren Sie eine IT-Serviceanfrage, die zuvor in erstellt wurde Cerner EMR-System

    curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request/task/207e57c1db60a410f50fdc5b4b96192e"
    --request PUT \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data "{
      "source":"Cerner",
      "task_parameters":{
        "impact":"1",
        "contact_type":"phone"
      },
      "request_data":{
        "additional_info" : "Please contact my office for more information."
      }
    }" \
    --user "username":"password"

Die folgende Ausgabe zeigt sowohl eine erfolgreiche Antwort als auch eine Fehlerantwort an.

    // Successful response
    {
      "result": {
        "status": "success"
      }
    }

    // Error response
    {
          {
          "result": {
          "status": "failure",
          "code": "1018",
          "error": "Record with sys_id 207e57js1db60a410f50fdc5b4b96192e does not exist in table incident",
          "errorTranslated": "Record with sys_id 207e57js1db60a410f50fdc5b4b96192e incident does not exist in table incident"
          }
          }
          }

## Anforderung von Remote-Hilfe -- GET /Remote_help_Request/{req_defn_ID} {#ariaid-title4}

Ruft eine Liste von Aufgaben ab, die der angegebenen ID und dem angegebenen Abfragefilter entsprechen.
Hinweis:  
* Referenz- und Auswahltypfelder werden immer als JSON-Objekte mit dem Wert und Display_value zurückgegeben.
* Datetime-Felder werden als Zeichenfolgen und immer in UTC zurückgegeben.
{#remote_help_request-GET__ul_nwf_z1f_tnb}

### URL-Format

Versionierte URL: /api/sn_ind_rmt_help/{api_Version}/Remote_help_Request/{req_defn_ID}

Standard-URL: /api/sn_ind_rmt_help/Remote_help_Request/{req_defn_ID}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#remote_help_request-GET__entry__2}{#remote_help_request-GET__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 |
| req_defn_ID | Eindeutige ID der zu aktualisierenden Anforderungsdefinition. Datentyp: Zeichenfolge Tabelle: In der ID-Spalte der Tabelle „Remote-Anforderungsdefinition" \[sn_ind_rmt_help_request_defn\]. |
[Tabelle : 13. Pfad-Parameter]

{#remote_help_request-GET__entry__8}

| Name | Beschreibung |
|-|-|
| query | Erforderlich. [Codierte Abfrage](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=yokohama&pubname=yokohama-platform-user-interface&ft:locale=en-US)Wird verwendet, um den Ergebnissatz zu filtern. Datentyp: Zeichenfolge |
[Tabelle : 14. Abfrageparameter]

{#remote_help_request-GET__entry__12}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 15. Anforderungstext-Parameter]

### 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.").
{#remote_help_request-GET__table_wvv_2yf_snb__entry__2}{#remote_help_request-GET__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 16. Anforderungskopfzeilen.]

{#remote_help_request-GET__table_wvv_2yf_snb} {#remote_help_request-GET__entry__20}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 17. 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.").
{#remote_help_request-GET__entry__24}{#remote_help_request-GET__entry-200-status-code}{#remote_help_request-GET__entry-401-status-code}{#remote_help_request-GET__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 18. Statuscodes]

### Antworttext-Parameter (JSON)

{#remote_help_request-GET__entry__32}

| Name | Beschreibung |
|-|-|
| Ergebnis | Ergebnisse zurückgeben. Datentyp: Objekt "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_list": [Array], "warning": "String", "warningTranslated": "String" } |
| Ergebnis.Code | Anwendungsfehlercode, wenn result.statusWird als zurückgegeben Fehler . Datentyp: Zeichenfolge |
| Ergebnis.Fehler | Fehlermeldung, die enthalten ist, wenn result.statusIst Fehler. Diese Nachricht ist nur auf Englisch. Datentyp: Zeichenfolge |
| Ergebnis.Fehler übersetzt | Optionale lokalisierte Fehlermeldung. Datentyp: Zeichenfolge |
| Ergebnis.Status | Status der Antwort. Mögliche Werte: * Fehler * Erfolg Datentyp: Zeichenfolge |
| Ergebnis.Aufgabenliste | Liste der Aufgaben. Datentyp: Array |
| Ergebnis.Warnung | Optionale Warnmeldung. Kann eingeschlossen werden, wenn result.statusIst Erfolg . Diese Nachricht ist nur auf Englisch. Datentyp: Zeichenfolge |
| Ergebnis.Warningübersetzt | Optionale lokalisierte Warnmeldung. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Rufen Sie Daten von ab Cerner EMR-System

    curl "https://instance.servicenow.com/api/remote_help_request/v1/sn_it_request/?query=active=true" \ 
    --header "Accept: application/json" \
    --header "Content-Type: application/json"
    {
      "source":"Cerner",
    } \
    --user "username":"password"

Die folgende Ausgabe zeigt sowohl eine erfolgreiche Antwort als auch eine Fehlerantwort an.

    // Successful response
    {
      "result": {
        "status": "success",
        "task_list": [
          {
            "number": "INC0010096",
            "short_description": "Unable to load data - 1",
            "assigned_to": {
              "value": "7a381da2dbfb5410f50fdc5b4b9619f2",
              "display_value": "Abel Tuter (IT agent)"
            },
            "opened_at": "2020-11-16 18:37:57",
            "closed_at": "",
            "closed_by": {},
            "state": {
              "value": "2",
              "display_value": "In Progress"
            },
            "priority": {
              "value": "5",
              "display_value": "5 - Planning"
            },
            "resolved_at": "",
            "resolved_by": {},
            "task_id": "207e57c1db60a410f50fdc5b4b96192e"
          },
          {
            "number": "INC0010095",
            "short_description": "Application freezes intermittently 3",
            "assigned_to": {},
            "opened_at": "2020-11-16 18:32:05",
            "closed_at": "",
            "closed_by": {},
            "state": {
              "value": "1",
              "display_value": "New"
            },
            "priority": {
              "value": "5",
              "display_value": "5 - Planning"
            },
            "resolved_at": "",
            "resolved_by": {},
            "task_id": "561d1f8ddb20a410f50fdc5b4b9619da"
          }
        ]
      }
    }

    // Error response
    {
      "result": {
      "status": "failure",
      "code": "1019",
      "error": "Invalid query in the request for table incident",
      "errorTranslated": "Invalid query in the request for table incident"
    }

## Anforderung von Remote-Hilfe -- GET /Remote_help_Request/{req_defn_ID}/Task/{Task_ID} {#ariaid-title5}

Ruft eine einzelne Aufgabe ab, wie in angegeben task_id.
Ermöglicht Ihnen, eine Anforderungsdefinitions-ID und eine Aufgaben-ID anzugeben und die Aufgabendetails abzurufen.  
Hinweis:  
* Referenz- und Auswahltypfelder werden immer als JSON-Objekte mit dem Wert und Display_value zurückgegeben.
* Datetime-Felder werden als Zeichenfolgen und immer in UTC zurückgegeben.
* In Journaltypfeldern werden nur zusätzliche Kommentare unterstützt.
* Zusätzliche Kommentare werden als JSON-Array von Objekten zurückgegeben. Jedes Objekt stellt einen Kommentar mit dar created_on, created_by, Und valueFelder. Die neuesten Kommentare werden zuerst gesendet.
{#remote_help_request-GET-task__ul_nwf_z1f_tnb}

### URL-Format

Versionierte URL: /api/sn_ind_rmt_help/{api_Version}/Remote_help_Request/{req_defn_ID}/Aufgabe/{Task_ID}

Standard-URL: /api/sn_ind_rmt_help/Remote_help_Request/{req_defn_ID}/Aufgabe/{Task_ID}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#remote_help_request-GET-task__entry__2}{#remote_help_request-GET-task__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. 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 |
| req_defn_ID | Eindeutige ID der Anforderungsdefinition. Datentyp: Zeichenfolge Tabelle: In der ID-Spalte der Tabelle „Remote-Anforderungsdefinition" \[sn_ind_rmt_help_request_defn\]. |
| task_id | SYS_ID der zurückzugebenden Aufgabe. Dieses Feld wird vom EMR-System bereitgestellt. Datentyp: Zeichenfolge |
[Tabelle : 19. Pfad-Parameter]

{#remote_help_request-GET-task__table_kpn_51f_tnb__entry__2}

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

{#remote_help_request-GET-task__table_kpn_51f_tnb} {#remote_help_request-GET-task__entry__14}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 21. Anforderungstext-Parameter]

### 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.").
{#remote_help_request-GET-task__table_wvv_2yf_snb__entry__2}{#remote_help_request-GET-task__accept-JSON-only-entry-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Nur unterstützt application/json. |
[Tabelle : 22. Anforderungskopfzeilen.]

{#remote_help_request-GET-task__table_wvv_2yf_snb} {#remote_help_request-GET-task__entry__22}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 23. 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.").
{#remote_help_request-GET-task__entry__26}{#remote_help_request-GET-task__entry-200-status-code}{#remote_help_request-GET-task__entry-401-status-code}{#remote_help_request-GET-task__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 24. Statuscodes]

### Antworttext-Parameter (JSON)

{#remote_help_request-GET-task__entry__34}

| Name | Beschreibung |
|-|-|
| Ergebnis | Ergebnisse zurückgeben. Datentyp: Objekt "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_parameters": {Object}, "warning": "String", "warningTranslated": "String" } |
| Ergebnis.Code | Anwendungsfehlercode, wenn result.statusWird als zurückgegeben Fehler . Datentyp: Zeichenfolge |
| Ergebnis.Fehler | Fehlermeldung, die enthalten ist, wenn result.statusIst Fehler. Diese Nachricht ist nur auf Englisch. Datentyp: Zeichenfolge |
| Ergebnis.Fehler übersetzt | Optionale lokalisierte Fehlermeldung. Datentyp: Zeichenfolge |
| Ergebnis.Status | Status der Antwort. Mögliche Werte: * Fehler * Erfolg Datentyp: Zeichenfolge |
| Ergebnis.Aufgabe_Parameter | Erforderlich. Name-Wert-Paare, die die Aufgabenparameter der IT-Serviceanfrage beschreiben. Jedes Element im Objekt entspricht einer Spalte in den entsprechenden Aufgabentabellen, z. B. der Tabelle „Incident \[Incident\]". Datentyp: Objekt |
| Ergebnis.Warnung | Optionale Warnmeldung. Kann eingeschlossen werden, wenn result.statusIst Erfolg . Diese Nachricht ist nur auf Englisch. Datentyp: Zeichenfolge |
| Ergebnis.Warningübersetzt | Optionale lokalisierte Warnmeldung. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Rufen Sie Daten von ab Cerner EMR-System

    curl "https://instance.servicenow.com/api/sn_ind_rmt_help/v1/remote_help_request/sn_it_request/task/207e57c1db60a410f50fdc5b4b96192e"\ 
    --request GET \ 
    --header "Accept: application/json"\ 
    --user "username":"password"

Die folgende Ausgabe zeigt sowohl eine erfolgreiche Antwort als auch eine Fehlerantwort an.

    // Successful response
    {
      "result": {
        "status": "success",
        "task_parameters": {
          "number": "INC0010096",
          "short_description": "Unable to load data - 1",
          "state": {
            "value": "2",
          "display_value": "In Progress"
          },
          "assigned_to": {
            "value": "7a381da2dbfb5410f50fdc5b4b9619f2",
            "display_value": "Abel Tuter (IT agent)"
          },
          "priority": {
            "value": "5",
            "display_value": "5 - Planning"
          },
          "caller_id": {
          "value": "82d4ecb4db40e8100e28aa594b96195c",
          "display_value": "Abel Tuter Requester"
        },
        "opened_at": "2020-11-16 18:37:57",
        "closed_at": "",
        "closed_by": {},
        "description": "",
        "impact": {
          "value": "1",
          "display_value": "1 - High"
        },
        "opened_by": {
          "value": "82d4ecb4db40e8100e28aa594b96195c",
          "display_value": "Abel Tuter Requester"
        },
        "close_code": {},
        "close_notes": "",
        "urgency": {
          "value": "3",
          "display_value": "3 - Low"
        },
        "category": {
          "value": "inquiry",
          "display_value": "Inquiry / Help"
        },
        "resolved_at": "",
        "resolved_by": {},
        "comments": [
          {
            "created_on": "2020-11-17 18:20:04",  
            "created_by": "Abel Tuter Requester",
            "value": "You can reach me during office hours."
          },
          {
            "created_on": "2020-11-16 18:40:14",
            "created_by": "Abel Tuter Requester",
            "value": "You can reach me during office hours."
          },
          {
            "created_on": "2020-11-16 18:38:29",
            "created_by": "Abel Tuter",
            "value": "Hello there\rName of app please"
          }],
        "task_id": "207e57c1db60a410f50fdc5b4b96192e"
        }
      }
    }

    // Error response
    {
      "result": {
        "status": "failure",
        "code": "1001",
        "error": "Invalid request definition: test_request2",
        "errorTranslated": "Invalid request definition: test_request2"
      }
    }


