API für Remote-Hilfeanforderung

Die Anforderung der Remote-Hilfe Die API bietet Endpunkte zum Erstellen, Anzeigen und Abrufen von Listen von IT-Serviceanfragen und ihren Details aus einem System für elektronische Krankenakte (EMR). Eine IT-Serviceanfrage ist einem Aufgabentyp wie einem Incident in zugeordnet ServiceNow Instanz.

Sie können diese API nur verwenden, wenn EMR-Hilfe Anwendung (sn_ind_rmt_help) wird über installiert ServiceNow Store. 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.Anforderer.

Anforderung der Remote-Hilfe – POST /Remote_help_Request/{req_defn_ID}

Fügt Systemdaten für elektronische Krankenakte (EMR) in die entsprechende ein ServiceNow Tabellen.

Sie müssen angeben ID der Anforderungsdefinition Zusätzlich zu den Parametern für die Aufgabe und zusätzlichen Daten aus dem 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 sind die Aufgabenparameter der IT-Serviceanforderung, 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 Werden vom Endpunkt verarbeitet. Weitere Informationen zu diesem Datenmodell finden Sie unter EMR-Hilfe-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}

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

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
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 : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstext-Parameter (JSON)

Name	Beschreibung
request_data	Erforderlich. Name-Wert-Paare der Anforderungsdaten von EMR-System Zum Hinzufügen der Tabelle „Remote-Anforderungsdaten“ [sn_ind_rmt_help_Request_Data] und ihrer 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 . 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 . 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 REST API-HTTP-Antwortcodes .

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. 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 zurückgegeben als 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 Datentyp: Zeichenfolge
Ergebnis.Task_ID	SYS_ID der erstellten Aufgabe. Datentyp: Zeichenfolge
Ergebnis.Task_table	Name der Aufgabentabelle, in der die Aufgabe erstellt wurde, wie in der Anforderungsdefinition definiert. Datentyp: Zeichenfolge
Ergebnis.Warnung	Optionale Warnmeldung. Kann einbezogen 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 Cerner 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.

// 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 der Remote-Hilfe – PUT /Remote_help_Request/{req_defn_ID/Task/{Task_ID}

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

Ermöglicht Ihnen, zusätzlich zur sys_ID der Aufgabe eine Anforderungsdefinitions-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 . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

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
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 : 8. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 9. Anforderungstext-Parameter (JSON)

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 . 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 . 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 REST API-HTTP-Antwortcodes .

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. Datentyp: Objekt "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "warning": "String", "warningTranslated": "String" }
Ergebnis.Code	Anwendungsfehlercode, wenn result.statusWird zurückgegeben als 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 Datentyp: Zeichenfolge
Ergebnis.Warnung	Optionale Warnmeldung. Kann einbezogen 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.

// 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 der Remote-Hilfe – GET /Remote_help_Request/{req_defn_ID}

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

Hinweis:

Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

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
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 : 14. Abfrageparameter

Name	Beschreibung
query	Erforderlich. Codierte Abfrage Wird zum Filtern des Ergebnissatzes verwendet. 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 REST API-HTTP-Antwortcodes .

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. Datentyp: Objekt "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_list": [Array], "warning": "String", "warningTranslated": "String" }
Ergebnis.Code	Anwendungsfehlercode, wenn result.statusWird zurückgegeben als 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.Task_list	Liste der Aufgaben. Datentyp: Array
Ergebnis.Warnung	Optionale Warnmeldung. Kann einbezogen werden, wenn result.statusIst Erfolg . Diese Nachricht ist nur auf Englisch. Datentyp: Zeichenfolge
Ergebnis.Warningübersetzt	Optionale lokalisierte Warnmeldung. Datentyp: Zeichenfolge

cURL-Anforderung

Daten von abrufen 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.

// 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 der Remote-Hilfe – GET /Remote_help_Request/{req_defn_ID}/Task/{Task_ID}

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

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

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

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
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 : 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 REST API-HTTP-Antwortcodes .

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. Datentyp: Objekt "result": { "code": "String", "error": "String", "errorTranslated": "String", "status": "String", "task_parameters": {Object}, "warning": "String", "warningTranslated": "String" }
Ergebnis.Code	Anwendungsfehlercode, wenn result.statusWird zurückgegeben als 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.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]. Datentyp: Objekt
Ergebnis.Warnung	Optionale Warnmeldung. Kann einbezogen werden, wenn result.statusIst Erfolg . Diese Nachricht ist nur auf Englisch. Datentyp: Zeichenfolge
Ergebnis.Warningübersetzt	Optionale lokalisierte Warnmeldung. Datentyp: Zeichenfolge

cURL-Anforderung

Daten von abrufen 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.

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