API für Remote-Hilfeanforderungen

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 12 Minuten Lesedauer

    • Die API für Remote -Hilfeanforderungen bietet Endpunkte zum Erstellen, Anzeigen und Abrufen von Listen von IT-Serviceanfragen und deren Details aus einem EMR-System (Elektronische Patientenakte). Eine IT-Serviceanfrage ist einem Aufgabentyp zugeordnet, z. B. einem Incident in der Instanz ServiceNow.

    Sie können diese API nur verwenden, wenn EMR Help Die Anwendung (sn_ind_rmt_help) wird aus dem ServiceNow Storeinstalliert. Besuchen Sie die ServiceNow Store-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.

    Für den Zugriff auf die Endpunkte dieser API erforderliche Rolle: sn_ind_rmt_help.requester.

    Remote -Hilfeanforderung – POST /remote_help_request/{req_defn_id}

    Fügt Systemdaten für elektronische Patientenakten (EMR) in die entsprechenden ServiceNow -Tabellen ein.

    Sie müssen zusätzlich zu den Parametern für die Aufgabe und zusätzlichen Daten aus dem EMR-System, die in der der Aufgabe zugeordneten Anforderungsdatentabelle gespeichert sind, eine Anforderungsdefinitions-ID angeben. An diesen Endpunkt übergeben Sie zwei Arten von Daten. Das 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. Das zweite sind 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 den Anforderungsdefinitionen definiert sind, werden vom Endpunkt verarbeitet. Weitere Informationen zu diesem Datenmodell finden Sie unter EMR Help-Datenmodell.

    Datensätze werden anhand 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}

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    req_defn_id Eindeutige ID der Anforderungsdefinition. Dieser Wert entspricht der ID-Spalte in der Tabelle „Remote-Anforderungsdefinition“ [sn_ind_rmt_help_request_defn].

    Datentyp: Zeichenfolge
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (JSON)
    Name Beschreibung
    request_data Erforderlich. Name-Wert-Paare der Anforderungsdaten aus dem EMR-System, die der Tabelle „Remote-Anforderungsdaten“ [sn_ind_rmt_help_request_data] und ihren untergeordneten Tabellen hinzugefügt werden sollen.

    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 im Objekt request_data konfiguriert sind. Alle anderen Parameter werden ignoriert. Weitere Informationen finden Sie unter Anforderungsdefinitionen für EMR-Systeme konfigurieren.

    Datentyp: Objekt
    Quelle Erforderlich. Name des EMR-Systems, das den Endpunkt aufruft, wie in einer Anforderungsdefinition angegeben.

    Beispiel:

    "source":"Cerner"

    Datentyp: Zeichenfolge
    task_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 Incident-Tabelle [incident].

    Beispiel:

    "task_parameters": {
  "caller_id": "String",
  "contact_type": "String",
  "impact": "String",
  "short_description": "String"
}
    Hinweis:
    Übergeben Sie nur Parameter, die in einer Anforderungsdefinition im Objekt task_parameters konfiguriert sind. Alle anderen Parameter werden ignoriert. Weitere Informationen finden Sie unter Anforderungsdefinitionen für EMR-Systeme konfigurieren.

    Datentyp: Objekt

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile 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 HTTP-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Ergebnis Ergebnisobjekt.
    "result": {
  "code": "String",
  "error": "String",  
  "errorTranslated": "String",
  "status": "String",
  "task_id": "String",
  "task_table": "String",
  "warning": "String",
  "warningTranslated": "String"
}

    Datentyp: Objekt
    result.code Anwendungsfehlercode, wenn result.status als Fehlerzurückgegeben wird.

    Datentyp: Zeichenfolge
    result.error Fehlermeldung, die enthalten ist, wenn result.status fehlschlägt.

    Diese Nachricht ist nur auf Englisch verfügbar.

    Datentyp: Zeichenfolge
    result.errorÜbersetzt Optionale lokalisierte Fehlermeldung.

    Datentyp: Zeichenfolge
    result.status Status der Antwort.
    Gültige Werte:
    • Erfolg
    • Fehler

    Datentyp: Zeichenfolge
    result.task_id Sys_id der erstellten Aufgabe.

    Datentyp: Zeichenfolge
    result.task_table Name der Aufgabentabelle, in der die Aufgabe erstellt wurde, wie in der Anforderungsdefinition definiert.

    Datentyp: Zeichenfolge
    result.warning Optionale Warnmeldung. Kann eingeschlossen werden, wenn result.statuserfolgreichist.

    Diese Nachricht ist nur auf Englisch verfügbar.

    Datentyp: Zeichenfolge
    result.warningÜbersetzt Optionale lokalisierte Warnmeldung.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Fügen Sie Daten aus einem EMR-System von Cerner 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.

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

    Remote -Hilfeanforderung – PUT /remote_help_request/{req_defn_id/task/{task_id}

    Aktualisiert einen Datensatz in der angegebenen Remote-Anforderungsdatentabelle für die Aufgabe.

    Ermöglicht die Angabe einer Anforderungsdefinitions-ID zusätzlich zur sys_id der Aufgabe, um eine zuvor erstellte Remote-Anforderung zu aktualisieren.

    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}

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    req_defn_id Eindeutige ID der Anforderungsdefinition. Dieser Wert entspricht der ID-Spalte in der Tabelle „Remote-Anforderungsdefinition“ [sn_ind_rmt_help_request_defn].

    Datentyp: Zeichenfolge
    task_id Sys_id der zu aktualisierenden Aufgabe. Dieses Feld wird vom EMR-Systembereitgestellt.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstextparameter (JSON)
    Name Beschreibung
    request_data Erforderlich. Name-Wert-Paare der Anforderungsdaten aus dem EMR-System zum Aktualisieren der Tabelle „Remote-Anforderungsdaten“ [sn_ind_rmt_help_request_data] oder deren untergeordnete Tabelle.

    Beispiel:

    "request_data": {
 "additional_info" : "Please contact my office for more information."
}
    Hinweis:
    Übergeben Sie nur Parameter, die in einer Anforderungsdefinition im Objekt request_data konfiguriert sind. Alle anderen Parameter werden ignoriert. Weitere Informationen finden Sie unter Anforderungsdefinitionen für EMR-Systeme konfigurieren.

    Datentyp: Objekt
    Quelle Erforderlich. Name des EMR-Systems, das den Endpunkt aufruft, wie in einer Anforderungsdefinition angegeben.

    Beispiel:

    "source":"Cerner"

    Datentyp: Zeichenfolge
    task_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 Incident-Tabelle [incident].

    Beispiel:

    "task_parameters": {
  "impact":"1",
  "contact_type":"phone"
}
    Hinweis:
    Übergeben Sie nur Parameter, die in einer Anforderungsdefinition im Objekt task_parameters konfiguriert sind. Alle anderen Parameter werden ignoriert. Weitere Informationen finden Sie unter Anforderungsdefinitionen für EMR-Systeme konfigurieren.

    Datentyp: Objekt

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile 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 HTTP-Antwortcodesder REST-API.

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Ergebnis Ergebnisobjekt.
    "result": {
  "code": "String",
  "error": "String",  
  "errorTranslated": "String",
  "status": "String",
  "warning": "String",
  "warningTranslated": "String"
}

    Datentyp: Objekt
    result.code Anwendungsfehlercode, wenn result.status als Fehlerzurückgegeben wird.

    Datentyp: Zeichenfolge
    result.error Fehlermeldung, die enthalten ist, wenn result.status fehlschlägt.

    Diese Nachricht ist nur auf Englisch verfügbar.

    Datentyp: Zeichenfolge
    result.errorÜbersetzt Optionale lokalisierte Fehlermeldung.

    Datentyp: Zeichenfolge
    result.status Status der Antwort.
    Gültige Werte:
    • Erfolg
    • Fehler

    Datentyp: Zeichenfolge
    result.warning Optionale Warnmeldung. Kann eingeschlossen werden, wenn result.statuserfolgreichist.

    Diese Nachricht ist nur auf Englisch verfügbar.

    Datentyp: Zeichenfolge
    result.warningÜbersetzt Optionale lokalisierte Warnmeldung.

    Datentyp: Zeichenfolge

    cURL-Anforderung

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

    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.

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

    Remote -Hilfeanforderung – GET /remote_help_request/{req_defn_id}

    Ruft eine Liste der Aufgaben ab, die der angegebenen ID und dem angegebenen Abfragefilter entsprechen.

    Hinweis:
    • Referenz- und Auswahltypfelder werden immer als JSON-Objekte mit Wert und display_value zurückgegeben.
    • DateTime-Felder werden als Zeichenfolgen und immer in UTC zurückgegeben.

    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}

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. 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. Dieser Wert entspricht der ID-Spalte in der Tabelle „Remote-Anforderungsdefinition“ [sn_ind_rmt_help_request_defn].

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    query Erforderlich. Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet wird.

    Datentyp: Zeichenfolge
    Tabelle : 15. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile 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 HTTP-Antwortcodesder REST-API.

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Ergebnis Ergebnisse zurückgeben.
    "result": {
  "code": "String",
  "error": "String",  
  "errorTranslated": "String",
  "status": "String",
  "task_list": [Array],
  "warning": "String",
  "warningTranslated": "String"
}

    Datentyp: Objekt
    result.code Anwendungsfehlercode, wenn result.status als Fehlerzurückgegeben wird.

    Datentyp: Zeichenfolge
    result.error Fehlermeldung, die enthalten ist, wenn result.status fehlschlägt.

    Diese Nachricht ist nur auf Englisch verfügbar.

    Datentyp: Zeichenfolge
    result.errorÜbersetzt Optionale lokalisierte Fehlermeldung.

    Datentyp: Zeichenfolge
    result.status Status der Antwort.
    Mögliche Werte:
    • Fehler
    • Erfolg

    Datentyp: Zeichenfolge
    result.task_list Liste der Aufgaben.

    Datentyp: Array
    result.warning Optionale Warnmeldung. Kann eingeschlossen werden, wenn result.statuserfolgreichist.

    Diese Nachricht ist nur auf Englisch verfügbar.

    Datentyp: Zeichenfolge
    result.warningÜbersetzt Optionale lokalisierte Warnmeldung.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Rufen Sie Daten aus einem EMR-System von Cerner ab

    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.

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

    Remote -Hilfeanforderung – GET /remote_help_request/{req_defn_id}/task/{task_id}

    Ruft eine einzelne Aufgabe ab, wie in task_idangegeben.

    Ermöglicht die Angabe einer Anforderungsdefinitions-ID und einer Aufgaben-ID und das Abrufen der Aufgabendetails.
    Hinweis:
    • Referenz- und Auswahltypfelder werden immer als JSON-Objekte mit 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 den Feldern created_on, created_byund value dar. Die neuesten Kommentare werden zuerst gesendet.

    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}

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    req_defn_id Eindeutige ID der Anforderungsdefinition. Dieser Wert entspricht der ID-Spalte in der Tabelle „Remote-Anforderungsdefinition“ [sn_ind_rmt_help_request_defn].

    Datentyp: Zeichenfolge
    task_id Sys_id der zurückzugebenden Aufgabe. Dieses Feld wird vom EMR-Systembereitgestellt.

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstextparameter
    Name Beschreibung
    Keine

    Kopfzeilen

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile 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 HTTP-Antwortcodesder REST-API.

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    401 Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Ergebnis Ergebnisse zurückgeben.
    "result": {
  "code": "String",
  "error": "String",  
  "errorTranslated": "String",
  "status": "String",
  "task_parameters": {Object},
  "warning": "String",
  "warningTranslated": "String"
}

    Datentyp: Objekt
    result.code Anwendungsfehlercode, wenn result.status als Fehlerzurückgegeben wird.

    Datentyp: Zeichenfolge
    result.error Fehlermeldung, die enthalten ist, wenn result.status fehlschlägt.

    Diese Nachricht ist nur auf Englisch verfügbar.

    Datentyp: Zeichenfolge
    result.errorÜbersetzt Optionale lokalisierte Fehlermeldung.

    Datentyp: Zeichenfolge
    result.status Status der Antwort.
    Mögliche Werte:
    • Fehler
    • Erfolg

    Datentyp: Zeichenfolge
    result.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 Incident-Tabelle [incident].

    Datentyp: Objekt
    result.warning Optionale Warnmeldung. Kann eingeschlossen werden, wenn result.statuserfolgreichist.

    Diese Nachricht ist nur auf Englisch verfügbar.

    Datentyp: Zeichenfolge
    result.warningÜbersetzt Optionale lokalisierte Warnmeldung.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Rufen Sie Daten aus einem EMR-System von Cerner ab

    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.

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