Change-Verwaltungs-API

Die Change-Management Die API stellt Endpunkte bereit, die die Integration von Drittanbieteranwendungen mit ermöglichen ServiceNow Change-Management Prozess.

Durch die Integration Ihrer Anwendung in den ServiceNow-Change-Management-Prozess, verfügen alle Change Requests, unabhängig davon, wo sie initiiert werden, über eine einzige wahrheitsgemäße Version und bieten eine einzige Auditquelle.

Verwenden Sie diese REST-API, um Ihren Change-Management-Prozess in externe Anwendungen und bei der Entwicklung zu integrieren ServiceNow Clientseitige Anwendungen.

Mit dieser REST-API können Integratoren:

• Initiieren Sie eine Standard-Change-Anforderung aus einer veröffentlichten Standard-Change-Anforderungsvorlage.
• Erstellen Sie eine Change-Anforderung vom Typ Notfall oder Normal.
• Aktualisieren Sie jedes Feld, das in der Tabelle „Change-Anforderung“ für eine Change-Anforderung vorhanden ist.
• Aktualisieren Sie alle Felder, die in der Change-Aufgabentabelle und Arbeitsaufgaben vorhanden sind, von der Erstellung bis zum Abschluss/Abbruch.
• Rufen Sie eine bestimmte Change-Anforderung, eine Standardvorlage, eine Change-Anforderungsaufgabe oder ein Change-Modell ab.
• Rufen Sie mehrere Change-Anforderungen, Standardvorlagen und Change-Anforderungsaufgaben mithilfe der Paginierung ab.
• Führen Sie eine Risikobewertung durch.
• Aktualisieren Sie die betroffenen Services.
• Generieren und verarbeiten Sie alle zugehörigen Genehmigungsaktivitäten, die einer Change-Anforderung zugeordnet sind.
• Identifizieren Sie potenzielle Planungskonflikte, und identifizieren Sie Zeiträume, in denen keine Konflikte vorhanden sind.
• Löschen Sie Change-Anforderungen, Change-Anforderungsaufgaben und Konfliktüberprüfungsprozesse.
• Erstellen Sie einen Change-Anforderungsdatensatz basierend auf einem Change-Modell-Datensatz.
• Ruft eine Liste der verfügbaren status für die angegebene Change-Anforderung ab, einschließlich des aktuellen Status.

Die Change-Management Die API unterstützt ITIL-Typen und Change-Modelle mit Workflow-Studio Und Workflow. Change-Modelle bieten zweckdienliche Changes. Typen und Modelle definieren Übergangskriterien, die erfüllt sein müssen, bevor die Change-Anforderung in den nächsten Status übergehen kann. Sie können diese Kriterien mithilfe von status, Workflows, Tools und Business-Regeln definieren.

• Traditionelle ITIL-Typen: Standard, Notfall und Normal.
• status des Change-Modells: Neu, geplant, Implementieren, Überprüfen und Geschlossen.

Sie können zusätzliche Change-Modelle in konfigurieren ServiceNow Führen Sie eine Instanz durch, und erstellen Sie dann Change-Anforderungen basierend auf diesen Change-Modellen mithilfe von Endpunkten in dieser API. Verwenden Sie Change-Management – GET /sn_chg_Rest/Change/model/{sys_ID} Und Change-Management – GET /sn_chg_Rest/Change/model Endpunkte zum Abrufen der verfügbaren Change-Modelle in einer Instanz. Verwenden Sie dann Change-Management – NACH /sn_chg_Rest/Change Dient zum Erstellen einer Change-Anforderung basierend auf einem angegebenen Change-Modell.

Informationen zum Konfigurieren von Change-Modellen finden Sie unter Konfigurieren Sie Change-Management .

Die folgenden Rollen sind für den Zugriff auf erforderlich Change-Management Endpunkte:

• LÖSCHEN: Change_Manager oder admin
• GET: Change_Manager, itil, sn_Change_read oder admin
• PATCH/POST: Change_Manager, itil oder admin

Zusätzlich dazu können Administratoren Change-Eigenschaften zum Konfigurieren des Change-Verwaltungs-Verhaltens verwenden. Eine Liste dieser Eigenschaften und eine Beschreibung ihrer verfügbaren Funktionen finden Sie unter Change-Management-Eigenschaften .

Change-Management – LÖSCHEN SIE /sn_chg_Rest/Change/{Change_sys_ID}/Task/{Task_sys_ID}

Löscht die Change Request-Aufgabe, die von der angegebenen sys_id identifiziert wird.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/Task/{Task_sys_ID}

Standard-URL: /api/sn_chg_rest/change/{change_sys_id}/task/{task_sys_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
change_sys_id	SYS_ID der Change-Anforderung, der die Aufgabe zugeordnet ist. Überprüft, dass die Aufgabe tatsächlich dem angegebenen Change Request zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]
task_sys_id	SYS_ID der zu löschenden Change-Anforderungsaufgabe. Datentyp: Zeichenfolge Tabelle: Change-Aufgaben [Change_Task]

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter (XML oder JSON)

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 : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: 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.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Alle Felder (Schlüssel) mit ihren zugehörigen Werten für die identifizierte Change Request-Aufgabe vor dem Löschen. Datentyp: Objekt
übergeordnet	Informationen für die Change-Anforderung, der diese Aufgabe zugeordnet war. Datentyp: Objekt parent: { display_value: "String", value: "String" }
Parent.Display_value	SYS_ID der übergeordneten Aufgabe, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
Übergeordnetes Element.Wert	SYS_ID der übergeordneten Aufgabe. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen für die gelöschte Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5" \
--request DELETE \
--header "Accept:application/json" \ 
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "12629ec4b750230096c3e4f6ee11a9d5",
        display_value: "12629ec4b750230096c3e4f6ee11a9d5"
      },
      parent: {
        value: "0f4ac6c4b750230096c3e4f6ee11a9fe", 
        display_value: "CHG0033046 "
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Retire both nodes",
        display_value: "Retire both nodes"
      }
    }
  ]
}

Change-Management: LÖSCHEN SIE /sn_chg_Rest/Change/{sys_ID}

Löscht die Change-Anforderung, die der angegebenen sys_ID zugeordnet ist

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}

Standard-URL: /api/sn_chg_Rest/Change/{sys_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
sys_id	SYS_ID des zu löschenden Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 8. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 9. Anforderungstextparameter (XML oder JSON)

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 : 10. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: 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	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Ergebnis	Datensatz der Change-Anforderung, der gelöscht wurde. Jedes Element in diesem Objekt entspricht einem Feld im Datensatz der Tabelle „Change-Anforderung“ [Change_Request]. Datentyp: Objekt

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

{
  "result":
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Reboot the server at 6 am",
        "value": "Reboot the server at 6 am"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "b0dbda5347c12200e0ef563dbb9a718f",
        "value": "b0dbda5347c12200e0ef563dbb9a718f"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
}

Change-Management: LÖSCHEN SIE /sn_chg_Rest/Change/{sys_ID}/Konflikt

Bricht den laufenden Konflikt-Überprüfungsprozess für den angegebenen Change Request ab (sys_id).

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/Konflikt

Standard-URL: /api/sn_chg_rest/change/{sys_id}/conflict

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
sys_id	SYS_ID des Change-Anforderungsdatensatzes, für den der laufende Konfliktprüfungsprozess abgebrochen werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (XML oder JSON)

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
Keine

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.
400	Fehlerhafte Anforderung. Abbruch fehlgeschlagen.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Keine

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request DELETE \
--user "username":"password"

None

Change-Management – LÖSCHEN SIE /sn_chg_Rest/Change/Emergency/{sys_ID}

Löscht den Notfall-Change Request, der von der angegebenen sys_id identifiziert wird.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Emergency/{sys_ID}

Standard-URL: /api/sn_chg_rest/change/emergency/{sys_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
sys_id	SYS_ID der zu löschenden Notfall-Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change-Anforderung [ Change_Request]

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 21. Anforderungstextparameter (XML oder JSON)

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ützte Typen: application/json oder application/xml. Standard: 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	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Werte für alle Felder im zugehörigen Change Request. Datentyp: Objekt
Status	Status des Change Requests vor dem Löschen. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in der Anwenderoberfläche angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "b0dbda5347c12200e0ef563dbb9a718f", 
        display_value: "b0dbda5347c12200e0ef563dbb9a718f"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      },
    }, 
  ]
}

Change-Management – LÖSCHEN SIE /sn_chg_Rest/Change/normal/{sys_ID}

Löscht den normalen Change Request, der von der angegebenen sys_id identifiziert wird.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/normal/{sys_ID}

Standard-URL: /api/sn_chg_rest/change/normal/{sys_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 : 25. 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
sys_id	SYS_ID der normalen Change-Anforderung, die gelöscht werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 26. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 27. Anforderungstextparameter (XML oder JSON)

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 : 28. Anforderungskopfzeilen

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

Tabelle : 29. 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 : 30. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Werte für alle Felder im zugehörigen Change Request. Datentyp: Objekt
Status	Status des Change Requests vor dem Löschen. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in der Anwenderoberfläche angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in der Anwenderoberfläche angezeigt werden soll. Wert ist immer „Normal“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Normal“. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      },
    }, 
  ]
}

Change-Management – LÖSCHEN SIE /sn_chg_Rest/Change/Standard/{sys_ID}

Löscht den Standard-Change Request, der von der angegebenen sys_id identifiziert wird.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Standard/{sys_ID}

Standard-URL: /api/sn_chg_rest/change/standard/{sys_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 : 31. 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
sys_id	SYS_ID der zu löschenden Standard-Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 32. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 33. Anforderungstextparameter (XML oder JSON)

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 : 34. Anforderungskopfzeilen

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

Tabelle : 35. 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 : 36. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Alle Felder (Schlüssel) mit ihren zugehörigen Werten für den identifizierten Change Request.
Status	Status des Change Requests vor dem Löschen. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in der Anwenderoberfläche angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	Eindeutiger Identifier des Change Requests.

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "1c87925347c12200e0ef563dbb9a7177",
      state: {
        value: "-5", 
        display_value: "New"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    }, 
  ]
}

Change-Management – GET /sn_chg_Rest/Change/ci/{cmdb_ci_sys_ID}/schedule

Ermöglicht das Abrufen verfügbarer Zeitfenster nach Konfigurationselement-ID und Dauer mit der Option, die geplante Startzeit einzubeziehen.

Erforderliche Rolle: sn_Change_Writer.

Hinweis:

Beim Ausführen dieses Endpunkts werden die verfügbaren Start- und Endzeiten nicht aufgelistet. Verwenden Sie den im Antworttext bereitgestellten Link worker.linkEigenschaft zum Abrufen der Zeitplandaten.

Siehe auch:

• RUFEN SIE /sn_chg_Rest/Change/{Change_sys_ID}/schedule AB
• PATCH /sn_chg_Rest/Change/{Change_sys_ID}/schedule/first_available

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/ci/{cmdb_ci_sys_ID}/schedule

Standard-URL: /api/sn_chg_Rest/Change/ci/{cmdb_ci_sys_ID}/schedule

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 : 37. 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
cmdb_ci_sys_id	SYS_ID des Konfigurationselementdatensatzes. Für diesen Endpunkt ist keine Change-Anforderung erforderlich. Datentyp: Zeichenfolge Tabelle: Konfigurationselemente [cmdb_ci]

Tabelle : 38. Abfrageparameter

Name	Beschreibung
Duration_in_seconds	Dauer des Change in Sekunden, d. h. wie viel Zeit zum Abschließen der Change-Anforderungsaufgabe erforderlich ist. Datentyp: Ganzzahl
Geplant_Start_time	Optional. Datum und Uhrzeit, zu der die Implementierung der Change-Anforderung in UTC beginnen soll. Rufen Sie das verfügbare Zeitfenster ab, das um oder nach diesem Zeitpunkt beginnt. Wenn nicht angegeben, verwendet das System die aktuelle Uhrzeit als Startzeit. Format: jjjj-mm-TT hh:mm:ss Datentyp: Zeichenfolge

Tabelle : 39. Anforderungstextparameter (XML oder JSON)

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 : 40. Anforderungskopfzeilen

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

Tabelle : 41. 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 : 42. Statuscodes

Statuscode	Beschreibung
202	Das System hat die Anforderung akzeptiert.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Mögliche Probleme: cmdb_ci mit der angegebenen sys_ID kann nicht gefunden werden Der Datensatz ist entweder nicht vorhanden, oder der Anwender hat keinen Lesezugriff darauf. Der Wert des Abfrageparameters „duration_in_seconds“ wurde nicht angegeben. Ungültiger Abfrageparameterwert für duration_in_seconds oder planned_Start_time angegeben.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt "error": { "detail": "String", "message": "String", "status": "String" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	Meldung, die den Fehler identifiziert. Datentyp: Zeichenfolge
Nachrichten	Nachrichteninformationen. Datentyp: Objekt "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
Nachrichten.FehlerNachrichten	Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Datentyp: Array
messages.infoMessages	Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Datentyp: Array
Nachrichten.WarnungsNachrichten	Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Datentyp: Array
Anforderung	Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge
Status	Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt state: { display_value: "String", value: Number }
status.Display_value	Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueParameter. Mögliche Werte: Abschließen Fehler In Bearbeitung Warten Datentyp: Zeichenfolge
status.Wert	Numerischer Wert des Status des Mitarbeiters. Mögliche Werte: 1 2 3 4 Datentyp: Zahl
type	Typ der Anforderung. Gültiger Wert: Zeitplan Datentyp: Zeichenfolge
Mitarbeiter	Informationen zum zugehörigen Mitarbeiter. Datentyp: Objekt "worker": { "link": "String", "sysId": "String" }
Worker.Link	Link zum Abrufen von Zeitfensterdaten.Verwenden Sie die sys_ID in RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Zum Anzeigen von Ergebnissen. Datentyp: Zeichenfolge
Worker.sysId	SYS_ID des Mitarbeiters, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge
status	Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge

Rufen Sie verfügbare Zeitfenster ab

Verwenden Sie den in angegebenen Wert worker.linkUm Details zum Zeitplanfenster abzurufen. Der Wert hat das folgende Format:

https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>

Verwenden Sie die Worker_sys_ID in RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Zum Anzeigen von Ergebnissen.

Der Antworttext enthält den Status und liefert Ergebnisse, wenn die Verarbeitung abgeschlossen ist.

Die Ergebnisse des Parameters „Text der Mitarbeiterantwort“ hängen von der Verfügbarkeit des Zeitfensters ab.

• Wenn das angegebene Zeitfenster für die Change-Anforderung innerhalb des Zeitfensters des Zeitplans verfügbar ist, listet die Worker-API die verfügbaren Zeitfenster in auf payload.spans Eigenschaft. Die payload.spans Eigenschaft ist andernfalls nicht in den Ergebnissen aufgeführt.
• Wenn innerhalb des definierten Zeitfensters für die Dauer der Change-Anforderung keine Zeitfenster verfügbar sind, wird die verwendet messages.infoMessages gibt Folgendes an: D
  Hinweis:

  Der Standardwert für das Zeitfenster der Change-Anforderungsplanung ist 90 Tage. Um diesen Wert zu ändern, ändern Sie change.conflict.next_available.schedule_windowEigenschaft. Weitere Informationen finden Sie unter Konfigurieren Sie Konfliktanalyseeigenschaften .

Folgendes RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Das Beispiel zeigt die Ausgabe, die mit der im Worker.Link-Detail angegebenen ID bereitgestellt wird. Die Ergebnisliste zeigt offene Zeitspannen, die für die Aufgabendauer verfügbar sind.

{
  "result": {
    "worker": {
      "sysId": "d7d1f2b4a444b010f87712198fe9caae",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/d7d1f2b4a444b010f87712198fe9caae"
    },
    "request": "{\"cmdb_ci_sys_id\":\"82967cdd0ad3370236092104ce988d76\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    },
    "payload": {
      "spans": [
        {
          "start": {
            "value": "2021-05-15 08:00:00",
            "display_value": "2021-05-15 01:00:00"
          },
          "end": {
            "value": "2021-05-15 11:00:00",
            "display_value": "2021-05-15 04:00:00"
          }
        },
        {
          "start": {
            "value": "2021-05-22 08:00:00",
            "display_value": "2021-05-22 01:00:00"
          },
          "end": {
            "value": "2021-05-22 11:00:00",
            "display_value": "2021-05-22 04:00:00"
          }
        },
        ...
      ]
    }
  }
}

cURL-Anforderung

curl "https://instance.service-now.com/api/sn_chg_rest/change/ci/<cmdb_ci_sys_id>/schedule?duration_in_seconds=10800" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Ergebnisse enthalten Worker.Link-Details, die Sie verwenden können, um die angegebene sys_ID im Endpunkt GET /sn_chg_Rest/Change/Worker/ auszuführen.

{
  "result": {
    "worker": {
      "sysId": "1049419c1b4c3010f58a6572604bcb7a",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/1049419c1b4c3010f58a6572604bcb7a"
    },
    "request": "{\"cmdb_ci_sys_id\":\"<cmdb_ci_sys_id>\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

Change-Management – GET /sn_chg_Rest/Change

Ruft eine oder mehrere Change-Anforderungen basierend auf den angegebenen Kriterien ab.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change

Standard-URL: /api/sn_chg_Rest/Change

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 : 43. 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

Tabelle : 44. Abfrageparameter

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare zum Filtern des Ergebnissatzes. Der Name ist das Feld, in dem der angegebene Wert gefiltert wird. Dieser Parameter und sysparm_query schließen sich gegenseitig aus. Beispielweise können Sie anstelle der Verwendung von &sysparm_query=active=true die aufrufende Anweisung mithilfe von &active=true vereinfachen. Sie können auch den Anzeigewert verwenden, wenn das Feld ein Auswahl- oder ein Referenztypfeld ist, z. B. &state=closed anstatt &state=7. Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie sie jeweils mit einem kaufmännischen Und-Zeichen, z. B. &active=true&assigned_to=john.smith. Datentyp: Zeichenfolge
Bestellen	Feld, nach dem die zurückgesendeten Change Requests sortiert werden sollen. Datentyp: Zeichenfolge Standard: Name
sysparm_offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0
sysparm_query	Codierte Abfrage Wird zum Filtern des Ergebnissatzes verwendet. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>. <col_name>: Name der Tabellenspalte, nach der gefiltert werden soll. <operator>: Unterstützt die folgenden Werte: =: Stimmt genau überein mit <value>. !=: Stimmt nicht überein mit <value>. ^: Logisches UND, mehrfache Abfrageanweisungen. ^OR: Logisches ODER, mehrfache Abfrageanweisungen. LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. STARTSWITH: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. <value>: Wert, mit dem abgeglichen werden soll. Weitere Operatoren finden Sie unter Operators available for filters and queries. Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Beispiel: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> Beispiel: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge
Textsuche	Zeichenfolge, die zum Durchsuchen aller normalen Change Request-Datensatzfelder verwendet wird. Diese Suche verwendet ServiceNow Funktionalität der Volltextsuchplattform. Weitere Informationen zu finden ServiceNow Suchfunktionen, siehe Durchsuchen Sie die Administration . Standard: IR_AND_OR_QUERY

Tabelle : 45. Anforderungstextparameter (XML oder JSON)

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 : 46. Anforderungskopfzeilen

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

Tabelle : 47. 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 : 48. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Elemente	Beschreibung
Ergebnis	Liste, die mindestens ein Change-Anforderungs-Datensatzobjekt enthält. Jedes Objekt beschreibt eine Change-Anforderung. Jedes Element im Change-Anforderungsobjekt entspricht einem Feld im zugehörigen Datensatz in der Tabelle „Change-Anforderung“ [Change_Request]. Alle Elemente enthalten Wert Und Display_value Name-Wert-Paare. Datumsfelder enthalten ebenfalls Display_value_internal Name-Wert-Paare. Datentyp: Array
action_status	Aktueller Aktionsstatus der zugehörigen Change-Anforderung. Mögliche Werte: 1: Intern blockiert 2: Vom Kunden blockiert 3: Intern und vom Kunden blockiert 4: Handlungsbedarf Datentyp: Zahl
aktiv	Kennzeichnung, die angibt, ob die Change-Anforderung aktiv ist. Mögliche Werte: Wahr: Change-Anforderung ist aktiv Falsch: Change-Anforderung ist nicht aktiv Datentyp: Boolesch Standardwert: wahr
Activity_due	Datum und Uhrzeit, für die der zugehörige Fall abgeschlossen sein soll. Datentyp: Zeichenfolge
Zusätzliche_Beauftragte_Liste	Liste der sys_IDs zusätzlicher Personen, die der Arbeit an der Change-Anforderung zugewiesen sind. Datentyp: Array
Genehmigung	Typ des erforderlichen Genehmigungsprozesses. Datentyp: Zeichenfolge Standard: Nicht angefordert
Approval_history	Letzter Journaleintrag des Genehmigungsverlaufs. Datentyp: Zeichenfolge
Approval_Set	Datum und Uhrzeit der Genehmigung der zugehörigen Aktion. Datentyp: Zeichenfolge
assigned_to	SYS_ID des Anwenders, der der Change-Anforderung zugewiesen ist. Datentyp: Zeichenfolge
assignment_group	SYS_ID der Gruppe, die der Change-Anforderung zugewiesen ist. Datentyp: Zeichenfolge
Backout_Plan	Beschreibung des auszuführenden Plans, wenn der Change rückgängig gemacht werden muss. Datentyp: Zeichenfolge
Business_duration	Dauer in geplanten Arbeitsstunden, Arbeitstagen und Arbeitswochen, die zum Abschluss des Change benötigt wurde. Datentyp: Zeichenfolge
business_service	SYS_ID des Business-Service, der der Change-Anforderung zugeordnet ist. Befindet sich in der Tabelle „Service“ [cmdb_ci_Service]. Datentyp: Zeichenfolge
Cab_date	Datum, an dem sich das Change Advisory Board (CAB) trifft. Datentyp: Zeichenfolge
Cab_Delegate	SYS_ID des Anwenders, der den CAB-Manager während eines CAB-Meetings ersetzen kann. Befindet sich in der Anwendertabelle [sys_user] Datentyp: Zeichenfolge
Cab_Recommendation	Beschreibung der CAB-Empfehlungen für die Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000
Cab_required	Kennzeichnung, die angibt, ob das CAB erforderlich ist. Mögliche Werte: Wahr: Change Advisory Board ist erforderlich. Falsch: Change Advisory Board ist nicht erforderlich. Datentyp: Boolesch Standardwert: false
Calendar_duration	Derzeit nicht verwendet von Change-Management. Datentyp: Zeichenfolge
Kategorie	Kategorie des Change, z. B. Hardware, Netzwerk oder Software. Datentyp: Zeichenfolge Standard: Sonstiges
Change_Plan	Aktivitäten und Rollen für die Verwaltung und Steuerung der Change-Anforderung. Datentyp: Zeichenfolge
chg_model	SYS_ID des Change-Modells, auf dem die zugehörige Change-Anforderung basiert. Das Change-Modell definiert den Status-Flow, die Übergänge und die Prozessaktivitäten, die für die Change-Anforderung abgeschlossen werden müssen. Datentyp: Zeichenfolge Tabelle: Change-Modell [chg_model]
Closed_at	Datum und Uhrzeit, zu der die zugehörige Change-Anforderung geschlossen wurde. Datentyp: Zeichenfolge
closed_by	SYS_ID der Person, die die Change-Anforderung geschlossen hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
close_code	Code, der der Change-Anforderung zugewiesen wurde, als sie geschlossen wurde. Beispiel: Erfolgreich, erfolgreich mit Problemen und nicht erfolgreich. Datentyp: Zeichenfolge
close_notes	Merkt an, dass die Person beim Schließen der Change-Anforderung eingegeben hat. Datentyp: Zeichenfolge
cmdb_ci	SYS_ID des Konfigurationselements, das der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Konfigurationselement [cmdb_ci]
Kommentare	Liste der kundenorientierten Arbeitsnotizen, die in die zugehörige Change-Anforderung eingegeben wurden. Datentyp: Array
comments_and_work_notes	Liste der internen und kundenorientierten Arbeitsnotizen, die für die zugehörige Change-Anforderung eingegeben wurden. Datentyp: Array Maximale Länge: 4.000
Unternehmen	SYS_ID des Unternehmens, das der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Unternehmen [Core_Company]
Conflict_Last_Run	Datum und Uhrzeit der letzten Ausführung des Konflikterkennungsskripts für die Change-Anforderung. Datentyp: Zeichenfolge
Conflict_Status	Aktueller Konfliktstatus, wie vom Konflikterkennungsskript erkannt, z. B. Konflikt und nicht Ausführen. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Nicht Ausgeführt
Contact_type	Methode, mit der die Change-Anforderung ursprünglich angefordert wurde. Mögliche Werte: Chat E-Mail Telefon Social Media Web Datentyp: Zeichenfolge
contract	SYS_ID des Vertrags, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Vertrag [ast_contract]
Correlation_Display	Anwenderfreundlicher Name für correlation_id. Datentyp: Zeichenfolge Maximale Länge: 100
correlation_id	Global Unique ID (GUID) eines übereinstimmenden Change Request-Datensatzes in einem Drittparteisystem. Datentyp: Zeichenfolge Maximale Länge: 100
Delivery_Plan	Wird nicht mehr verwendet. SYS_ID des Bereitstellungsplans, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Ausführungsplan [sc_Cat_item_Delivery_Plan]
Delivery_Task	Wird nicht mehr verwendet. SYS_ID der Bereitstellungsaufgabe, die der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Ausführungsplanaufgabe [sc_Cat_item_Delivery_Task]
Beschreibung	Detaillierte Beschreibung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000
due_date	Fälligkeitsdatum der Aufgabe. Wird vom Change-Anforderungsprozess nicht verwendet. Datentyp: Zeichenfolge
end_date	Datum und Uhrzeit, zu der die Change-Anforderung abgeschlossen werden soll. Datentyp: Zeichenfolge
Eskalation	Aktuelle Eskalationsebene. Mögliche Werte: 0: Normal 1: Mittel 2: Hoch 3: Überfällig Datentyp: Zahl (Ganzzahl) Standard: 0
expected_start	Datum und Uhrzeit des Starts der Aufgabe. Wird vom Change-Anforderungsprozess nicht verwendet. Datentyp: Zeichenfolge
Follow_up	Datum und Uhrzeit der Nachverfolgung eines Anwenders mit der Person, die die Change-Anforderung anfordert. Datentyp: Zeichenfolge
Group_list	Liste der sys_IDs und Namen der Gruppen, die der Change-Anforderung zugeordnet sind. Datentyp: Array Maximale Länge: 4.000
impact	Auswirkungen auf die Change-Anforderung auf den Kunden. Mögliche Werte: 1: Hoch 2: Mittel 3: Niedrig Datentyp: Zahl (Ganzzahl) Standard: 3
Implementation_Plan	Sequenzielle Schritte, die zur Implementierung dieses Change ausgeführt werden sollen. Enthält auch alle Abhängigkeiten zwischen Schritten und Details zum Beauftragten für jeden Schritt. Datentyp: Zeichenfolge Maximale Länge: 4.000
Begründung	Vorteile der Implementierung dieses Change und Auswirkungen, wenn dieser Change nicht implementiert wird. Datentyp: Zeichenfolge Maximale Länge: 4.000
Wissen	Kennzeichnung, die angibt, ob der Change-Anforderung Knowledge Base-Artikel ()KB-Artikel zugeordnet sind. Mögliche Werte: Wahr: Zugeordnete KB-Artikel Falsch: Keine zugehörigen KB-Artikel Datentyp: Boolesch
location	SYS_ID und Name des Standorts der Ausrüstung, auf die in der Change-Anforderung verwiesen wird. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location]
Made_sla	Nicht mehr verwendet. Kennzeichnung, die angibt, ob die Change-Anforderung in Übereinstimmung mit der zugehörigen Servicelevel-Vereinbarung implementiert wurde. Datentyp: Boolesch
Needs_Attention	Kennzeichnung, die angibt, ob für die Change-Anforderung Handlungsbedarf besteht. Mögliche Werte: Wahr: Change-Anforderung erfordert zusätzliche Aufmerksamkeit. Falsch: Change-Anforderung erfordert keine zusätzliche Aufmerksamkeit. Datentyp: Boolesch Standardwert: false
Nummer	Change-Nummer, die der Change-Anforderung vom System zugewiesen ist, z. B. CHG0040007. Datentyp: Zeichenfolge
On_Hold	Kennzeichnung, die angibt, ob die Change-Anforderung derzeit angehalten ist. Mögliche Werte: Wahr: Angehalten Falsch: Nicht angehalten Datentyp: Boolesch Standardwert: false
On_hold_reason	Wenn on_holdParameter ist „wahr“, Beschreibung des Grunds, warum die Change-Anforderung aufgehalten wird. Datentyp: Zeichenfolge Maximale Länge: 4.000
On_hold_Task	Wenn on_holdParameter ist „wahr“, Liste der sys_IDs der Aufgaben, die abgeschlossen werden müssen, bevor die Sperre freigegeben wird. Datentyp: Zeichenfolge Maximale Länge: 4.000
Geöffnet_um	Datum und Uhrzeit der Erstellung des Change-Release. Datentyp: Zeichenfolge
opened_by	SYS_ID und Name des Anwenders, der das Change-Release erstellt hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Bestellen	Nicht verwendet von Change-Management. Optionales numerisches Feld, nach dem Datensätze sortiert werden sollen, z. B. beim Abrufen aus einer Datenbank. Datentyp: Zahl (Ganzzahl)
Outside_Maintenance_schedule	Kennzeichnung, die angibt, ob die Wartung durch ein externes Unternehmen für die Change-Anforderung geplant wurde. Mögliche Werte: Wahr: Externe Wartung geplant Falsch: Keine externe Wartung geplant Datentyp: Boolesch Standardwert: false
übergeordnet	SYS_ID und Name der übergeordneten Aufgabe für diese Change-Anforderung, falls vorhanden. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe]
Phase	Aktuelle Phase der Change-Anforderung. Dies definiert detaillierter, was der Change bewirkt. Mögliche Werte: akzeptieren Build plan Angefordert Datentyp: Zeichenfolge
Phase_Status	Change_Phase-Datensätze, die für einen Change erstellt werden sollen. Sie sind von der Kategorie abhängig, sodass jeder Change-Typ verschiedene Change_Phase-Datensätze haben kann. Die Change_Phase-Datensätze bieten eine Möglichkeit, den Genehmigungsprozess zu steuern, da jede Change_Phase einen Zeitplan und eine Reihe von Genehmigern haben kann. Mögliche Werte: Abschließen Angehalten offen abgelehnt Angefordert In Bearbeitung Datentyp: Zeichenfolge
Priorität	Priorität der Change-Anforderung. Mögliche Werte: 1: Kritisch 2: Hoch 3: Mittel 4: Niedrig Datentyp: Zahl (Ganzzahl) Standard: 4
Production_System	Kennzeichnung, die angibt, ob die Change-Anforderung für gilt ServiceNow Instanz, die sich in einer Produktionsumgebung befindet. Mögliche Werte: Wahr: Produktionsumgebung Falsch: Nicht-Produktionsumgebung Datentyp: Boolesch
Grund	Beschreibung, warum die Change-Anforderung initiiert wurde. Mögliche Werte: Geschäftsanforderungen Hardware-Upgrade Gesetzgebung Standortänderung Netzwerkanforderungen Neues oder entferntes CI Sonstige Problem gelöst Produkt oder Service geändert Software-Upgrade Anwender angefordert Datentyp: Zeichenfolge Maximale Länge: 40
Reassignment_count	Anzahl der Neuzuweisungen der Change-Anforderung an einen neuen Besitzer. Datentyp: Zahl (Ganzzahl) Standard: 0
Rejection_Goto	SYS_ID der Aufgabe, die ausgeführt werden soll, wenn die Change-Anforderung abgelehnt wird. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe]
Angefordert_von	SYS_ID des Anwenders, der den Change angefordert hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Request_by_date	Datum und Uhrzeit, zu der die Implementierung des Change angefordert wird. Datentyp: Zeichenfolge
Review_comments	Kommentare, die bei der Überprüfung der Change-Anforderung eingegeben wurden. Datentyp: Zeichenfolge Maximale Länge: 4.000
Review_date	Datum, an dem die Change-Anforderung überprüft wurde. Datentyp: Zeichenfolge
Review_Status	Aktueller Status der angeforderten Überprüfung der Change-Anforderung. Datentyp: Zeichenfolge
Risiko	Risikostufe, die der Change-Anforderung zugeordnet ist. Gültige Werte: 1: Hoch 2: Mittel 3: Niedrig Datentyp: Zahl Standard: 3
Risk_Impact_Analysis	Beschreibung des Risikos und Analyse der Implementierung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000
Route_reason	Derzeit nicht verwendet von Change-Management. Grund, warum die Change-Anforderung übertragen wurde. Mögliche Werte: 1: Übertragung mit Lösung 9: Übertragung ohne Lösungen Datentyp: Zahl
scope	Größe der Change-Anforderung. Mögliche Werte: 1: Massiv 2: Groß 3: Mittel 4: Klein 5: Winzig Datentyp: Zahl Standard: 3
Service.Offering	SYS_ID des Serviceangebots, das der Change-Anforderung zugeordnet ist. Serviceangebote definieren das Servicelevel in Bezug auf Verfügbarkeit, Umfang, Preise und Verpackungsoptionen eindeutig. Datentyp: Zeichenfolge Tabelle: Angebot [Service_offering]
short_description	Beschreibung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 40
Kompetenzen	Liste der sys_IDs aller Kompetenzen, die zum Implementieren der Change-Anforderung erforderlich sind. Datentyp: Array Tabelle: Kompetenz [cmn_Skill]
sla_due	Wird nicht mehr verwendet. Datum und Uhrzeit, zu der die Change-Anforderung basierend auf der zugehörigen Servicelevel-Vereinbarung abgeschlossen werden muss. Datentyp: Zeichenfolge
sn_esign_document	SYS_ID eines E-signierten Dokuments, das an die Change-Anforderung angehängt ist. Datentyp: Zeichenfolge Tabelle: Anhang [sys_attachment]
sn_esign_esignature_Configuration	SYS_ID der E-Signatur-Vorlage, die für das zugehörige Dokument verwendet wird. Datentyp: Zeichenfolge Tabelle: E-Signatur-Vorlage [sn_esign_Configuration]
start_date	Datum und Uhrzeit, zu der die Implementierung der Change-Anforderung beginnen soll. Datentyp: Zeichenfolge
Status	Aktueller Status des Change Requests. Mögliche Werte sind im Change-Modell definiert. Datentyp: Zahl (Ganzzahl) Standard: 1
std_Change_Producer_Version	SYS_ID des Datensatzerstellers und des Change-Vorschlags, die der Change-Anforderung zugeordnet sind. Enthält auch die Anzahl und den Prozentsatz erfolgreicher und nicht erfolgreicher Change-Anforderungen, die aus dem Vorschlag erstellt wurden. Datentyp: Zeichenfolge Tabelle: Standard-Change-Vorlagenversion [Std_Change_Producer_Version]
sys_class_name	Name der Tabelle, in der sich die Change-Anforderung befindet. Datentyp: Zeichenfolge
sys_created_by	Name des Anwenders, der die Change-Anforderung ursprünglich erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40
sys_created_on	Datum und Uhrzeit der ursprünglichen Erstellung des zugehörigen Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge
sys_domain	Wenn Domänen in der Instanz verwendet werden, der Name der Domäne, der der Change-Modul-Datensatz zugeordnet ist. Datentyp: Zeichenfolge
sys_domain_path	Bei Verwendung von Domänen in der Instanz der Domänenpfad, in dem sich der zugeordnete Change-Modul-Datensatz befindet. Datentyp: Zeichenfolge
sys_id	Eindeutiger Bezeichner des zugehörigen Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge
sys_mod_count	Anzahl der Updates für den Fall seit der ersten Erstellung. Datentyp: Zahl (Ganzzahl)
sys_updated_by	Person, die den Fall zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Falls. Datentyp: Zeichenfolge
Task_Effective_number	Universal-Anforderungsnummer. Datentyp: Zeichenfolge Maximale Länge: 40
Aufgabe_für	Nicht verwendet von Change-Management. SYS_ID des Anwenders, für den die Aufgabe erstellt wurde. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Test_Plan	Beschreibung des zugehörigen Testplans für den Change. Datentyp: Zeichenfolge Maximale Länge: 4.000
Time_worked	Gesamtzeit, die an der Change-Anforderung gearbeitet wurde. Datentyp: Zeichenfolge
type	Change-Anforderungstyp. Mögliche Werte: Notfall Normal Standard Datentyp: Zeichenfolge Maximale Länge: 40
Nicht autorisiert	Kennzeichnung, die angibt, ob die Change-Anforderung nicht autorisiert ist Mögliche Werte: Wahr: Nicht autorisiert Falsch: Autorisiert Datentyp: Boolesch
universal_request	SYS_ID der übergeordneten Universal-Anforderung, zu der diese Change-Anforderung gehört. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe]
On_Approval	Aktion, die ausgeführt werden soll, wenn die Change-Anforderung genehmigt wird. Mögliche Werte: Do_no Fahren Sie fort Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fortfahren
Bei_ablehnen	Aktion, die ausgeführt werden soll, wenn die Change-Anforderung abgelehnt wird. Mögliche Werte: abbrechen goto Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Abbrechen
urgency	Dringlichkeit der Change-Anforderung. Mögliche Werte: 1: Hoch 2: Mittel 3: Niedrig Datentyp: Zahl (Ganzzahl) Standard: 3
Anwender_Eingabe	Zusätzliche Anwendereingabe. Datentyp: Zeichenfolge Maximale Länge: 4.000
Variablen	Name-Wert-Paare von Variablen, die der Change-Anforderung zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40
Watch_list	Liste der sys_IDs der Anwender, die Benachrichtigungen zu dieser Change-Anforderung erhalten, wenn zusätzliche Kommentare hinzugefügt werden oder wenn der Status einer Change-Anforderung in „gelöst“ oder „Geschlossen“ geändert wird. Datentyp: Array Tabelle: Benutzer [sys_user]
wf_activity	SYS_ID des Workflow-Aktivitätsdatensatzes, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Workflow-Aktivität [wf_activity]
Work_End	Datum und Uhrzeit des Beendens der Arbeit an der Change-Anforderung. Datentyp: Zeichenfolge
work_notes	Informationen darüber, wie die Change-Anforderung gelöst wird, oder Schritte, die zu ihrer Lösung unternommen wurden. Datentyp: Zeichenfolge Maximale Länge: 4.000
Work_Notes_list	Liste der sys_IDs der internen Anwender, die Benachrichtigungen zu dieser Change-Anforderung erhalten, wenn Arbeitsnotizen hinzugefügt werden. Datentyp: Array Tabelle: Benutzer [sys_user]
Work_Start	Datum und Uhrzeit des Beginns der Arbeit an der Change-Anforderung. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Aus Kürze enthalten die Ergebnisse nur einen einzelnen Change-Anforderungsdatensatz.

{
  "result": [
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Clear BGP sessions on a Cisco router",
        "value": "Clear BGP sessions on a Cisco router"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "1766f1de47410200e90d87e8dee490f6",
        "value": "1766f1de47410200e90d87e8dee490f6"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
  ]
}

Change-Management – GET /sn_chg_Rest/Change/{Change_sys_ID}/nextstates

Ruft eine Liste der verfügbaren status für die angegebene Change-Anforderung ab, einschließlich des aktuellen Status.

Falls verfügbar, bietet es auch den Übergang zum nächsten Status basierend auf der Version des implementierten Change-Managements. Wenn die Changes vom Change-Modell gesteuert werden, gibt der Endpunkt Bedingungen zurück, die bestanden wurden oder nicht. Es enthält auch Informationen darüber, ob alle Bedingungen für einen bestimmten Übergang bestanden wurden. Diese Informationen sind für typgesteuerte und Legacy-Change-Anforderungen nicht verfügbar.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/nextstates

Standard-URL: /api/sn_chg_Rest/Change/{Change_sys_ID}/nextstates

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 : 49. 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
change_sys_id	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 50. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 51. Anforderungstextparameter (XML oder JSON)

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 : 52. Anforderungskopfzeilen

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

Tabelle : 53. 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 : 54. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Available_states	Werte für die status, die für die angegebene Change-Anforderung verfügbar sind, einschließlich des aktuellen Status. Datentyp: Array
state_label	Schlüssel-Wert-Paare, die Bezeichnungen den verfügbaren status zuordnen. Datentyp: Objekt
state_Transitions	Informationen darüber, was für den Übergang zu jedem verfügbaren Status erforderlich ist. Jeder eindeutige verfügbare „bis Status“ befindet sich in einem eigenen Array mit jedem unterschiedlichen Satz von Bedingungen, damit der Status in seinem eigenen Objekt vorliegt. Datentyp: Array "state_transitions": [ { "automatic_transition": Boolean, "conditions": [Array], "display_value": "String", "from_state": "String", "sys_id": "String", "to_state": "String", "transition_available": Boolean } ]
state_transitions.automatic_transition	Kennzeichnung, die angibt, ob automatisch in diesen Status übergegangen werden soll. Gültige Werte: Wahr: Change-Anforderung wechselt automatisch in diesen Status. Falsch: Change-Anforderung geht nicht automatisch in diesen Status über. Datentyp: Boolesch
state_Transitions.conditions	Liste der Bedingungen, die dem zugeordnet sind status . Datentyp: Array von Objekten "conditions": [ { "condition": {Object}, "passed": Boolean } ]
status_Transitions.Bedingungen.Bedingung	Werte einer bestimmten Bedingung. Datentyp: Objekt "condition": { "description": "String", "name": "String", "sys_id": "String" }
state_transitions.conditions.condition.description	Beschreibung der Bedingung. Datentyp: Zeichenfolge
state_transitions.conditions.condition.name	Name der Bedingung. Datentyp: Zeichenfolge
state_Transitions.conditions.condition.sys_ID	SYS_ID der Bedingung. Datentyp: Zeichenfolge
state_Transitions.conditions.Pass	Kennzeichnung, die angibt, ob die Change-Anforderung die zugehörige Bedingung erfüllt hat. Gültige Werte: Wahr: Erfüllt die Bedingung. Falsch: Die Bedingung wurde nicht erfüllt.
state_Transitions.Display_value	Angezeigte Beschreibung des Status. Datentyp: Zeichenfolge
state_transitions.from_state	Wert des Status, von dem die Change-Anforderung übergeht. Datentyp: Zeichenfolge
state_Transitions.sys_ID	SYS_ID des Übergangsstatus. Datentyp: Zeichenfolge
state_Transitions.to_State	Wert des Status, in den die Change-Anforderung übergeht. Datentyp: Zeichenfolge
state_Transitions.Transition_available	Kennzeichnung, die angibt, ob die Change-Anforderung von ihrem aktuellen Status in diesen Status übergehen kann. Gültige Werte: Wahr: Übergang in diesen Status möglich. Falsch: Übergang in diesen Status nicht möglich.

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f"/nextstates \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Ergebnisse zurückgeben:

{
  "result": {
    "available_states": [ "0", "4", "-1" ], // State values
    "state_transitions": [
      [
        {
          "sys_id": "7a0d2ccdc343101035ae3f52c1d3ae2e", // sttrm_state_transition sys id
          "display_value": "Implement to Review",
          "from_state": "-1",
          "to_state": "0",
          "transition_available": false, // If true, can move to this state
          "automatic_transition": true, // If true, automatically moves to this state
          "conditions": [
            {
              "passed": false, // If true, change request met this condition
              "condition": {
                "name": "No active Change Tasks",
                "description": null,
                "sys_id": "3c1d2ccdc343101035ae3f52c1d3aea4"
              }
            }
          ]
        },
        {
          "sys_id": "db401481c343101035ae3f52c1d3aedd",
          "display_value": "Implement to Review",
          "from_state": "-1",
          "to_state": "0",
          "transition_available": true,
          "automatic_transition": false,
          "conditions": [
            {
              "passed": true,
              "condition": {
                "name": "Not On hold",
                "description": null,
                "sys_id": "2132deb6c303101035ae3f52c1d3ae8c"
              }
            }
          ]
        }
      ],
      [
        {
          "sys_id": "5327c551c343101035ae3f52c1d3aeec",
          "display_value": "Implement to Canceled",
          "from_state": "-1",
          "to_state": "4",
          "transition_available": true,
          "automatic_transition": false,
          "conditions": []
        }
      ]
    ],
    "state_label": { // state value to label pairs
      "0": "Review",
      "4": "Canceled",
      "-1": "Implement"
    }
  }
}

Change-Management – GET /sn_chg_Rest/Change/{Change_sys_ID}/schedule

Ermöglicht das Abrufen der verfügbaren Zeitfenster für eine Change-Anforderung.

Erforderliche Rolle: sn_Change_Writer.

Hinweis:

Beim Ausführen dieses Endpunkts werden die verfügbaren Start- und Endzeiten nicht aufgelistet. Verwenden Sie den im Antworttext bereitgestellten Link worker.linkEigenschaft zum Abrufen der Zeitplandaten.

Siehe auch:

• RUFEN SIE /sn_chg_Rest/Change/ci/{cmdb_ci_sys_ID}/schedule AB
• PATCH /sn_chg_Rest/Change/{Change_sys_ID}/schedule/first_available

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/schedule

Standard-URL: /api/sn_chg_Rest/Change/{Change_sys_ID}/schedule

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 : 55. 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
change_sys_id	SYS_ID der Change-Anforderung, für die das nächste verfügbare Zeitfenster gesucht werden soll. Die ausgewählte Change-Anforderung muss ein Konfigurationselement (cmdb_ci) mit geplanten Start- und Endzeiten aufweisen. Tabelle: Change Request [change_request]

Tabelle : 56. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 57. Anforderungstextparameter (XML oder JSON)

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 : 58. Anforderungskopfzeilen

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

Tabelle : 59. 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 : 60. Statuscodes

Statuscode	Beschreibung
202	Das System hat die Anforderung akzeptiert.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Mögliche Probleme: Für die angegebene Change-Anforderung fehlen die geplanten Start- und Endzeiten. Der angegebenen Change-Anforderung ist kein Konfigurationselement zugeordnet (cmdb_ci). Anwender hat keinen Lesezugriff auf die Felder der Change-Anforderung.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. Mögliche Probleme: Das System kann die Change-Anforderung basierend auf den bereitgestellten Informationen nicht finden. Anwender hat keinen Lesezugriff auf den Datensatz.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt "error": { "detail": "String", "message": "String", "status": "String" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	Meldung, die den Fehler identifiziert. Datentyp: Zeichenfolge
Nachrichten	Nachrichteninformationen. Datentyp: Objekt "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
Nachrichten.FehlerNachrichten	Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Datentyp: Array
messages.infoMessages	Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Datentyp: Array
Nachrichten.WarnungsNachrichten	Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Datentyp: Array
Anforderung	Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge
Status	Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt state: { display_value: "String", value: Number }
status.Display_value	Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueParameter. Mögliche Werte: Abschließen Fehler In Bearbeitung Warten Datentyp: Zeichenfolge
status.Wert	Numerischer Wert des Status des Mitarbeiters. Mögliche Werte: 1 2 3 4 Datentyp: Zahl
type	Typ der Anforderung. Gültiger Wert: Zeitplan Datentyp: Zeichenfolge
Mitarbeiter	Informationen zum zugehörigen Mitarbeiter. Datentyp: Objekt "worker": { "link": "String", "sysId": "String" }
Worker.Link	Link zum Abrufen von Zeitfensterdaten.Verwenden Sie die sys_ID in RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Zum Anzeigen von Ergebnissen. Datentyp: Zeichenfolge
Worker.sysId	SYS_ID des Mitarbeiters, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge
status	Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge

Rufen Sie verfügbare Zeitfenster ab

Verwenden Sie den in angegebenen Wert worker.linkUm Details zum Zeitplanfenster abzurufen. Der Wert hat das folgende Format:

https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>

Verwenden Sie die Worker_sys_ID in RUFEN SIE /sn_chg_Rest/Change/Worker/{Worker_sys_ID} AB Zum Anzeigen von Ergebnissen.

Der Antworttext enthält den Status und liefert Ergebnisse, wenn die Verarbeitung abgeschlossen ist.

Die Ergebnisse des Parameters „Text der Mitarbeiterantwort“ hängen von der Verfügbarkeit des Zeitfensters ab.

• Wenn das angegebene Zeitfenster für die Change-Anforderung innerhalb des Zeitfensters des Zeitplans verfügbar ist, listet die Worker-API die verfügbaren Zeitfenster in auf payload.spans Eigenschaft. Die payload.spans Eigenschaft ist andernfalls nicht in den Ergebnissen aufgeführt.
• Wenn innerhalb des definierten Zeitfensters für die Dauer der Change-Anforderung keine Zeitfenster verfügbar sind, wird die verwendet messages.infoMessages gibt Folgendes an: D
  Hinweis:

  Der Standardwert für das Zeitfenster der Change-Anforderungsplanung ist 90 Tage. Um diesen Wert zu ändern, ändern Sie change.conflict.next_available.schedule_windowEigenschaft. Weitere Informationen finden Sie unter Konfigurieren Sie Konfliktanalyseeigenschaften .

Folgendes RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Das Beispiel zeigt die Ausgabe, die mit der im Worker.Link-Detail angegebenen ID bereitgestellt wird. Die Ergebnisliste zeigt offene Zeitspannen, die für die Aufgabendauer verfügbar sind.

{
  "result": {
    "worker": {
      "sysId": "9b3f62e0a4c87010f87712198fe9cad1",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    },
    "payload": {
      "spans": [
        {
          "start": {
            "value": "2021-05-08 08:00:00",
            "display_value": "2021-05-08 01:00:00"
          },
          "end": {
            "value": "2021-05-08 11:00:00",
            "display_value": "2021-05-08 04:00:00"
          }
        },
        {
          "start": {
            "value": "2021-05-15 08:00:00",
            "display_value": "2021-05-15 01:00:00"
          },
          "end": {
            "value": "2021-05-15 11:00:00",
            "display_value": "2021-05-15 04:00:00"
          }
        },
        ...
      ]
    }
  }
}

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/change/{change_sys_id}/schedule" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Ergebnisse enthalten Worker.Link-Details, die Sie verwenden können, um die angegebene sys_ID im Endpunkt GET /sn_chg_Rest/Change/Worker/ auszuführen.

{
  "result": {
    "worker": {
      "sysId": "9b3f62e0a4c87010f87712198fe9cad1",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

Change-Management – GET /sn_chg_Rest/Change/{Change_sys_ID}/Task

Ruft eine oder mehrere einem angegebenen Change Request zugeordnete Aufgaben ab, basierend auf den angegebenen Kriterien.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/Task

Standard-URL: /api/sn_chg_rest/change/{change_sys_id}/task

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 : 61. 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
change_sys_id	SYS_ID der Change-Anforderung, deren Aufgaben abgerufen werden sollen. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 62. Abfrageparameter

Name	Beschreibung
Schlüssel-Wert-Paare	Felder, die beim Erstellen des Requests zu modifizieren sind. Der Schlüssel ist der Feldname in der Vorlage und der Wert die Informationen, die in das Feld eingefügt werden sollen. Felder, die nicht geändert werden können und bei der Übergabe ignoriert werden: Business-Regeln Schreibgeschützte Felder wie in ACLs definiert Felder, die nicht vorhanden sind Datentyp: Zeichenfolge
Bestellen	Feld, nach dem die zurückgesendeten Change Requests sortiert werden sollen. Datentyp: Zeichenfolge
sysparm_limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Standard: 500
sysparm_offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0
sysparm_query	Codierte Abfrage Wird zum Filtern des Ergebnissatzes verwendet. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>. <col_name>: Name der Tabellenspalte, nach der gefiltert werden soll. <operator>: Unterstützt die folgenden Werte: =: Stimmt genau überein mit <value>. !=: Stimmt nicht überein mit <value>. ^: Logisches UND, mehrfache Abfrageanweisungen. ^OR: Logisches ODER, mehrfache Abfrageanweisungen. LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. STARTSWITH: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. <value>: Wert, mit dem abgeglichen werden soll. Weitere Operatoren finden Sie unter Operators available for filters and queries. Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Beispiel: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> Beispiel: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge
Textsuche	Zeichenfolge, die zum Durchsuchen aller Change-Aufgaben-Datensatzfelder verwendet wird. Diese Suche verwendet ServiceNowVolltextsuche-Plattformfunktionalität und ist standardmäßig auf festgelegt IR_AND_OR_QUERY . Datentyp: Zeichenfolge

Tabelle : 63. Anforderungstextparameter (XML oder JSON)

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 : 64. Anforderungskopfzeilen

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

Tabelle : 65. 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 : 66. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Alle Felder (Schlüssel) mit ihren zugehörigen Werten für die identifizierte Change Request-Aufgabe vor dem Löschen. Datentyp: Objekt
übergeordnet	Informationen für die Change-Anforderung, die der Aufgabe zugeordnet ist. Datentyp: Objekt parent: { display_value: "String", value: "String" }
Parent.Display_value	Change-Anforderungsinformationen, die in einer UI angezeigt werden sollen. Datentyp: Zeichenfolge
Übergeordnetes Element.Wert	SYS_ID der Change-Anforderung, die der Aufgabe zugeordnet ist. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen für die Change-Anforderungsaufgabe. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderungsaufgabe, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderungsaufgabe. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
    result: [
        {
            sys_id: {
                value: "12629ec4b750230096c3e4f6ee11a9d5",
                display_value: "12629ec4b750230096c3e4f6ee11a9d5"
            },
            parent: {
                value: "0f4ac6c4b750230096c3e4f6ee11a9fe ", 
                display_value: "CHG0033046 "
            },
            ..., // all valid fields in record, example below
            short_description: {
                value: "Retire node",
                display_value: "Retire node"
            }
        }, 
        { // next record found }, ... // and so on
    ]
}

Change-Management – GET /sn_chg_Rest/Change/{sys_ID}

Ruft die Change-Anforderung ab, die durch die angegebene sys_ID identifiziert wird

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}

Standard-URL: /api/sn_chg_Rest/Change/{sys_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 : 67. 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
sys_id	SYS_ID des Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 68. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 69. Anforderungstextparameter (XML oder JSON)

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 : 70. Anforderungskopfzeilen

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

Tabelle : 71. 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 : 72. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Elemente	Beschreibung
Ergebnis	Liste, die mindestens ein Change-Anforderungs-Datensatzobjekt enthält. Jedes Objekt beschreibt eine Change-Anforderung. Jedes Element im Change-Anforderungsobjekt entspricht einem Feld im zugehörigen Datensatz in der Tabelle „Change-Anforderung“ [Change_Request]. Alle Elemente enthalten Wert Und Display_value Name-Wert-Paare. Datumsfelder enthalten ebenfalls Display_value_internal Name-Wert-Paare. Datentyp: Array
action_status	Aktueller Aktionsstatus der zugehörigen Change-Anforderung. Mögliche Werte: 1: Intern blockiert 2: Vom Kunden blockiert 3: Intern und vom Kunden blockiert 4: Handlungsbedarf Datentyp: Zahl
aktiv	Kennzeichnung, die angibt, ob die Change-Anforderung aktiv ist. Mögliche Werte: Wahr: Change-Anforderung ist aktiv Falsch: Change-Anforderung ist nicht aktiv Datentyp: Boolesch Standardwert: wahr
Activity_due	Datum und Uhrzeit, für die der zugehörige Fall abgeschlossen sein soll. Datentyp: Zeichenfolge
Zusätzliche_Beauftragte_Liste	Liste der sys_IDs zusätzlicher Personen, die der Arbeit an der Change-Anforderung zugewiesen sind. Datentyp: Array
Genehmigung	Typ des erforderlichen Genehmigungsprozesses. Datentyp: Zeichenfolge Standard: Nicht angefordert
Approval_history	Letzter Journaleintrag des Genehmigungsverlaufs. Datentyp: Zeichenfolge
Approval_Set	Datum und Uhrzeit der Genehmigung der zugehörigen Aktion. Datentyp: Zeichenfolge
assigned_to	SYS_ID des Anwenders, der der Change-Anforderung zugewiesen ist. Datentyp: Zeichenfolge
assignment_group	SYS_ID der Gruppe, die der Change-Anforderung zugewiesen ist. Datentyp: Zeichenfolge
Backout_Plan	Beschreibung des auszuführenden Plans, wenn der Change rückgängig gemacht werden muss. Datentyp: Zeichenfolge
Business_duration	Dauer in geplanten Arbeitsstunden, Arbeitstagen und Arbeitswochen, die zum Abschluss des Change benötigt wurde. Datentyp: Zeichenfolge
business_service	SYS_ID des Business-Service, der der Change-Anforderung zugeordnet ist. Befindet sich in der Tabelle „Service“ [cmdb_ci_Service]. Datentyp: Zeichenfolge
Cab_date	Datum, an dem sich das Change Advisory Board (CAB) trifft. Datentyp: Zeichenfolge
Cab_Delegate	SYS_ID des Anwenders, der den CAB-Manager während eines CAB-Meetings ersetzen kann. Befindet sich in der Anwendertabelle [sys_user] Datentyp: Zeichenfolge
Cab_Recommendation	Beschreibung der CAB-Empfehlungen für die Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000
Cab_required	Kennzeichnung, die angibt, ob das CAB erforderlich ist. Mögliche Werte: Wahr: Change Advisory Board ist erforderlich. Falsch: Change Advisory Board ist nicht erforderlich. Datentyp: Boolesch Standardwert: false
Calendar_duration	Derzeit nicht verwendet von Change-Management. Datentyp: Zeichenfolge
Kategorie	Kategorie des Change, z. B. Hardware, Netzwerk oder Software. Datentyp: Zeichenfolge Standard: Sonstiges
Change_Plan	Aktivitäten und Rollen für die Verwaltung und Steuerung der Change-Anforderung. Datentyp: Zeichenfolge
chg_model	SYS_ID des Change-Modells, auf dem die zugehörige Change-Anforderung basiert. Das Change-Modell definiert den Status-Flow, die Übergänge und die Prozessaktivitäten, die für die Change-Anforderung abgeschlossen werden müssen. Datentyp: Zeichenfolge Tabelle: Change-Modell [chg_model]
Closed_at	Datum und Uhrzeit, zu der die zugehörige Change-Anforderung geschlossen wurde. Datentyp: Zeichenfolge
closed_by	SYS_ID der Person, die die Change-Anforderung geschlossen hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
close_code	Code, der der Change-Anforderung zugewiesen wurde, als sie geschlossen wurde. Beispiel: Erfolgreich, erfolgreich mit Problemen und nicht erfolgreich. Datentyp: Zeichenfolge
close_notes	Merkt an, dass die Person beim Schließen der Change-Anforderung eingegeben hat. Datentyp: Zeichenfolge
cmdb_ci	SYS_ID des Konfigurationselements, das der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Konfigurationselement [cmdb_ci]
Kommentare	Liste der kundenorientierten Arbeitsnotizen, die in die zugehörige Change-Anforderung eingegeben wurden. Datentyp: Array
comments_and_work_notes	Liste der internen und kundenorientierten Arbeitsnotizen, die für die zugehörige Change-Anforderung eingegeben wurden. Datentyp: Array Maximale Länge: 4.000
Unternehmen	SYS_ID des Unternehmens, das der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Unternehmen [Core_Company]
Conflict_Last_Run	Datum und Uhrzeit der letzten Ausführung des Konflikterkennungsskripts für die Change-Anforderung. Datentyp: Zeichenfolge
Conflict_Status	Aktueller Konfliktstatus, wie vom Konflikterkennungsskript erkannt, z. B. Konflikt und nicht Ausführen. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Nicht Ausgeführt
Contact_type	Methode, mit der die Change-Anforderung ursprünglich angefordert wurde. Mögliche Werte: Chat E-Mail Telefon Social Media Web Datentyp: Zeichenfolge
contract	SYS_ID des Vertrags, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Vertrag [ast_contract]
Correlation_Display	Anwenderfreundlicher Name für correlation_id. Datentyp: Zeichenfolge Maximale Länge: 100
correlation_id	Global Unique ID (GUID) eines übereinstimmenden Change Request-Datensatzes in einem Drittparteisystem. Datentyp: Zeichenfolge Maximale Länge: 100
Delivery_Plan	Wird nicht mehr verwendet. SYS_ID des Bereitstellungsplans, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Ausführungsplan [sc_Cat_item_Delivery_Plan]
Delivery_Task	Wird nicht mehr verwendet. SYS_ID der Bereitstellungsaufgabe, die der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Ausführungsplanaufgabe [sc_Cat_item_Delivery_Task]
Beschreibung	Detaillierte Beschreibung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000
due_date	Fälligkeitsdatum der Aufgabe. Wird vom Change-Anforderungsprozess nicht verwendet. Datentyp: Zeichenfolge
end_date	Datum und Uhrzeit, zu der die Change-Anforderung abgeschlossen werden soll. Datentyp: Zeichenfolge
Eskalation	Aktuelle Eskalationsebene. Mögliche Werte: 0: Normal 1: Mittel 2: Hoch 3: Überfällig Datentyp: Zahl (Ganzzahl) Standard: 0
expected_start	Datum und Uhrzeit des Starts der Aufgabe. Wird vom Change-Anforderungsprozess nicht verwendet. Datentyp: Zeichenfolge
Follow_up	Datum und Uhrzeit der Nachverfolgung eines Anwenders mit der Person, die die Change-Anforderung anfordert. Datentyp: Zeichenfolge
Group_list	Liste der sys_IDs und Namen der Gruppen, die der Change-Anforderung zugeordnet sind. Datentyp: Array Maximale Länge: 4.000
impact	Auswirkungen auf die Change-Anforderung auf den Kunden. Mögliche Werte: 1: Hoch 2: Mittel 3: Niedrig Datentyp: Zahl (Ganzzahl) Standard: 3
Implementation_Plan	Sequenzielle Schritte, die zur Implementierung dieses Change ausgeführt werden sollen. Enthält auch alle Abhängigkeiten zwischen Schritten und Details zum Beauftragten für jeden Schritt. Datentyp: Zeichenfolge Maximale Länge: 4.000
Begründung	Vorteile der Implementierung dieses Change und Auswirkungen, wenn dieser Change nicht implementiert wird. Datentyp: Zeichenfolge Maximale Länge: 4.000
Wissen	Kennzeichnung, die angibt, ob der Change-Anforderung Knowledge Base-Artikel ()KB-Artikel zugeordnet sind. Mögliche Werte: Wahr: Zugeordnete KB-Artikel Falsch: Keine zugehörigen KB-Artikel Datentyp: Boolesch
location	SYS_ID und Name des Standorts der Ausrüstung, auf die in der Change-Anforderung verwiesen wird. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location]
Made_sla	Nicht mehr verwendet. Kennzeichnung, die angibt, ob die Change-Anforderung in Übereinstimmung mit der zugehörigen Servicelevel-Vereinbarung implementiert wurde. Datentyp: Boolesch
Needs_Attention	Kennzeichnung, die angibt, ob für die Change-Anforderung Handlungsbedarf besteht. Mögliche Werte: Wahr: Change-Anforderung erfordert zusätzliche Aufmerksamkeit. Falsch: Change-Anforderung erfordert keine zusätzliche Aufmerksamkeit. Datentyp: Boolesch Standardwert: false
Nummer	Change-Nummer, die der Change-Anforderung vom System zugewiesen ist, z. B. CHG0040007. Datentyp: Zeichenfolge
On_Hold	Kennzeichnung, die angibt, ob die Change-Anforderung derzeit angehalten ist. Mögliche Werte: Wahr: Angehalten Falsch: Nicht angehalten Datentyp: Boolesch Standardwert: false
On_hold_reason	Wenn on_holdParameter ist „wahr“, Beschreibung des Grunds, warum die Change-Anforderung aufgehalten wird. Datentyp: Zeichenfolge Maximale Länge: 4.000
On_hold_Task	Wenn on_holdParameter ist „wahr“, Liste der sys_IDs der Aufgaben, die abgeschlossen werden müssen, bevor die Sperre freigegeben wird. Datentyp: Zeichenfolge Maximale Länge: 4.000
Geöffnet_um	Datum und Uhrzeit der Erstellung des Change-Release. Datentyp: Zeichenfolge
opened_by	SYS_ID und Name des Anwenders, der das Change-Release erstellt hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Bestellen	Nicht verwendet von Change-Management. Optionales numerisches Feld, nach dem Datensätze sortiert werden sollen, z. B. beim Abrufen aus einer Datenbank. Datentyp: Zahl (Ganzzahl)
Outside_Maintenance_schedule	Kennzeichnung, die angibt, ob die Wartung durch ein externes Unternehmen für die Change-Anforderung geplant wurde. Mögliche Werte: Wahr: Externe Wartung geplant Falsch: Keine externe Wartung geplant Datentyp: Boolesch Standardwert: false
übergeordnet	SYS_ID und Name der übergeordneten Aufgabe für diese Change-Anforderung, falls vorhanden. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe]
Phase	Aktuelle Phase der Change-Anforderung. Dies definiert detaillierter, was der Change bewirkt. Mögliche Werte: akzeptieren Build plan Angefordert Datentyp: Zeichenfolge
Phase_Status	Change_Phase-Datensätze, die für einen Change erstellt werden sollen. Sie sind von der Kategorie abhängig, sodass jeder Change-Typ verschiedene Change_Phase-Datensätze haben kann. Die Change_Phase-Datensätze bieten eine Möglichkeit, den Genehmigungsprozess zu steuern, da jede Change_Phase einen Zeitplan und eine Reihe von Genehmigern haben kann. Mögliche Werte: Abschließen Angehalten offen abgelehnt Angefordert In Bearbeitung Datentyp: Zeichenfolge
Priorität	Priorität der Change-Anforderung. Mögliche Werte: 1: Kritisch 2: Hoch 3: Mittel 4: Niedrig Datentyp: Zahl (Ganzzahl) Standard: 4
Production_System	Kennzeichnung, die angibt, ob die Change-Anforderung für gilt ServiceNow Instanz, die sich in einer Produktionsumgebung befindet. Mögliche Werte: Wahr: Produktionsumgebung Falsch: Nicht-Produktionsumgebung Datentyp: Boolesch
Grund	Beschreibung, warum die Change-Anforderung initiiert wurde. Mögliche Werte: Geschäftsanforderungen Hardware-Upgrade Gesetzgebung Standortänderung Netzwerkanforderungen Neues oder entferntes CI Sonstige Problem gelöst Produkt oder Service geändert Software-Upgrade Anwender angefordert Datentyp: Zeichenfolge Maximale Länge: 40
Reassignment_count	Anzahl der Neuzuweisungen der Change-Anforderung an einen neuen Besitzer. Datentyp: Zahl (Ganzzahl) Standard: 0
Rejection_Goto	SYS_ID der Aufgabe, die ausgeführt werden soll, wenn die Change-Anforderung abgelehnt wird. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe]
Angefordert_von	SYS_ID des Anwenders, der den Change angefordert hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Request_by_date	Datum und Uhrzeit, zu der die Implementierung des Change angefordert wird. Datentyp: Zeichenfolge
Review_comments	Kommentare, die bei der Überprüfung der Change-Anforderung eingegeben wurden. Datentyp: Zeichenfolge Maximale Länge: 4.000
Review_date	Datum, an dem die Change-Anforderung überprüft wurde. Datentyp: Zeichenfolge
Review_Status	Aktueller Status der angeforderten Überprüfung der Change-Anforderung. Datentyp: Zeichenfolge
Risiko	Risikostufe, die der Change-Anforderung zugeordnet ist. Gültige Werte: 1: Hoch 2: Mittel 3: Niedrig Datentyp: Zahl Standard: 3
Risk_Impact_Analysis	Beschreibung des Risikos und Analyse der Implementierung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000
Route_reason	Derzeit nicht verwendet von Change-Management. Grund, warum die Change-Anforderung übertragen wurde. Mögliche Werte: 1: Übertragung mit Lösung 9: Übertragung ohne Lösungen Datentyp: Zahl
scope	Größe der Change-Anforderung. Mögliche Werte: 1: Massiv 2: Groß 3: Mittel 4: Klein 5: Winzig Datentyp: Zahl Standard: 3
Service.Offering	SYS_ID des Serviceangebots, das der Change-Anforderung zugeordnet ist. Serviceangebote definieren das Servicelevel in Bezug auf Verfügbarkeit, Umfang, Preise und Verpackungsoptionen eindeutig. Datentyp: Zeichenfolge Tabelle: Angebot [Service_offering]
short_description	Beschreibung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 40
Kompetenzen	Liste der sys_IDs aller Kompetenzen, die zum Implementieren der Change-Anforderung erforderlich sind. Datentyp: Array Tabelle: Kompetenz [cmn_Skill]
sla_due	Wird nicht mehr verwendet. Datum und Uhrzeit, zu der die Change-Anforderung basierend auf der zugehörigen Servicelevel-Vereinbarung abgeschlossen werden muss. Datentyp: Zeichenfolge
sn_esign_document	SYS_ID eines E-signierten Dokuments, das an die Change-Anforderung angehängt ist. Datentyp: Zeichenfolge Tabelle: Anhang [sys_attachment]
sn_esign_esignature_Configuration	SYS_ID der E-Signatur-Vorlage, die für das zugehörige Dokument verwendet wird. Datentyp: Zeichenfolge Tabelle: E-Signatur-Vorlage [sn_esign_Configuration]
start_date	Datum und Uhrzeit, zu der die Implementierung der Change-Anforderung beginnen soll. Datentyp: Zeichenfolge
Status	Aktueller Status des Change Requests. Mögliche Werte sind im Change-Modell definiert. Datentyp: Zahl (Ganzzahl) Standard: 1
std_Change_Producer_Version	SYS_ID des Datensatzerstellers und des Change-Vorschlags, die der Change-Anforderung zugeordnet sind. Enthält auch die Anzahl und den Prozentsatz erfolgreicher und nicht erfolgreicher Change-Anforderungen, die aus dem Vorschlag erstellt wurden. Datentyp: Zeichenfolge Tabelle: Standard-Change-Vorlagenversion [Std_Change_Producer_Version]
sys_class_name	Name der Tabelle, in der sich die Change-Anforderung befindet. Datentyp: Zeichenfolge
sys_created_by	Name des Anwenders, der die Change-Anforderung ursprünglich erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40
sys_created_on	Datum und Uhrzeit der ursprünglichen Erstellung des zugehörigen Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge
sys_domain	Wenn Domänen in der Instanz verwendet werden, der Name der Domäne, der der Change-Modul-Datensatz zugeordnet ist. Datentyp: Zeichenfolge
sys_domain_path	Bei Verwendung von Domänen in der Instanz der Domänenpfad, in dem sich der zugeordnete Change-Modul-Datensatz befindet. Datentyp: Zeichenfolge
sys_id	Eindeutiger Bezeichner des zugehörigen Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge
sys_mod_count	Anzahl der Updates für den Fall seit der ersten Erstellung. Datentyp: Zahl (Ganzzahl)
sys_updated_by	Person, die den Fall zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Falls. Datentyp: Zeichenfolge
Task_Effective_number	Universal-Anforderungsnummer. Datentyp: Zeichenfolge Maximale Länge: 40
Aufgabe_für	Nicht verwendet von Change-Management. SYS_ID des Anwenders, für den die Aufgabe erstellt wurde. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user]
Test_Plan	Beschreibung des zugehörigen Testplans für den Change. Datentyp: Zeichenfolge Maximale Länge: 4.000
Time_worked	Gesamtzeit, die an der Change-Anforderung gearbeitet wurde. Datentyp: Zeichenfolge
type	Change-Anforderungstyp. Mögliche Werte: Notfall Normal Standard Datentyp: Zeichenfolge Maximale Länge: 40
Nicht autorisiert	Kennzeichnung, die angibt, ob die Change-Anforderung nicht autorisiert ist Mögliche Werte: Wahr: Nicht autorisiert Falsch: Autorisiert Datentyp: Boolesch
universal_request	SYS_ID der übergeordneten Universal-Anforderung, zu der diese Change-Anforderung gehört. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe]
On_Approval	Aktion, die ausgeführt werden soll, wenn die Change-Anforderung genehmigt wird. Mögliche Werte: Do_no Fahren Sie fort Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fortfahren
Bei_ablehnen	Aktion, die ausgeführt werden soll, wenn die Change-Anforderung abgelehnt wird. Mögliche Werte: abbrechen goto Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Abbrechen
urgency	Dringlichkeit der Change-Anforderung. Mögliche Werte: 1: Hoch 2: Mittel 3: Niedrig Datentyp: Zahl (Ganzzahl) Standard: 3
Anwender_Eingabe	Zusätzliche Anwendereingabe. Datentyp: Zeichenfolge Maximale Länge: 4.000
Variablen	Name-Wert-Paare von Variablen, die der Change-Anforderung zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40
Watch_list	Liste der sys_IDs der Anwender, die Benachrichtigungen zu dieser Change-Anforderung erhalten, wenn zusätzliche Kommentare hinzugefügt werden oder wenn der Status einer Change-Anforderung in „gelöst“ oder „Geschlossen“ geändert wird. Datentyp: Array Tabelle: Benutzer [sys_user]
wf_activity	SYS_ID des Workflow-Aktivitätsdatensatzes, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Workflow-Aktivität [wf_activity]
Work_End	Datum und Uhrzeit des Beendens der Arbeit an der Change-Anforderung. Datentyp: Zeichenfolge
work_notes	Informationen darüber, wie die Change-Anforderung gelöst wird, oder Schritte, die zu ihrer Lösung unternommen wurden. Datentyp: Zeichenfolge Maximale Länge: 4.000
Work_Notes_list	Liste der sys_IDs der internen Anwender, die Benachrichtigungen zu dieser Change-Anforderung erhalten, wenn Arbeitsnotizen hinzugefügt werden. Datentyp: Array Tabelle: Benutzer [sys_user]
Work_Start	Datum und Uhrzeit des Beginns der Arbeit an der Change-Anforderung. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result":
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Clear BGP sessions on a Cisco router",
        "value": "Clear BGP sessions on a Cisco router"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "1766f1de47410200e90d87e8dee490f6",
        "value": "1766f1de47410200e90d87e8dee490f6"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
}

Change-Management – GET /sn_chg_Rest/Change/{sys_ID}/ci

Ruft mehrere Konfigurationselemente (Configuration Items, CIs) ab, die einer angegebenen Change-Anforderung zugeordnet sind, basierend auf dem angegebenen Zuordnungstyp.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/ci

Standard-URL: /api/sn_chg_Rest/Change/{sys_ID}/ci

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 : 73. 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
sys_id	SYS_ID der Change-Anforderung, für die die zugehörigen CMDB-CIs zurückgegeben werden sollen. Datentyp: Zeichenfolge

Tabelle : 74. Abfrageparameter

Name	Beschreibung
association_type	Erforderlich. Typ der Zuordnung zwischen dem CMDB-CI und der Change-Anforderung. Gültige Werte: Betroffen: CIs, die von der Change-Anforderung betroffen sind Betroffen: Services, die von der Change-Anforderung betroffen sind Angebot: Betroffene Serviceangebote Datentyp: Zeichenfolge
Name-Wert-Paare	Name-Wert-Paare zum Filtern des Ergebnissatzes. Der Name ist das Feld, in dem der angegebene Wert gefiltert wird. Dieser Parameter und sysparm_query schließen sich gegenseitig aus. Beispielweise können Sie anstelle der Verwendung von &sysparm_query=active=true die aufrufende Anweisung mithilfe von &active=true vereinfachen. Sie können auch den Anzeigewert verwenden, wenn das Feld ein Auswahl- oder ein Referenztypfeld ist, z. B. &state=closed anstatt &state=7. Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie sie jeweils mit einem kaufmännischen Und-Zeichen, z. B. &active=true&assigned_to=john.smith. Datentyp: Zeichenfolge
sysparm_limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Standard: 500
sysparm_offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0
sysparm_query	Codierte Abfrage Wird zum Filtern des Ergebnissatzes verwendet. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>. <col_name>: Name der Tabellenspalte, nach der gefiltert werden soll. <operator>: Unterstützt die folgenden Werte: =: Stimmt genau überein mit <value>. !=: Stimmt nicht überein mit <value>. ^: Logisches UND, mehrfache Abfrageanweisungen. ^OR: Logisches ODER, mehrfache Abfrageanweisungen. LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. STARTSWITH: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. <value>: Wert, mit dem abgeglichen werden soll. Weitere Operatoren finden Sie unter Operators available for filters and queries. Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Beispiel: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> Beispiel: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge

Tabelle : 75. Anforderungstextparameter (XML oder JSON)

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 : 76. Anforderungskopfzeilen

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

Tabelle : 77. 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 : 78. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Die Fehlerantwort enthält relevante Nachrichten, die bei der Behebung des Problems helfen.
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.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
ci_item|cmdb_ci_Service	Entweder die Variablen „ci_item“ oder „cmdb_ci_Service“, je nach Zuordnungstyp. Datentyp: Array ci_item|cmdb_ci_service : { display_value: "String", value: "String" }
ci_item|cmdb_ci_Service.value	SYS_ID des ci_item oder cmdb_ci_Service. Datentyp: Zeichenfolge
ci_item|cmdb_ci_Service.Display_value	Anzeigewert von ci_item oder cmdb_ci_Service. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen der Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
<record_fields>	Alle gültigen Felder im Datensatz „ci_item“ oder „cmdb_ci_Service“; Tabelle basierend auf dem Zuordnungstyp. Datentyp: Objekt

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci?association_type=affected" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

{
  result: [
    {
      sys_id: {
        value: "92b8544047810200e90d87e8dee490b0",
        display_value: "92b8544047810200e90d87e8dee490b0"
      },
      ci_item|cmdb_ci_service : {
        value: "3a27d4370a0a0bb4006316812bf45439", 
        display_value: "PS Apache01"
      },
      ..., // all valid fields in record, table based on association type
    }, 
    { // next record found }, ... // and so on
  ]
}

Change-Management – GET /sn_chg_Rest/Change/{sys_ID}/conflict

Ruft den Status des aktuell laufenden Change Request-Konflikt-Überprüfungsprozesses oder die Ergebnisse des letzten abgeschlossenen Konflikt-Überprüfungsprozesses für den angegebenen Change Request ab.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/Konflikt

Standard-URL: /api/sn_chg_rest/change/{sys_id}/conflict

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 : 79. 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
sys_id	SYS_ID der Change-Anforderung, für die der Status des laufenden/abgeschlossenen Konfliktprüfungsprozesses zurückgegeben werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 80. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 81. Anforderungstextparameter (XML oder JSON)

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 : 82. Anforderungskopfzeilen

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

Tabelle : 83. 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 : 84. Statuscodes

Statuscode	Beschreibung
200	Aktueller Status des Konflikt-Überprüfungsprozesses; einschließlich Konflikte, wenn welche entdeckt werden.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Konflikte	Liste der gefundenen Konflikte für den Change Request. Ein leeres Objekt gibt an, dass keine Konflikte erkannt wurden. Datentyp: Array
Job_Status	Status des aktuellen Konflikt-Überprüfungsjobs. Datentyp: Zeichenfolge
last_run	Datum und Uhrzeit des Beginns des letzten Konflikt-Überprüfungsprozesses. Datentyp: Zeichenfolge
record_count	Anzahl der geprüften Datensätze. Datentyp: Zeichenfolge
status	Ergebnis des Konflikt-Überprüfungsprozesses, wie zum Beispiel „Konflikt“ oder „Nicht ausgeführt“. Hinweis: Auch wenn die Change-Anforderung keine Konflikte aufweist, wird dieses Feld auf „Konflikt“ festgelegt. Jedoch ist conflictsObjekt ist leer. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Erfolgreiche Antwort – keine Konflikte

{
  result: {
    status: "Conflict",
    last_run": "2018-08-30 12:58:05",
    record_count: "1",
    job_status: "2",
    conflicts: []
  }
}

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Erfolgreiche Antwort – mit Konflikten

{
  result: {
    status: "Conflict",
    last_run": "2018-08-30 12:58:05",
    record_count: "1",
    job_status: "2",
    conflicts: [
      {
        change: {
          display_value: "CHG0030001",
          value: "afbffb24b758230096c3e4f6ee11a972"
        },
        type: {
          display_value: "Not In Maintenance Window",
          value: "not_in_maintenance_window"
        }
        ..., // all valid fields in record, example below
      }
    ]
  }
}

Change-Management – GET /sn_chg_Rest/Change/Emergency

Ruft einen oder mehrere Notfall-Change Requests basierend auf den angegebenen Kriterien ab.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Emergency

Standard-URL: /api/sn_chg_rest/change/emergency

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 : 85. 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

Tabelle : 86. Abfrageparameter

Name	Beschreibung
Bestellen	Feld, nach dem die zurückgesendeten Change Requests sortiert werden sollen. Datentyp: Zeichenfolge Standard: Nummer
sysparm_limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Standard: 500
sysparm_offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0
sysparm_query	Codierte Abfrage Wird zum Filtern des Ergebnissatzes verwendet. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>. <col_name>: Name der Tabellenspalte, nach der gefiltert werden soll. <operator>: Unterstützt die folgenden Werte: =: Stimmt genau überein mit <value>. !=: Stimmt nicht überein mit <value>. ^: Logisches UND, mehrfache Abfrageanweisungen. ^OR: Logisches ODER, mehrfache Abfrageanweisungen. LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. STARTSWITH: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. <value>: Wert, mit dem abgeglichen werden soll. Weitere Operatoren finden Sie unter Operators available for filters and queries. Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Beispiel: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> Beispiel: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge
Schlüssel-Wert-Paare	Name-Wert-Paare zum Filtern des Ergebnissatzes. Der Name ist das Feld, in dem der angegebene Wert gefiltert wird. Dieser Parameter und sysparm_query schließen sich gegenseitig aus. Beispielweise können Sie anstelle der Verwendung von &sysparm_query=active=true die aufrufende Anweisung mithilfe von &active=true vereinfachen. Sie können auch den Anzeigewert verwenden, wenn das Feld ein Auswahl- oder ein Referenztypfeld ist, z. B. &state=closed anstatt &state=7. Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie sie jeweils mit einem kaufmännischen Und-Zeichen, z. B. &active=true&assigned_to=john.smith. Datentyp: Zeichenfolge
Textsuche	Zeichenfolge, die zum Durchsuchen aller Notfall-Change Request-Datensatzfelder verwendet wird. Diese Suche verwendet ServiceNow Volltextsuche-Plattformfunktionalität und ist standardmäßig auf festgelegt IR_AND_OR_QUERY . Datentyp: Zeichenfolge

Tabelle : 87. Anforderungstextparameter (XML oder JSON)

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 : 88. Anforderungskopfzeilen

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

Tabelle : 89. 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 : 90. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Werte für alle Felder im zugehörigen Change Request. Datentyp: Objekt
Status	Status der Change-Anforderung. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      },
    }, 
    { // next record found }, ... // and so on
  ]
}

Change-Management – GET /sn_chg_Rest/Change/Emergency/{sys_ID}

Ruft den Notfall-Change Request ab, der von der angegebenen sys_id identifiziert wird.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Emergency/{sys_ID}

Standard-URL: /api/sn_chg_rest/change/emergency/{sys_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 : 91. 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
sys_id	SYS_ID der abzurufenden Notfall-Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 92. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 93. Anforderungstextparameter (XML oder JSON)

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 : 94. Anforderungskopfzeilen

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

Tabelle : 95. 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 : 96. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Werte für alle Felder im zugehörigen Change Request. Datentyp: Objekt
Status	Status der Change-Anforderung. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "b0dbda5347c12200e0ef563dbb9a718f", 
        display_value: "b0dbda5347c12200e0ef563dbb9a718f"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      },
    },
  ]
}

Change-Management – GET /sn_chg_Rest/Change/model

Ruft ein oder mehrere Change-Modelle basierend auf den angegebenen Kriterien ab.

Verwenden Sie diesen Endpunkt, um ein Change-Modell zu finden, das am besten zu der Change-Anforderung passt, die Sie erstellen möchten. Weitere Informationen finden Sie unter Change-Modelle .

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/model

Standard-URL: /api/sn_chg_Rest/Change/model

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 : 97. 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

Tabelle : 98. Abfrageparameter

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare zum Filtern des Ergebnissatzes. Der Name ist das Feld, in dem der angegebene Wert gefiltert wird. Dieser Parameter und sysparm_query schließen sich gegenseitig aus. Beispielweise können Sie anstelle der Verwendung von &sysparm_query=active=true die aufrufende Anweisung mithilfe von &active=true vereinfachen. Sie können auch den Anzeigewert verwenden, wenn das Feld ein Auswahl- oder ein Referenztypfeld ist, z. B. &state=closed anstatt &state=7. Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie sie jeweils mit einem kaufmännischen Und-Zeichen, z. B. &active=true&assigned_to=john.smith. Datentyp: Zeichenfolge
Bestellen	Feld, nach dem die zurückgegebenen Change-Modelle sortiert werden sollen. Datentyp: Zeichenfolge Standard: Name
sysparm_offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0
sysparm_query	Codierte Abfrage Wird zum Filtern des Ergebnissatzes verwendet. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>. <col_name>: Name der Tabellenspalte, nach der gefiltert werden soll. <operator>: Unterstützt die folgenden Werte: =: Stimmt genau überein mit <value>. !=: Stimmt nicht überein mit <value>. ^: Logisches UND, mehrfache Abfrageanweisungen. ^OR: Logisches ODER, mehrfache Abfrageanweisungen. LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. STARTSWITH: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. <value>: Wert, mit dem abgeglichen werden soll. Weitere Operatoren finden Sie unter Operators available for filters and queries. Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Beispiel: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> Beispiel: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge
Textsuche	Zeichenfolge, die zum Durchsuchen aller Change-Modell-Datensatzfelder verwendet werden soll. Diese Suche verwendet ServiceNow Funktionalität der Volltextsuchplattform. Weitere Informationen zu finden ServiceNow Suchfunktionen, siehe Durchsuchen Sie die Administration . Datentyp: Zeichenfolge Standard: IR_AND_OR_QUERY

Tabelle : 99. Anforderungstextparameter (XML oder JSON)

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 : 100. Anforderungskopfzeilen

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

Tabelle : 101. 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 : 102. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Ergebnis	Liste, die mindestens ein Change-Modell-Datensatzobjekt enthält. Jedes Objekt beschreibt ein Change-Modell. Jedes Element im Change-Modell-Objekt entspricht einem Feld im zugehörigen Datensatz in der Tabelle „Change-Modell“ [chg_model]. Alle Elemente enthalten Wert Und Display_value Name-Wert-Paare. Einige enthalten Display_value_internal Name-Wert-Paare. Datentyp: Array
Ergebnis.aktiv	Kennzeichnung, die angibt, ob der zugehörige Change-Modell-Datensatz aktiv und in der Instanz verfügbar ist. Gültige Werte: Wahr: Change-Modell ist aktiv. Falsch: Change-Modell ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
Ergebnis.available_in_ui	Kennzeichnung, die angibt, ob der zugehörige Change-Modell-Datensatz in der Anwenderoberfläche verfügbar ist. Gültige Werte: Wahr: Das Change-Modell ist in der Anwenderoberfläche verfügbar. Falsch: Change-Modell ist in der Anwenderoberfläche nicht verfügbar. Datentyp: Boolesch Standardwert: wahr
Ergebnis.Farbe	Farbe des zugehörigen Change-Modells auf der Change-Anforderungs-Zielseite. Datentyp: Zeichenfolge Standard: #Cbcbcb
result.default_change_model	Kennzeichnung, die angibt, ob der zugeordnete Change-Modell-Datensatz das Standard-Change-Modell ist. Gültige Werte: Wahr: Standard Falsch: Nicht der Standard Datentyp: Boolesch Standardwert: false
result.description	Kurze Beschreibung des Zwecks des Change-Modells. Datentyp: Zeichenfolge Maximale Länge: 4.000
result.name	Name des Change-Modells. Datentyp: Zeichenfolge Maximale Länge: 200
Ergebnis.Datensatz_Voreinstellung	Name-Wert-Paare der Felder, die automatisch mit den zugehörigen Werten ausgefüllt werden sollen, wenn ein neuer Change-Anforderungsdatensatz erstellt wird. Werte werden durch Caret-Symbole getrennt. Zum Beispiel: „Type=normal^assignment_Group=a715cd759f2002920bde8132e7018^short_description=Automated: Change^EQ“ Datentyp: Zeichenfolge
Ergebnis.Status_Feld	Auswahllistenfeld, aus dem Auswahlmöglichkeiten gesammelt werden sollen, basierend auf dem in angegebenen table_name. Bei Change-Modellen ist dies immer auf „Status“ festgelegt. Datentyp: Zeichenfolge
Ergebnis.sys_class_Name	Ändern Sie den Modultabellennamen. Modell/chg_model immer ändern. Datentyp: Zeichenfolge
Ergebnis.sys_created_by	Name des Anwenders, der den zugehörigen Change-Modul-Datensatz ursprünglich erstellt hat. Datentyp: Zeichenfolge
Ergebnis.sys_created_on	Datum und Uhrzeit der ursprünglichen Erstellung des Change-Moduldatensatzes. Datentyp: Zeichenfolge
Ergebnis.sys_Domain	Wenn Domänen in der Instanz verwendet werden, der Name der Domäne, der der Change-Modul-Datensatz zugeordnet ist. Datentyp: Zeichenfolge
Ergebnis.sys_Domain_path	Bei Verwendung von Domänen in der Instanz der Domänenpfad, in dem sich der zugeordnete Change-Modul-Datensatz befindet. Datentyp: Zeichenfolge
Ergebnis.sys_ID	Eindeutiger Bezeichner des zugehörigen Change-Modell-Datensatzes. Datentyp: Zeichenfolge
Ergebnis.sys_mod_count	Gibt an, wie oft der zugehörige Change-Modell-Datensatz geändert wurde. Datentyp: Zahl
Ergebnis.sys_Name	Name des Change-Modells. Immer identisch mit nameParameter. Datentyp: Zeichenfolge
Ergebnis.sys_Tags	System-Tags, die dem Change-Modell-Datensatz zugeordnet sind. Datentyp: Zeichenfolge
Ergebnis.sys_updated_by	Name des Anwenders, der den zugehörigen Change-Modell-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40
Ergebnis.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des zugehörigen Change-Modelldatensatzes. Datentyp: Zeichenfolge
Ergebnis.Tabellenname	Tabelle, die das Auswahllistenfeld definiert, aus dem Auswahlmöglichkeiten erfasst werden sollen. Für Change-Modelle ist dies immer auf „Change_Request“ festgelegt. Datentyp: Zeichenfolge Maximale Länge: 80

cURL-Anforderung

Dieses Beispiel zeigt eine Anforderung zum Abrufen aller Change-Modell-Datensätze.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Aus Kürze zeigt diese Antwort nur ein einzelnes Change-Modellobjekt an.

{
  "result": [
    {
      "record_preset": {
        "display_value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ",
        "value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ"
      },
      "color": {
        "display_value": "#488df4",
        "value": "#488df4"
      },
      "default_change_model": {
        "display_value": "false",
        "value": false
      },
      "sys_mod_count": {
        "display_value": "6",
        "value": 6.0
      },
      "description": {
        "display_value": "This model is intended to capture  a record of an automated change.  There are no approvals associated with this change model.\r\n",
        "value": "This model is intended to capture  a record of an automated change.  There are no approvals associated with this change model.\r\n"
      },
      "active": {
        "display_value": "true",
        "value": true
      },
      "sys_updated_on": {
        "display_value": "2020-10-02 06:24:24",
        "value": "2020-10-02 13:24:24",
        "display_value_internal": "2020-10-02 06:24:24"
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
        "table_name": {
        "display_value": "change_request",
        "value": "change_request"
      },
      "sys_class_name": {
        "display_value": "Change Model",
        "value": "chg_model"
      },
      "sys_id": {
        "display_value": "7840d2515323101034d1ddeeff7b12a6",
        "value": "7840d2515323101034d1ddeeff7b12a6"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "available_in_ui": {
        "display_value": "false",
        "value": false
      },
      "state_field": {
        "display_value": "state",
        "value": "state"
      },
      "sys_created_on": {
        "display_value": "2020-09-28 07:33:25",
        "value": "2020-09-28 14:33:25",
        "display_value_internal": "2020-09-28 07:33:25"
      },
      "name": {
        "display_value": "Change Registration",
        "value": "Change Registration"
      },
      "sys_name": {
        "display_value": "Change Registration",
        "value": "Change Registration"
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      }
    }
  ]
}

Change-Management – GET /sn_chg_Rest/Change/model/{sys_ID}

Ruft das durch die angegebene sys_ID identifizierte Change-Modell ab

Sie können dann dieses Change-Modell verwenden, um die gewünschte Change-Anforderung zu erstellen. Weitere Informationen zu Change-Modellen finden Sie unter Change-Modelle .

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/model/{sys_ID}

Standard-URL: /api/sn_chg_Rest/Change/model/{sys_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 : 103. 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
sys_id	SYS_ID des Change-Modelldatensatzes, der aus der Tabelle „Change-Modell“ [chg_model] abgerufen werden soll. Datentyp: Zeichenfolge

Tabelle : 104. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 105. Anforderungstextparameter (XML oder JSON)

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 : 106. Anforderungskopfzeilen

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

Tabelle : 107. 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 : 108. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Ergebnis	Datensatzobjekt des angeforderten Change-Modells. Jedes Element in diesem Objekt entspricht einem Feld im Datensatz in der Tabelle „Change-Modell“ [chg_model]. Alle Elemente enthalten valueUnd display_valueName-Wert-Paare. Einige enthalten display_value_internalName-Wert-Paare. Datentyp: Objekt
Ergebnis.aktiv	Kennzeichnung, die angibt, ob der zugehörige Change-Modell-Datensatz aktiv und in der Instanz verfügbar ist. Gültige Werte: Wahr: Change-Modell ist aktiv. Falsch: Change-Modell ist nicht aktiv. Datentyp: Boolesch Standardwert: wahr
Ergebnis.available_in_ui	Kennzeichnung, die angibt, ob der zugehörige Change-Modell-Datensatz in der Anwenderoberfläche verfügbar ist. Gültige Werte: Wahr: Das Change-Modell ist in der Anwenderoberfläche verfügbar. Falsch: Change-Modell ist in der Anwenderoberfläche nicht verfügbar. Datentyp: Boolesch Standardwert: wahr
Ergebnis.Farbe	Farbe des zugehörigen Change-Modells auf der Change-Anforderungs-Zielseite. Datentyp: Zeichenfolge Standard: #Cbcbcb
result.default_change_model	Kennzeichnung, die angibt, ob der zugeordnete Change-Modell-Datensatz das Standard-Change-Modell ist. Gültige Werte: Wahr: Standard Falsch: Nicht der Standard Datentyp: Boolesch Standardwert: false
result.description	Kurze Beschreibung des Zwecks des Change-Modells. Datentyp: Zeichenfolge Maximale Länge: 4.000
result.name	Name des Change-Modells. Datentyp: Zeichenfolge Maximale Länge: 200
Ergebnis.Datensatz_Voreinstellung	Name-Wert-Paare der Felder, die automatisch mit den zugehörigen Werten ausgefüllt werden sollen, wenn ein neuer Change-Anforderungsdatensatz erstellt wird. Werte werden durch Caret-Symbole getrennt. Zum Beispiel: „Type=normal^assignment_Group=a715cd759f2002920bde8132e7018^short_description=Automated: Change^EQ“ Datentyp: Zeichenfolge
Ergebnis.Status_Feld	Auswahllistenfeld, aus dem Auswahlmöglichkeiten gesammelt werden sollen, basierend auf dem in angegebenen table_name. Bei Change-Modellen ist dies immer auf „Status“ festgelegt. Datentyp: Zeichenfolge
Ergebnis.sys_class_Name	Ändern Sie den Modultabellennamen. Modell/chg_model immer ändern. Datentyp: Zeichenfolge
Ergebnis.sys_created_by	Name des Anwenders, der den zugehörigen Change-Modul-Datensatz ursprünglich erstellt hat. Datentyp: Zeichenfolge
Ergebnis.sys_created_on	Datum und Uhrzeit der ursprünglichen Erstellung des Change-Moduldatensatzes. Datentyp: Zeichenfolge
Ergebnis.sys_Domain	Wenn Domänen in der Instanz verwendet werden, der Name der Domäne, der der Change-Modul-Datensatz zugeordnet ist. Datentyp: Zeichenfolge
Ergebnis.sys_Domain_path	Bei Verwendung von Domänen in der Instanz der Domänenpfad, in dem sich der zugeordnete Change-Modul-Datensatz befindet. Datentyp: Zeichenfolge
Ergebnis.sys_ID	Eindeutiger Bezeichner des zugehörigen Change-Modell-Datensatzes. Datentyp: Zeichenfolge
Ergebnis.sys_mod_count	Gibt an, wie oft der zugehörige Change-Modell-Datensatz geändert wurde. Datentyp: Zahl
Ergebnis.sys_Name	Name des Change-Modells. Immer identisch mit nameParameter. Datentyp: Zeichenfolge
Ergebnis.sys_Tags	System-Tags, die dem Change-Modell-Datensatz zugeordnet sind. Datentyp: Zeichenfolge
Ergebnis.sys_updated_by	Name des Anwenders, der den zugehörigen Change-Modell-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40
Ergebnis.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des zugehörigen Change-Modelldatensatzes. Datentyp: Zeichenfolge
Ergebnis.Tabellenname	Tabelle, die das Auswahllistenfeld definiert, aus dem Auswahlmöglichkeiten erfasst werden sollen. Für Change-Modelle ist dies immer auf „Change_Request“ festgelegt. Datentyp: Zeichenfolge Maximale Länge: 80

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model/c0efda5347c12200e0ef563dbb9a81e3" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "record_preset": {
      "display_value": "type=emergency^EQ",
      "value": "type=emergency^EQ"
    },
    "color": {
      "display_value": "#ea3423",
      "value": "#ea3423"
    },
    "default_change_model": {
      "display_value": "false",
      "value": false
    },
    "sys_mod_count": {
      "display_value": "2",
      "value": 2.0
    },
    "description": {
      "display_value": "ITIL Mode 1 Emergency Change",
      "value": "ITIL Mode 1 Emergency Change"
    },
    "active": {
      "display_value": "true",
      "value": true
    },
    "sys_updated_on": {
      "display_value": "2020-09-28 08:53:12",
      "value": "2020-09-28 15:53:12",
      "display_value_internal": "2020-09-28 08:53:12"
    },
    "sys_tags": {
      "display_value": "",
      "value": ""
    },
    "table_name": {
      "display_value": "change_request",
      "value": "change_request"
    },
    "sys_class_name": {
      "display_value": "Change Model",
      "value": "chg_model"
    },
    "sys_id": {
      "display_value": "c0efda5347c12200e0ef563dbb9a81e3",
      "value": "c0efda5347c12200e0ef563dbb9a81e3"
    },
    "sys_updated_by": {
      "display_value": "admin",
      "value": "admin"
    },
    "available_in_ui": {
      "display_value": "true",
      "value": true
    },
    "state_field": {
      "display_value": "state",
      "value": "state"
    },
    "sys_created_on": {
      "display_value": "2020-09-04 09:16:03",
      "value": "2020-09-04 16:16:03",
      "display_value_internal": "2020-09-04 09:16:03"
    },
    "name": {
      "display_value": "Emergency",
      "value": "Emergency"
    },
    "sys_name": {
      "display_value": "Emergency",
      "value": "Emergency"
    },
    "sys_created_by": {
      "display_value": "admin",
      "value": "admin"
    }
  }
}

Change-Management – GET /sn_chg_Rest/Change/normal

Ruft eine oder mehrere normale Change-Anforderungen basierend auf den angegebenen Kriterien ab.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/normal

Standard-URL: /api/sn_chg_rest/change/normal

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 : 109. 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

Tabelle : 110. Abfrageparameter

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare zum Filtern des Ergebnissatzes. Der Name ist das Feld, in dem der angegebene Wert gefiltert wird. Dieser Parameter und sysparm_query schließen sich gegenseitig aus. Beispielweise können Sie anstelle der Verwendung von &sysparm_query=active=true die aufrufende Anweisung mithilfe von &active=true vereinfachen. Sie können auch den Anzeigewert verwenden, wenn das Feld ein Auswahl- oder ein Referenztypfeld ist, z. B. &state=closed anstatt &state=7. Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie sie jeweils mit einem kaufmännischen Und-Zeichen, z. B. &active=true&assigned_to=john.smith. Datentyp: Zeichenfolge
Bestellen	Feld, nach dem die zurückgesendeten Change Requests sortiert werden sollen. Datentyp: Zeichenfolge
sysparm_limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Standard: 500
sysparm_offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0
sysparm_query	Codierte Abfrage Wird zum Filtern des Ergebnissatzes verwendet. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>. <col_name>: Name der Tabellenspalte, nach der gefiltert werden soll. <operator>: Unterstützt die folgenden Werte: =: Stimmt genau überein mit <value>. !=: Stimmt nicht überein mit <value>. ^: Logisches UND, mehrfache Abfrageanweisungen. ^OR: Logisches ODER, mehrfache Abfrageanweisungen. LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. STARTSWITH: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. <value>: Wert, mit dem abgeglichen werden soll. Weitere Operatoren finden Sie unter Operators available for filters and queries. Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Beispiel: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> Beispiel: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge
Textsuche	Zeichenfolge, die zum Durchsuchen aller normalen Change Request-Datensatzfelder verwendet wird. Diese Suche verwendet Volltextsuche-Funktionalität der ServiceNow-Plattform und verwendet standardmäßig IR_AND_OR_QUERY. Datentyp: Zeichenfolge

Tabelle : 111. Anforderungstextparameter (XML oder JSON)

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 : 112. Anforderungskopfzeilen

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

Tabelle : 113. 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 : 114. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Werte für alle Felder im zugehörigen Change Request. Datentyp: Objekt
Status	Status des Change Requests vor dem Löschen. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Wert ist immer „Normal“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Normal“. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    },
    { // next record found }, ... // and so on
  ]
}

Change-Management – GET /sn_chg_Rest/Change/normal/{sys_ID}

Ruft den normalen Change Request ab, der von der angegebenen sys_id identifiziert wird.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/normal/{sys_ID}

Standard-URL: /api/sn_chg_rest/change/normal/{sys_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 : 115. 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
sys_id	SYS_ID der normalen Change-Anforderung, die abgerufen werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 116. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 117. Anforderungstextparameter (XML oder JSON)

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 : 118. Anforderungskopfzeilen

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

Tabelle : 119. 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 : 120. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Werte für alle Felder im zugehörigen Change Request. Datentyp: Objekt
Status	Status des Change Requests vor dem Löschen. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Wert ist immer „Normal“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Normal“. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    },
  ]
}

Change-Management – GET /sn_chg_Rest/Change/Standard

Ruft einen oder mehrere Standard-Change Requests basierend auf den angegebenen Kriterien ab.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Standard

Standard-URL: /api/sn_chg_rest/change/standard

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 : 121. 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

Tabelle : 122. Abfrageparameter

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare zum Filtern des Ergebnissatzes. Der Name ist das Feld, in dem der angegebene Wert gefiltert wird. Dieser Parameter und sysparm_query schließen sich gegenseitig aus. Beispielweise können Sie anstelle der Verwendung von &sysparm_query=active=true die aufrufende Anweisung mithilfe von &active=true vereinfachen. Sie können auch den Anzeigewert verwenden, wenn das Feld ein Auswahl- oder ein Referenztypfeld ist, z. B. &state=closed anstatt &state=7. Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie sie jeweils mit einem kaufmännischen Und-Zeichen, z. B. &active=true&assigned_to=john.smith. Datentyp: Zeichenfolge
Bestellen	Feld, nach dem die zurückgesendeten Change Requests sortiert werden sollen. Datentyp: Zeichenfolge
sysparm_limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Datentyp: Zeichenfolge Standard: 500
sysparm_offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0
sysparm_query	Codierte Abfrage Wird zum Filtern des Ergebnissatzes verwendet. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>. <col_name>: Name der Tabellenspalte, nach der gefiltert werden soll. <operator>: Unterstützt die folgenden Werte: =: Stimmt genau überein mit <value>. !=: Stimmt nicht überein mit <value>. ^: Logisches UND, mehrfache Abfrageanweisungen. ^OR: Logisches ODER, mehrfache Abfrageanweisungen. LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. STARTSWITH: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. <value>: Wert, mit dem abgeglichen werden soll. Weitere Operatoren finden Sie unter Operators available for filters and queries. Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Beispiel: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> Beispiel: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge
Textsuche	Zeichenfolge, die zum Durchsuchen aller Standard-Change Request-Datensatzfelder verwendet wird. Diese Suche verwendet ServiceNow Volltextsuche-Plattformfunktionalität und ist standardmäßig auf festgelegt IR_AND_OR_QUERY . Datentyp: Zeichenfolge

Tabelle : 123. Anforderungstextparameter (XML oder JSON)

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 : 124. Anforderungskopfzeilen

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

Tabelle : 125. 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 : 126. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Alle Felder (Schlüssel) mit ihren zugehörigen Werten für den identifizierten Change Request. Datentyp: Objekt
Status	Status des Change Requests vor dem Löschen. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Wert ist immer „Standard“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Standard“. Datentyp: Zeichenfolge

Beispiel für eine cURL-Anforderung

curl "https://instance.service-now.com/api/sn_chg_rest/v1/change/standard?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "standard",
        display_value: "Standard"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    }, 
    { // next record found }, ... // and so on
  ]
}

Change-Management – GET /sn_chg_Rest/Change/Standard/{sys_ID}

Ruft den Standard-Change Request ab, der von der angegebenen sys_id identifiziert wird.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Standard/{sys_ID}

Standard-URL: /api/sn_chg_rest/change/standard/{sys_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 : 127. 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
sys_id	SYS_ID der abzurufenden Standard-Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 128. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 129. Anforderungstextparameter (XML oder JSON)

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 : 130. Anforderungskopfzeilen

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

Tabelle : 131. 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 : 132. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Alle Felder (Schlüssel) mit ihren zugehörigen Werten für den identifizierten Change Request. Datentyp: Objekt
Status	Status des Change Requests vor dem Löschen. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      },
    }, 
  ]
}

Change-Management – GET /sn_chg_Rest/Change/Standard/template

Ruft eine oder mehrere Standard-Change-Vorlagen basierend auf den angegebenen Kriterien ab.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Standard/template

Standard-URL: /api/sn_chg_rest/change/standard/template

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 : 133. 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

Tabelle : 134. Abfrageparameter

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare zum Filtern des Ergebnissatzes. Der Name ist das Feld, in dem der angegebene Wert gefiltert wird. Dieser Parameter und sysparm_query schließen sich gegenseitig aus. Beispielweise können Sie anstelle der Verwendung von &sysparm_query=active=true die aufrufende Anweisung mithilfe von &active=true vereinfachen. Sie können auch den Anzeigewert verwenden, wenn das Feld ein Auswahl- oder ein Referenztypfeld ist, z. B. &state=closed anstatt &state=7. Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie sie jeweils mit einem kaufmännischen Und-Zeichen, z. B. &active=true&assigned_to=john.smith. Datentyp: Zeichenfolge
Bestellen	Feld, nach dem die zurückgegebenen Standard-Change-Vorlagen sortiert werden sollen. Datentyp: Zeichenfolge Standard: Zahl
sysparm_limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Standard: 500
sysparm_offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist. Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0
sysparm_query	Codierte Abfrage Wird zum Filtern des Ergebnissatzes verwendet. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>. <col_name>: Name der Tabellenspalte, nach der gefiltert werden soll. <operator>: Unterstützt die folgenden Werte: =: Stimmt genau überein mit <value>. !=: Stimmt nicht überein mit <value>. ^: Logisches UND, mehrfache Abfrageanweisungen. ^OR: Logisches ODER, mehrfache Abfrageanweisungen. LIKE: <col_name> enthält die angegebene Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. STARTSWITH: <col_name> beginnt mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. ENDSWITH: <col_name> endet mit der angegebenen Zeichenfolge. Funktioniert nur für <col_name>-Felder, deren Datentyp „string“ (Zeichenfolge) ist. <value>: Wert, mit dem abgeglichen werden soll. Weitere Operatoren finden Sie unter Operators available for filters and queries. Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Beispiel: (sysparm_query=caller_id=javascript:gs.getUserID()^active=true) Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln ORDERBY und ORDERBYDESC in sysparm_query, um Antworten anhand bestimmter Felder zu sortieren. Syntax: ORDERBY<col_name> ORDERBYDESC<col_name> Beispiel: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. Datentyp: Zeichenfolge
Textsuche	Zeichenfolge, die zum Durchsuchen aller Standard-Change Request-Datensatzfelder verwendet wird. Diese Suche verwendet Volltextsuche-Funktionalität der ServiceNow-Plattform und verwendet standardmäßig IR_AND_OR_QUERY. Datentyp: Zeichenfolge

Tabelle : 135. Anforderungstextparameter (XML oder JSON)

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 : 136. Anforderungskopfzeilen

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

Tabelle : 137. 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 : 138. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Alle Felder mit ihren zugehörigen Werten für die identifizierte Standard-Change-Vorlage. Datentyp: Objekt
sys_id	SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
Vorlage	Informationen zur Standard-Change-Vorlage. Datentyp: Objekt template: { display_value: "String", value: "String" }
Vorlage.Display_value	Vorlageninformationen, die in der Anwenderoberfläche angezeigt werden sollen. Datentyp: Zeichenfolge
Vorlage.Wert	Vorlage sys_ID Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "92b8544047810200e90d87e8dee490b0",
        display_value: "92b8544047810200e90d87e8dee490b0"
      },
      template : {
        value: "1c8e02ec47410200e90d87e8dee49057", 
        display_value: "Add network switch to datacenter cabinet"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Standard change template to add network switch to cabinet",
        display_value: "Standard change template to add network switch to cabinet"
      },
    }, 
    { // next record found }, ... // and so on
  ]
}

Change-Management – GET /sn_chg_Rest/Change/Standard/template/{sys_ID}

Ruft die Standard-Change-Vorlage ab, die durch die angegebene sys_id identifiziert wird.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Standard/template/{sys_ID}

Standard-URL: /api/sn_chg_rest/change/standard/template/{sys_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 : 139. 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
sys_id	SYS_ID der abzurufenden Standard-Change-Vorlage. Datentyp: Zeichenfolge Tabelle: Standard-Change-Vorlage [Std_Change_Record_Producer]

Tabelle : 140. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 141. Anforderungstextparameter (XML oder JSON)

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 : 142. Anforderungskopfzeilen

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

Tabelle : 143. 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 : 144. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Alle Felder mit ihren zugehörigen Werten für die identifizierte Standard-Change-Vorlage. Datentyp: Objekt
sys_id	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
Vorlage	Informationen zur Standard-Change-Vorlage. Datentyp: Objekt template: { display_value: "String", value: "String" }
Vorlage.Display_value	Vorlageninformationen, die in einer UI angezeigt werden sollen. Datentyp: Zeichenfolge
Vorlage.Wert	Vorlage sys_ID Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template/92b8544047810200e90d87e8dee490b0" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "92b8544047810200e90d87e8dee490b0",
      template : {
        value: "1c8e02ec47410200e90d87e8dee49057", 
        display_value: "Add network switch to datacenter cabinet"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Standard change template to add network switch to cabinet",
        display_value: "Standard change template to add network switch to cabinet"
      },
    }, 
  ]
}

Change-Management – GET /sn_chg_Rest/Change/Worker/{sys_ID}

Ruft den aktuellen Status, Informationen und Fehler für den angegebenen asynchronen Worker ab.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Worker/{sys_ID}

Standard-URL: /api/sn_chg_Rest/{Change/Worker/{sys_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 : 145. 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
sys_id	SYS_ID des asynchronen Worker für das Change-Management. Datentyp: Zeichenfolge Tabelle: Change-Management-Mitarbeiter [chg_mgt_Worker]

Tabelle : 146. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 147. Anforderungstextparameter (XML oder JSON)

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 : 148. Anforderungskopfzeilen

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

Tabelle : 149. 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 : 150. Statuscodes

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

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Nachrichten	Nachrichteninformationen. Datentyp: Objekt "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
Nachrichten.FehlerNachrichten	Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben Datentyp: Array
messages.infoMessages	Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Zum Beispiel: CMDB_CI sys_ID ist bereits angegeben zugeordnet. Datentyp: Array
Nachrichten.WarnungsNachrichten	Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben. Datentyp: Array
Nutzlast	Eindeutige Nutzlast, die bereitgestellt wird, wenn eine Worker-sys_ID aus dem erfolgreichen Antworttext eines Zeitplanendpunkts verwendet wird. /ci/{cmdb_ci_sys_ID}/schedule ABRUFEN RUFEN SIE /sn_chg_Rest/Change/{Change_sys_ID}/schedule AB "payload": { "spans": [Array] } Datentyp: Objekt
Nutzlast.Spannen	Wenn eine Zeitspanne innerhalb der im Zeitplan-Endpunkt angegebenen Dauer verfügbar ist, listet die Worker-API die verfügbaren Zeitspannen auf. "payload": { "spans": [ { "end": {Object}, "start": {Object} } ] } Datentyp: Array
Payload.Spans.Start	"start": { "display_value": "String", "value": "String" } Datentyp: Objekt
Payload.Spans.Start.value	Datum und Uhrzeit, zu der die Implementierung der Change-Anforderung beginnen soll. Datentyp: Zeichenfolge
Payload.Spans.Start.Display_value	Zeigt den Wert der Startzeit der Change-Anforderung an. Zeitformat: jjjj-mm-TT hh:mm:ss Datentyp: Zeichenfolge
Payload.Spans.End	"end": { "display_value": "String", "value": "String" } Datentyp: Objekt
Payload.Spans.end.Wert	Datum und Uhrzeit, zu der der Abschluss der Change-Anforderung geplant ist. Zeitformat: jjjj-mm-TT hh:mm:ss Datentyp: Zeichenfolge
Payload.Spans.end.Display_value	Zeigt den Wert der Abschlusszeit der Change-Anforderung an. Datentyp: Zeichenfolge
Anforderung	Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge
Status	Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt state: { display_value: "String", value: Number }
status.Display_value	Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueParameter. Mögliche Werte: Abschließen Fehler In Bearbeitung Warten Datentyp: Zeichenfolge
status.Wert	Numerischer Wert des Status des Mitarbeiters. Mögliche Werte: 1 2 3 4 Datentyp: Zahl
type	Typ der Zuordnung zwischen dem CMDB-CI und der Change-Anforderung. Datentyp: Zeichenfolge
Mitarbeiter	Informationen zum zugehörigen Mitarbeiter. Datentyp: Objekt "worker": { "link": "String", "sysId": "String" }
Worker.Link	URL zum Abrufen des Status des zugeordneten Mitarbeiters und anderer relevanter Mitarbeiterinformationen. Datentyp: Zeichenfolge
Worker.sysId	SYS_ID des Mitarbeiters, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge
<other_params>	Andere prozessspezifische Parameter, z. B. ignored_cmdb_ci_sys_ids.

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/worker/0644cd02dbec330084f07ffdbf9619c1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

{
  "result": {
    "worker": {
      "sysId": "0644cd02dbec330084f07ffdbf9619c1",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/0644cd02dbec330084f07ffdbf9619c1"
    },
    "request": "{\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "impacted",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

Change-Management – PATCH /sn_chg_Rest/Change/{sys_ID}

Aktualisiert die durch die angegebene sys_ID identifizierte Change-Anforderung mit den Schlüssel-Wert-Paaren im Anforderungstext oder in der URL.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}

Standard-URL: /api/sn_chg_Rest/Change/{sys_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 : 151. 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
sys_id	SYS_ID der Change-Anforderung, die geändert werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 152. Abfrageparameter

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstextparameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Datentyp: Zeichenfolge
Encrypted_fields	Liste der kommagetrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt GlideRecord auf SetDisplayValue() Methode, anstatt aufzurufen SetValue() Methode. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für nicht verschlüsselte Felder wie Referenz- oder Auswahlfelder zu übergeben, anstatt sys_IDs oder Werte zu übergeben. Datentyp: Zeichenfolge

Tabelle : 153. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Daten	Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um zum Beispiel die Datei „Kurzbeschreibung“ zu aktualisieren, geben Sie ein Name-Wert-Paar ein, das ähnlich ist wie das Folgende: --data "{\"short_description\": \"my short desc\" }" \. Datentyp: Zeichenfolge
Encrypted_fields	Liste der kommagetrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt GlideRecord auf SetDisplayValue() Methode, anstatt aufzurufen SetValue() Methode. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für nicht verschlüsselte Felder wie Referenz- oder Auswahlfelder zu übergeben, anstatt sys_IDs oder Werte zu übergeben. Datentyp: Zeichenfolge

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 : 154. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 155. 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 : 156. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Ergebnis	Change-Anforderungsdatensatz aktualisiert. Jedes Element in diesem Objekt entspricht einem Feld im Datensatz in der Tabelle „Change-Anforderung“ [Change_Request]. Alle Elemente enthalten valueUnd display_valueName-Wert-Paare. Einige enthalten display_value_internalName-Wert-Paare. Datentyp: Objekt

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"short_desription\": \"Reboot the server at 6 am\" }" \
--user "username":"password"

{
  "result":
    {
      "reason": {
        "display_value": "",
        "value": ""
      },
      "parent": {
        "display_value": "",
        "value": ""
      },
      "watch_list": {
        "display_value": "",
        "value": ""
       },
       "proposed_change": {
         "display_value": "",
         "value": ""
       },
       "upon_reject": {
         "display_value": "Cancel all future Tasks",
         "value": "cancel"
       },
       "sys_updated_on": {
         "display_value": "2015-07-06 11:59:27",
         "value": "2015-07-06 18:59:27",
         "display_value_internal": "2015-07-06 11:59:27"
      },
      "type": {
        "display_value": "Standard",
        "value": "standard"
      },
      "approval_history": {
        "display_value": "",
        "value": ""
      },
      "skills": {
        "display_value": "",
        "value": ""
      },
      "test_plan": {
        "display_value": "--Confirm that there are no monitoring alerts for the router",
        "value": "--Confirm that there are no monitoring alerts for the router"
      },
      "number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "is_bulk": {
        "display_value": "false",
        "value": false
      },
      "cab_delegate": {
        "display_value": "",
        "value": ""
      },
      "requested_by_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "ci_class": {
        "display_value": "cmdb_ci",
        "value": "cmdb_ci"
      },
      "state": {
        "display_value": "Closed",
        "value": 3.0
      },
      "sys_created_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "knowledge": {
        "display_value": "false",
        "value": false
      },
      "order": {
        "display_value": "",
        "value": ""
      },
      "phase": {
        "display_value": "Requested",
        "value": "requested"
      },
      "cmdb_ci": {
        "display_value": "",
        "value": ""
      },
      "delivery_plan": {
        "display_value": "",
        "value": ""
      },
      "impact": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "contract": {
        "display_value": "",
        "value": ""
      },
      "active": {
        "display_value": "false",
        "value": false
      },
      "work_notes_list": {
        "display_value": "",
        "value": ""
      },
      "priority": {
        "display_value": "4 - Low",
        "value": 4.0
      },
      "sys_domain_path": {
        "display_value": "/",
        "value": "/"
      },
      "cab_recommendation": {
        "display_value": "",
        "value": ""
      },
      "production_system": {
        "display_value": "false",
        "value": false
      },
      "rejection_goto": {
        "display_value": "",
        "value": ""
      },
      "review_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "requested_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "business_duration": {
        "display_value": "",
        "value": ""
      },
      "group_list": {
        "display_value": "",
        "value": ""
      },
      "change_plan": {
        "display_value": "",
        "value": ""
      },
      "approval_set": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "wf_activity": {
        "display_value": "",
        "value": ""
      },
      "implementation_plan": {
        "display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
        "value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
      },
      "universal_request": {
        "display_value": "",
        "value": ""
      },
      "end_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "short_description": {
        "display_value": "Reboot the server at 6 am",
        "value": "Reboot the server at 6 am"
      },
      "correlation_display": {
        "display_value": "",
        "value": ""
      },
      "work_start": {
        "display_value": "2015-07-06 11:56:04",
        "value": "2015-07-06 18:56:04",
        "display_value_internal": "2015-07-06 11:56:04"
      },
      "delivery_task": {
        "display_value": "",
        "value": ""
      },
      "outside_maintenance_schedule": {
        "display_value": "false",
        "value": false
      },
      "additional_assignee_list": {
        "display_value": "",
        "value": ""
      },
      "std_change_producer_version": {
        "display_value": "Clear BGP sessions on a Cisco router - 1",
        "value": "16c2273c47010200e90d87e8dee49006"
      },
      "sys_class_name": {
        "display_value": "Change Request",
        "value": "change_request"
      },
      "service_offering": {
        "display_value": "",
        "value": ""
      },
      "closed_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "follow_up": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "review_status": {
        "display_value": "",
        "value": ""
      },
      "reassignment_count": {
        "display_value": "2",
        "value": 2.0
      },
      "start_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "assigned_to": {
        "display_value": "",
        "value": ""
      },
      "variables": {
        "display_value": "variable_pool",
        "value": "variable_pool"
      },
      "sla_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments_and_work_notes": {
        "display_value": "",
        "value": ""
      },
      "escalation": {
        "display_value": "Normal",
        "value": 0.0
      },
      "upon_approval": {
        "display_value": "Proceed to Next Task",
        "value": "proceed"
      },
      "correlation_id": {
        "display_value": "",
        "value": ""
      },
      "made_sla": {
        "display_value": "true",
        "value": true
      },
      "backout_plan": {
        "display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
        "value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
      },
      "conflict_status": {
        "display_value": "Not Run",
        "value": "Not Run"
      },
      "task_effective_number": {
        "display_value": "CHG0000024",
        "value": "CHG0000024"
      },
      "sys_updated_by": {
        "display_value": "admin",
        "value": "admin"
      },
      "opened_by": {
        "display_value": "System Administrator",
        "value": "6816f79cc0a8016401c5a33be04be441"
      },
      "user_input": {
        "display_value": "",
        "value": ""
      },
      "sys_created_on": {
        "display_value": "2015-07-06 11:55:46",
        "value": "2015-07-06 18:55:46",
        "display_value_internal": "2015-07-06 11:55:46"
      },
      "on_hold_task": {
        "display_value": "",
        "value": ""
      },
      "sys_domain": {
        "display_value": "global",
        "value": "global"
      },
      "route_reason": {
        "display_value": "",
        "value": ""
      },
      "closed_at": {
        "display_value": "2015-07-06 11:56:23",
        "value": "2015-07-06 18:56:23",
        "display_value_internal": "2015-07-06 11:56:23"
      },
      "review_comments": {
        "display_value": "",
        "value": ""
      },
      "business_service": {
        "display_value": "",
        "value": ""
      },
      "time_worked": {
        "display_value": "",
        "value": ""
      },
      "chg_model": {
        "display_value": "",
        "value": ""
      },
      "expected_start": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "opened_at": {
        "display_value": "2015-06-09 11:55:46",
        "value": "2015-06-09 18:55:46",
        "display_value_internal": "2015-06-09 11:55:46"
      },
      "work_end": {
        "display_value": "2015-07-06 11:56:10",
        "value": "2015-07-06 18:56:10",
        "display_value_internal": "2015-07-06 11:56:10"
      },
      "phase_state": {
        "display_value": "Open",
        "value": "open"
      },
      "cab_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "work_notes": {
        "display_value": "",
        "value": ""
      },
      "close_code": {
        "display_value": "Successful",
        "value": "successful"
      },
      "assignment_group": {
        "display_value": "Network",
        "value": "287ebd7da9fe198100f92cc8d1d2154e"
      },
      "description": {
        "display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
        "value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
      },
      "on_hold_reason": {
        "display_value": "",
        "value": ""
      },
      "calendar_duration": {
        "display_value": "",
        "value": ""
      },
      "close_notes": {
        "display_value": "Completed without issues",
        "value": "Completed without issues"
      },
      "sys_id": {
        "display_value": "b0dbda5347c12200e0ef563dbb9a718f",
        "value": "b0dbda5347c12200e0ef563dbb9a718f"
      },
      "contact_type": {
        "display_value": "Phone",
        "value": "phone"
      },
      "cab_required": {
        "display_value": "false",
        "value": false
      },
      "urgency": {
        "display_value": "3 - Low",
        "value": 3.0
      },
      "scope": {
        "display_value": "Medium",
        "value": 3.0
      },
      "company": {
        "display_value": "",
        "value": ""
      },
      "justification": {
        "display_value": "",
        "value": ""
      },
      "activity_due": {
        "display_value": "UNKNOWN",
        "value": "",
        "display_value_internal": ""
      },
      "comments": {
        "display_value": "",
        "value": ""
      },
      "approval": {
        "display_value": "Approved",
        "value": "approved"
      },
      "due_date": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "sys_mod_count": {
        "display_value": "10",
        "value": 10.0
      },
      "on_hold": {
        "display_value": "false",
        "value": false
      },
      "sys_tags": {
        "display_value": "",
        "value": ""
      },
      "conflict_last_run": {
        "display_value": "",
        "value": "",
        "display_value_internal": ""
      },
      "risk_value": {
        "display_value": "",
        "value": ""
      },
      "unauthorized": {
        "display_value": "false",
        "value": false
      },
      "risk": {
        "display_value": "Moderate",
        "value": 3.0
      },
      "location": {
        "display_value": "",
        "value": ""
      },
      "category": {
        "display_value": "Other",
        "value": "Other"
      },
      "risk_impact_analysis": {
        "display_value": "",
        "value": ""
      }
    }
}

cURL-Anforderung

Das folgende Beispiel zeigt, wie verschlüsselte Felder im Anforderungstext übergeben werden.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"encrypted_fields\":\"short_description,description\",
    \"short_description\":\"my short desc\",
    \"description\":\"my desc\"
}" \
--user "username":"password"

cURL-Anforderung

Das folgende Beispiel zeigt, wie verschlüsselte Felder als Abfrageparameter übergeben werden.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"

Change-Management – PATCH /sn_chg_Rest/Change/{sys_ID}/Approvals

Ermöglicht dem aktuellen Anwender, einen Datensatz für die Genehmigung einer Change-Anforderung für die angegebene Change-Anforderung zu genehmigen oder abzulehnen.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/Approvals

Standard-URL: /api/sn_chg_rest/change/{sys_id}/approvals

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 : 157. 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
sys_id	SYS_ID der Change-Anforderung, für die die Genehmigung/Ablehnung gilt. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 158. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 159. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Kommentare	Erforderlich, wenn stateIst Abgelehnt . Grund, warum der Change abgelehnt wurde. Datentyp: Zeichenfolge
Status	Erforderlich. Genehmigungsstatus. Beispiel: --Data „{\"State\": \"genehmigt\"}" Gültige Werte: genehmigt abgelehnt Datentyp: Zeichenfolge

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 : 160. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 161. 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 : 162. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
400	Fehlerhafte Anforderung. Zeigt einen fehlerhaften Anforderungstyp an, wie zum Beispiel, dass der Benutzer nicht über die Befugnis zum Genehmigen oder Ablehnen des Change Requests verfügt.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Werte für alle Felder im zugehörigen Change Request. Datentyp: Objekt
Status	Aktueller Status des Change Requests. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID der Change-Anforderung, die genehmigt/abgelehnt wird. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Mögliche Werte: Notfall Normal Standard Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Mögliche Werte: Notfall Normal Standard Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/approvals" \
--request POST \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"approved\"}" \
--user "username":"password"

{
  result: [
    {
      sys_id: "0f4ac6c4b750230096c3e4f6ee11a9fe",
      state: {
        value: "-2", 
        display_value: "Scheduled"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, single parameter example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      }
    }
  ]
}

Change-Management – PATCH /sn_chg_Rest/Change/{Change_sys_ID}/schedule/first_available

Aktualisiert die geplanten Start- und Endzeiten einer Change-Anforderung mithilfe des ersten gefundenen verfügbaren Zeitfensters.

Erforderliche Rolle: sn_Change_Writer.

Hinweis:

Verwenden Sie den im Antworttext bereitgestellten Link worker.linkEigenschaft zum Anzeigen des Zeitplanstatus.

Siehe auch:

• RUFEN SIE /sn_chg_Rest/Change/ci/{cmdb_ci_sys_ID}/schedule AB
• RUFEN SIE /sn_chg_Rest/Change/{Change_sys_ID}/schedule AB

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/schedule/first_available

Standard-URL: /api/sn_chg_Rest/Change/{Change_sys_ID}/schedule/first_available

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 : 163. 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
change_sys_id	SYS_ID der Change-Anforderung, für die mit dem nächsten verfügbaren Zeitfenster aktualisiert werden soll. Die ausgewählte Change-Anforderung muss ein Konfigurationselement (cmdb_ci) aufweisen. Datentyp: Zeichenfolge Tabelle: Change-Anforderungen [Change_Request]

Tabelle : 164. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 165. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Duration_in_seconds	Dauer des Change in Sekunden, d. h. wie viel Zeit zum Abschließen der Change-Anforderungsaufgabe erforderlich ist. Datentyp: Ganzzahl
Geplant_Start_time	Optional. Datum und Uhrzeit, zu der die Implementierung der Change-Anforderung in UTC beginnen soll. Rufen Sie das verfügbare Zeitfenster ab, das um oder nach diesem Zeitpunkt beginnt. Wenn nicht angegeben, verwendet das System die aktuelle Uhrzeit als Startzeit. Format: jjjj-mm-TT hh:mm:ss Datentyp: Zeichenfolge

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 : 166. Anforderungskopfzeilen

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

Tabelle : 167. 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 : 168. Statuscodes

Statuscode	Beschreibung
202	Das System hat die Anforderung akzeptiert.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Mögliche Probleme: Der Textparameterwert duration_in_seconds ist ungültig oder wurde nicht angegeben. Ungültiger Textparameterwert für „Planned_Start_time“ angegeben. Der angegebenen Change-Anforderung ist kein Konfigurationselement zugeordnet (cmdb_ci). Anwender hat keinen Lesezugriff auf die Felder der Change-Anforderung.
403	Unzulässig. Anwender hat keinen Schreibzugriff auf die geplanten Start- und Enddatumswerte der Change-Anforderung.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. Mögliche Probleme: Das System kann die Change-Anforderung basierend auf den bereitgestellten Informationen nicht finden. Anwender hat keinen Lesezugriff auf den Datensatz.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Fehler	Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt "error": { "detail": "String", "message": "String", "status": "String" }
error.detail	Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge
Fehler.Nachricht	Meldung, die den Fehler identifiziert. Datentyp: Zeichenfolge
Nachrichten	Nachrichteninformationen. Datentyp: Objekt "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
Nachrichten.FehlerNachrichten	Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Datentyp: Array
messages.infoMessages	Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Datentyp: Array
Nachrichten.WarnungsNachrichten	Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Datentyp: Array
Anforderung	Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge
Status	Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt state: { display_value: "String", value: Number }
status.Display_value	Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueParameter. Mögliche Werte: Abschließen Fehler In Bearbeitung Warten Datentyp: Zeichenfolge
status.Wert	Numerischer Wert des Status des Mitarbeiters. Mögliche Werte: 1 2 3 4 Datentyp: Zahl
type	Typ der Anforderung. Gültiger Wert: Zeitplan Datentyp: Zeichenfolge
Mitarbeiter	Informationen zum zugehörigen Mitarbeiter. Datentyp: Objekt "worker": { "link": "String", "sysId": "String" }
Worker.Link	Link zum Abrufen des Zeitplanstatus der Change-Anforderung. Verwenden Sie die sys_ID in RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Zum Anzeigen von Ergebnissen. Datentyp: Zeichenfolge
Worker.sysId	SYS_ID des Mitarbeiters, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge
status	Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge

Ruft den Zeitplanstatus der Change-Anforderung ab

Verwenden Sie den in angegebenen Wert worker.linkUm festzustellen, ob der Change-Datensatz erfolgreich für das erste verfügbare Zeitfenster geplant wurde. Der Wert hat das folgende Format:

https://instance.service-now.com/api/sn_chg_rest/change/worker/<worker_sys_id>

Verwenden Sie die Worker.Link-Details, um die angegebene sys_ID in auszuführen RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Zum Anzeigen von Ergebnissen.

Der Antworttext enthält den Status und liefert Ergebnisse, wenn die Verarbeitung abgeschlossen ist.

Wenn ein verfügbares Zeitfenster gefunden wird, aktualisiert das System die Change-Anforderung mit dem ersten verfügbaren Zeitfenster. Wenn der Status „Abgeschlossen“ ist, wird messages.infoMessagesZeigt an, dass das erste verfügbare Zeitfenster festgelegt wurde.

Einer der folgenden Zeitplanantwortwerte für messages.infoMessagesWerden im Antworttext angegeben:

• Change wurde aktualisiert – Change angefordert wurde für Zeitfenster aktualisiert.
• Keine Zeitfenster für <number>-Tage ab jetzt gefunden – Keine Zeitfenster für die Dauer der Change-Anforderung verfügbar, die innerhalb der im Zeitplanfenster definierten Anzahl von Tagen angegeben wird.
  Hinweis:

  Der Standardwert für das Zeitfenster der Change-Anforderungsplanung ist 90 Tage. Um diesen Wert zu ändern, ändern Sie change.conflict.next_available.schedule_windowEigenschaft. Weitere Informationen finden Sie unter Konfigurieren Sie Konfliktanalyseeigenschaften .

Folgendes RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Das Beispiel zeigt die Ausgabe, die mit der im Worker.Link-Detail angegebenen ID bereitgestellt wird. Die Ergebnisse zeigen an, dass die Verarbeitung abgeschlossen ist und die Change-Anforderung mit dem ersten verfügbaren Zeitfenster aktualisiert wurde.

{
  "result": {
    "worker": {
      "sysId": "355c62e0a4c87010f87712198fe9cacf",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 3,
      "display_value": "Complete"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": [
        "Change has been updated"
      ]
    }
  }
}

cURL-Anforderung

curl "https://instance.service-now.com/api/sn_chg_rest/change/87ae5e900a0a2c3e263e8304e727c646/schedule/first_available" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"duration_in_seconds\":\"10800\"}" \
--user "username":"password"

Ergebnisse enthalten Worker.Link-Details, die Sie verwenden können, um die angegebene sys_ID im Endpunkt GET /sn_chg_Rest/Change/Worker/ auszuführen.

{
  "result": {
    "worker": {
      "sysId": "355c62e0a4c87010f87712198fe9cacf",
      "link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
    },
    "request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "schedule",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

Change-Management – PATCH /sn_chg_Rest/Change/{Change_sys_ID}/Task/{Task_sys_ID}

Aktualisiert die Change Request-Aufgabe, die von der angegebenen sys_id identifiziert wurde, mit den Schlüssel-Wert-Paaren im Anforderungstext oder der URL.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/Task/{Task_sys_ID}

Standard-URL: /api/sn_chg_rest/change/{change_sys_id}/task/{task_sys_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 : 169. 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
change_sys_id	SYS_ID der Change-Anforderung, der die Aufgabe zugeordnet ist. Überprüft, ob die angegebene Aufgabe der angegebenen Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]
task_sys_id	SYS_ID der zu ändernden Aufgabe. Datentyp: Zeichenfolge Tabelle: Change-Aufgabe [Change_Task]

Tabelle : 170. Abfrageparameter

Name	Beschreibung
Schlüssel-Wert-Paare	Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstextparameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Datentyp: Zeichenfolge

Tabelle : 171. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Daten	Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um zum Beispiel die Datei „Kurzbeschreibung“ zu aktualisieren, geben Sie ein Name-Wert-Paar ein, das ähnlich ist wie das Folgende: --data "{\"short_description\": \"my short desc\" }" \. Datentyp: Zeichenfolge

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 : 172. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 173. 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 : 174. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Alle Felder (Schlüssel) mit ihren zugehörigen Werten für die identifizierte Change Request-Aufgabe vor dem Löschen. Datentyp: Objekt
sys_id	SYS_ID-Informationen für die Change-Anforderungsaufgabe. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderungsaufgabe, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderungsaufgabe. Datentyp: Zeichenfolge
übergeordnet	Eindeutige Bezeichnerinformationen für die Change-Anforderung, die dieser Aufgabe zugeordnet ist. Datentyp: Objekt parent: { display_value: "String", value: "String" }
Parent.Display_value	Aufgabeninformationen, die in einer UI angezeigt werden sollen. Datentyp: Zeichenfolge
Übergeordnetes Element.Wert	SYS_ID der übergeordneten Aufgabe. Datentyp: Zeichenfolge
__Meta.ignoredFelder	Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5?short_description=Retire both nodes" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "12629ec4b750230096c3e4f6ee11a9d5",
        display_value: "12629ec4b750230096c3e4f6ee11a9d5"
      },
      parent: {
        value: "0f4ac6c4b750230096c3e4f6ee11a9fe", 
        display_value: "CHG0033046 "
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Retire both nodes",
        display_value: "Retire both nodes"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Change-Management – PATCH /sn_chg_Rest/Change/Emergency/{sys_ID}

Aktualisiert den Notfall-Change Request, der von der angegebenen sys_id identifiziert wurde, mit den Schlüssel-Wert-Paaren im Anforderungstext oder der URL.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Emergency/{sys_ID}

Standard-URL: /api/sn_chg_rest/change/emergency/{sys_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 : 175. 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
sys_id	SYS_ID der Change-Anforderung, die geändert werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 176. Abfrageparameter

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstextparameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Datentyp: Zeichenfolge

Tabelle : 177. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Daten	Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um zum Beispiel die Datei „Kurzbeschreibung“ zu aktualisieren, geben Sie ein Name-Wert-Paar ein, das ähnlich ist wie das Folgende: --data "{\"short_description\": \"my short desc\" }" \. Datentyp: Zeichenfolge

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 : 178. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 179. 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 : 180. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Werte für alle Felder im zugehörigen Change Request. Datentyp: Zeichenfolge
Status	Aktueller Status des Change Requests. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge
__Meta.ignoredFelder	Name-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"no_such_field\": \"this will be ignored\", }" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",    },
      state: {
        value: "-4", 
        display_value: "Assess"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Change-Management – PATCH /sn_chg_Rest/Change/normal/{sys_ID}

Aktualisiert den normalen Change Request, der von der angegebenen sys_id identifiziert wurde, mit den Parametern im Anforderungstext oder der URL.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/normal/{sys_ID}

Standard-URL: /api/sn_chg_rest/change/normal/{sys_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 : 181. 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
sys_id	SYS_ID der Change-Anforderung, die geändert werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 182. Abfrageparameter

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstextparameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Datentyp: Zeichenfolge

Tabelle : 183. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Daten	Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um zum Beispiel die Datei „Kurzbeschreibung“ zu aktualisieren, geben Sie ein Name-Wert-Paar ein, das ähnlich ist wie das Folgende: --data "{\"short_description\": \"my short desc\" }" \. Datentyp: Zeichenfolge

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 : 184. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 185. 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 : 186. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Werte für alle Felder im zugehörigen Change Request. Datentyp: Objekt
Status	Aktueller Status des Change Requests. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Wert ist immer „Normal“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Normal“. Datentyp: Zeichenfolge
__Meta.ignoredFelder	Name-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f?state=assess" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-4", 
        display_value: "Assess"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Change-Management – PATCH /sn_chg_Rest/Change/Standard/{sys_ID}

Aktualisiert den Standard-Change Request, der von der angegebenen sys_id identifiziert wurde, mit den Parametern im Anforderungstext oder der URL.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Standard/{sys_ID}

Standard-URL: /api/sn_chg_rest/change/standard/{sys_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 : 187. 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
sys_id	SYS_ID der Change-Anforderung, die geändert werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 188. Abfrageparameter

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstextparameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Datentyp: Zeichenfolge

Tabelle : 189. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
Daten	Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um zum Beispiel die Datei „Kurzbeschreibung“ zu aktualisieren, geben Sie ein Name-Wert-Paar ein, das ähnlich ist wie das Folgende: --data "{\"short_description\": \"my short desc\" }" \. Datentyp: Zeichenfolge

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 : 190. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 191. 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 : 192. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Alle Felder (Schlüssel) mit ihren zugehörigen Werten für den identifizierten Change Request. Datentyp: Objekt
Status	Status der Change-Anforderung. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI bereitgestellt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177?description=Reboot my email server" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"short_description\": \"my short desc\" }" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      state: {
        value: "-5", 
        display_value: "New"
      },

      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot my email server",
        display_value: "Reboot my email server"
      },
    } 
  ]
}

Change-Management – PATCH /sn_chg_Rest/Change/Standard/{sys_ID}/Risk

Berechnet das Risiko und die Auswirkungen des angegebenen Standard-Change auf der Grundlage einer Bewertung der Risikobedingungen.

Wenn das Plugin Change Risk Assessment installiert ist, berechnet es auch das kumulativ höchste Risiko, sobald die Risikobewertung abgeschlossen ist.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/Risk

Standard-URL: /api/sn_chg_rest/change/{sys_id}/risk

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 : 193. 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
sys_id	SYS_ID des auszuwertenden Standard-Change. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 194. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 195. Anforderungstextparameter (XML oder JSON)

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 : 196. Anforderungskopfzeilen

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

Tabelle : 197. 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 : 198. Statuscodes

Statuscode	Beschreibung
200	Risikobewertung erfolgreich abgeschlossen.
400	Risikobewertung fehlgeschlagen Details zu der Art des Fehlers sind in den Fehlerdaten enthalten.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
impact	Auswirkungen im Zusammenhang mit dem angegebenen Standard-Change. Datentyp: Objekt impact: { display_value: "String", value: "String" }
Impact.Display_value	Auswirkungsinformationen, die in einer UI angezeigt werden sollen. Datentyp: Zeichenfolge
Auswirkung.Wert	Interner Auswirkungswert. Datentyp: Zeichenfolge
Name-Wert-Paare	Alle gültigen Felder innerhalb des standardmäßigen Change Record. Datentyp: Objekt
Risiko	Berechnetes Risiko für den angegebenen Standard-Change. Datentyp: Objekt risk: { display_value: "String", value: "String" }
Risiko.Display_value	Risikoinformationen, die in einer UI angezeigt werden sollen. Datentyp: Zeichenfolge
Risiko.Wert	Interner Risikowert. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen für die Standard-Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/1c87925347c12200e0ef563dbb9a7177/risk" \
--request PATCH \
--header "Accept:application/json" \
--user "username":"password"

{
  sys_id: {
    value: "1c87925347c12200e0ef563dbb9a7177",
    display_value: "1c87925347c12200e0ef563dbb9a7177"
  },
  risk: {
    value: "4", 
    display_value: "Low"
  },
  impact: {
    value: "3",
    display_value: "3 - Low"
  }
  ..., // all valid fields in record
}

Change-Management – NACH /sn_chg_Rest/Change

Erstellt einen Change-Anforderungsdatensatz basierend auf der Change-Anforderung. Das Erstellen mehrerer Change-Anforderungen innerhalb eines einzelnen Anrufs wird nicht unterstützt.

Mit können Sie die Liste der verfügbaren Change-Modelle abrufen Change-Management – GET /sn_chg_Rest/Change/model Oder Change-Management – GET /sn_chg_Rest/Change/model/{sys_ID} Endpunkte.

Legen Sie beim Erstellen einer Change-Anforderung das Change-Modell fest ( chg_model) Oder type. Wenn beides chg_modelUnd typeSind festgelegt, ist der Typ einfach eine Kategorisierung des Change. Wenn Sie nicht mindestens einen dieser Werte angeben, wird eine Standardeinstellung erstellt, die nach Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen.

Werte können entweder als Abfrageparameter oder als Anforderungstext-Parameter festgelegt werden.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change

Standard-URL: /api/sn_chg_Rest/Change

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 : 199. 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

Tabelle : 200. Abfrageparameter

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstextparameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Dieselben Werte können stattdessen als Anforderungstext-Parameter festgelegt werden. Hinweis: Legen Sie beim Erstellen einer Change-Anforderung das Change-Modell fest ( chg_model) Oder type. Wenn beides chg_modelUnd typeSind festgelegt, ist der Typ einfach eine Kategorisierung des Change. Wenn Sie nicht mindestens einen dieser Werte angeben, wird eine Standardeinstellung erstellt, die nach Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge
chg_model	Name eines Change-Modells, das in der Tabelle „Change-Modell“ [chg_model] aufgeführt ist. Wird im folgenden Format bereitgestellt: chg_model=normal . Weitere Informationen finden Sie unter Change-Modelle . Hinweis: Es wird weder das Change-Modell ( chg_model) Oder typeWert führt zu einer Standardeinstellung, die von Release zu Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge
Encrypted_fields	Liste der kommagetrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt GlideRecord auf SetDisplayValue() Methode, anstatt aufzurufen SetValue() Methode. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für nicht verschlüsselte Felder wie Referenz- oder Auswahlfelder zu übergeben, anstatt sys_IDs oder Werte zu übergeben. Datentyp: Zeichenfolge
type	Name des Change-Anforderungstyps, der in der Auswahltabelle [sys_choice] aufgeführt ist. Wenn chg_modelIst ebenfalls ausgefüllt, wird dieses Feld nur als Change-Kategorisierung verwendet. Wird im folgenden Format bereitgestellt: Typ=Normal . Weitere Informationen finden Sie unter Fügen Sie einen neuen Change-Anforderungstyp hinzu . Hinweis: Es wird weder das Change-Modell ( chg_model) Oder typeWert führt zu einer Standardeinstellung, die von Release zu Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge

Tabelle : 201. Anforderungstext-Parameter (JSON)

Name	Beschreibung
Objekt	Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um zum Beispiel die Datei „Kurzbeschreibung“ zu aktualisieren, geben Sie ein Name-Wert-Paar ein, das ähnlich ist wie das Folgende: --data "{\"short_description\": \"my short desc\" }" \. Dieselben Eigenschaften können stattdessen als Abfrageparameter festgelegt werden. Datentyp: Zeichenfolge
Object.chg_model	Name eines Change-Modells, das in der Tabelle „Change-Modell“ [chg_model] aufgeführt ist. Wird als Name-Wert-Paar im folgenden Format bereitgestellt: {"chg_model": "Cloud-Infrastruktur"} Weitere Informationen finden Sie unter Change-Modelle . Hinweis: Es wird weder das Change-Modell ( chg_model) Oder typeWert führt zu einer Standardeinstellung, die von Release zu Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge
Object.Encrypted_fields	Liste der kommagetrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt GlideRecord auf SetDisplayValue() Methode, anstatt aufzurufen SetValue() Methode. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für nicht verschlüsselte Felder wie Referenz- oder Auswahlfelder zu übergeben, anstatt sys_IDs oder Werte zu übergeben. Datentyp: Zeichenfolge
Objekt.Typ	Name des Change-Anforderungstyps, der in der Auswahltabelle [sys_choice] aufgeführt ist. Wenn chg_modelIst ebenfalls ausgefüllt, wird dieses Feld nur als Change-Kategorisierung verwendet. Wird als Name-Wert-Paar im folgenden Format bereitgestellt: {"type" : "Notfall"} Weitere Informationen finden Sie unter Fügen Sie einen neuen Change-Anforderungstyp hinzu . Hinweis: Es wird weder das Change-Modell ( chg_model) Oder typeWert führt zu einer Standardeinstellung, die von Release zu Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge

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 : 202. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 203. 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 : 204. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Ergebnis	Neuer Change-Anforderungsdatensatz. Die Elemente dieses Objekts entsprechen dem Datensatzformat in der Tabelle „Change-Anforderung“ [Change_Request]. Alle Werte, die nicht in der Anforderung angegeben sind, werden auf ihre Standardwerte festgelegt oder sind leer/null. Datentyp: Objekt

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie einen Change-Anforderungsdatensatz basierend auf dem Standard-Change-Modell und dem Standard-Typ erstellen. In diesem Beispiel wird die Change-Anforderung vom Modell gesteuert, und das Typfeld wird nur als Kategorisierung verwendet.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"chg_model\" : \"Standard\",
    \"description\" : \"Describes the change request.\",
    \"short_description\" : \"My change request\",
    \"type\" : \"Standard\"
}" \
--user "username":"password"

Die Ergebnisse zeigen, dass der Datensatz erfolgreich der Tabelle „Change-Anforderung“ [Change_Request] mit dem Wert hinzugefügt wurde CHG0030022 .

{
  "result": 
    "upon_reject": {
      "display_value": "Cancel all future Tasks",
      "value": "cancel"
    },
    "sys_updated_on": {
      "display_value": "2022-12-08 17:18:57",
      "value": "2022-12-09 01:18:57",
      "display_value_internal": "2022-12-08 17:18:57"
    },
    "type": {
      "display_value": "Standard",
      "value": "standard"
    }
    "number": {
      "display_value": "CHG0030022",
      "value": "CHG0030022"
    },
    "is_bulk": {
      "display_value": "false",
      "value": false
    }
    "ci_class": {
      "display_value": "cmdb_ci",
      "value": "cmdb_ci"
    },
    "state": {
      "display_value": "New",
      "value": -5
    },
    "sys_created_by": {
      "display_value": "admin",
      "value": "admin"
    },
    "knowledge": {
      "display_value": "false",
      "value": false
    },
    "phase": {
      "display_value": "Requested",
      "value": "requested"
    }
    "impact": {
      "display_value": "3 - Low",
      "value": 3
    },
    "active": {
      "display_value": "true",
      "value": true
    },
    "priority": {
      "display_value": "4 - Low",
      "value": 4
    },
    "sys_domain_path": {
      "display_value": "/",
      "value": "/"
    },
    "production_system": {
      "display_value": "false",
      "value": false
    },
    "requested_by": {
      "display_value": "System Administrator",
      "value": "6816f79cc0a8016401c5a33be04be441"
    }
    "short_description": {
      "display_value": "My change request",
      "value": "My change request"
    },
    "sys_class_name": {
      "display_value": "Change Request",
      "value": "change_request"
    },
    "reassignment_count": {
      "display_value": "0",
      "value": 0
    },
    "variables": {
      "display_value": "variable_pool",
      "value": "variable_pool"
    },
    "sla_due": {
      "display_value": "UNKNOWN",
      "value": "",
      "display_value_internal": ""
    },
    "escalation": {
      "display_value": "Normal",
      "value": 0
    },
    "upon_approval": {
      "display_value": "Proceed to Next Task",
      "value": "proceed"
    },
    "conflict_status": {
      "display_value": "Not Run",
      "value": "Not Run"
    },
    "task_effective_number": {
      "display_value": "CHG0030022",
      "value": "CHG0030022"
    },
    "sys_updated_by": {
      "display_value": "admin",
      "value": "admin"
    },
    "opened_by": {
      "display_value": "System Administrator",
      "value": "6816f79cc0a8016401c5a33be04be441"
    },
    "sys_created_on": {
      "display_value": "2022-12-08 17:18:57",
      "value": "2022-12-09 01:18:57",
      "display_value_internal": "2022-12-08 17:18:57"
    },
    "sys_domain": {
      "display_value": "global",
      "value": "global"
    },
    "chg_model": {
      "display_value": "Standard",
      "value": "e55d0bfec343101035ae3f52c1d3ae49"
    },
    "opened_at": {
      "display_value": "2022-12-08 17:18:57",
      "value": "2022-12-09 01:18:57",
      "display_value_internal": "2022-12-08 17:18:57"
    },
    "description": {
      "display_value": "Describes the change request.",
      "value": "Describes the change request."
    },
    "sys_id": {
      "display_value": "2ac52dd77c6b1510f877be3b096e64fe",
      "value": "2ac52dd77c6b1510f877be3b096e64fe"
    },
    "cab_required": {
      "display_value": "false",
      "value": false
    },
    "urgency": {
      "display_value": "3 - Low",
      "value": 3
    },
    "scope": {
      "display_value": "Medium",
      "value": 3
    },
    "activity_due": {
      "display_value": "UNKNOWN",
      "value": "",
      "display_value_internal": ""
    },
    "approval": {
      "display_value": "Not Yet Requested",
      "value": "not requested"
    },
  }
}

cURL-Anforderung

Das folgende Beispiel zeigt, wie verschlüsselte Felder im Anforderungstext übergeben werden.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"encrypted_fields\":\"short_description,description\",
    \"short_description\":\"my short desc\",
    \"description\":\"my desc\"
}" \
--user "username":"password"

cURL-Anforderung

Das folgende Beispiel zeigt, wie verschlüsselte Felder als Abfrageparameter übergeben werden.

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"

Change-Management – POST /sn_chg_Rest/Change/{sys_ID}/ci

Erstellt die Zuordnung zwischen einer Change-Anforderung und Configuration Management Database (CMDB) Konfigurationselemente (CI).

Die Erstellung der Zuordnung erfolgt asynchron, was bedeutet, dass sofort eine Antwort bereitgestellt wird und Details für den Mitarbeiter enthält. Der Mitarbeiter erledigt die tatsächliche Arbeit nach der Antwort.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/ci

Standard-URL: /api/sn_chg_Rest/Change/{sys_ID}/ci

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 : 205. 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
sys_id	SYS_ID der Change-Anforderung, die dem CMDB-CI zugeordnet werden soll. Datentyp: Zeichenfolge

Tabelle : 206. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 207. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
association_type	Erforderlich. Typ der Zuordnung zwischen dem CMDB-CI und der Change-Anforderung. Gültige Werte: Betroffen: CIs, die von der Change-Anforderung betroffen sind Betroffen: Services, die von der Change-Anforderung betroffen sind Angebot: Betroffene Serviceangebote Datentyp: Zeichenfolge
cmdb_ci_sys_IDs	Erforderlich. Liste der CMDB-CI-sys_IDs, die der Change-Anforderung zugeordnet werden sollen. Datentyp: Array oder kommagetrennte Zeichenfolge
REFRESH_Impact_Services	Kennzeichnung verwendet, wenn association_type=betroffen Zum Ausfüllen betroffener Services basierend auf der Liste der betroffenen CIs. Gültige Werte: Wahr: Füllen Sie die betroffenen Services basierend auf der Liste der betroffenen CIs aus Falsch: Betroffene Services nicht automatisch ausfüllen Datentyp: Boolesch Standardwert: false

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 : 208. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 209. 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 : 210. Statuscodes

Statuscode	Beschreibung
202	Akzeptiert. Die Anforderung wurde zur Verarbeitung akzeptiert.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Die Fehlerantwort enthält relevante Nachrichten, die bei der Behebung des Problems helfen.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Nachrichten	Nachrichteninformationen. Datentyp: Objekt "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
Nachrichten.FehlerNachrichten	Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben Datentyp: Array
messages.infoMessages	Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Zum Beispiel: CMDB_CI sys_ID ist bereits angegeben zugeordnet. Datentyp: Array
Nachrichten.WarnungsNachrichten	Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben. Datentyp: Array
Anforderung	Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge
Status	Informationen zum aktuellen Status des Mitarbeiters. state: { display_value: "String", value: "String" }
status.Display_value	Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueElement. Mögliche Werte: Abschließen Fehler In Bearbeitung Warten Datentyp: Zeichenfolge
status.Wert	Numerischer Wert des Status des Mitarbeiters. Mögliche Werte: 1 2 3 4 Datentyp: Zahl
type	Typ der Zuordnung zwischen dem CMDB-CI und der Change-Anforderung. Datentyp: Zeichenfolge
Mitarbeiter	Informationen zum zugehörigen Mitarbeiter. Datentyp: Objekt "worker": { "link": "String", "sysId": "String" }
Worker.Link	URL zum Abrufen des Status des zugeordneten Mitarbeiters und anderer relevanter Mitarbeiterinformationen. Datentyp: Zeichenfolge
Worker.sysId	SYS_ID des Mitarbeiters, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{cmdb_ci_sys_ids:'caf043a3b7fb23000999e4f6ee11a9c0,06f043a3b7fb23000999e4f6ee11a9c1', association_type:'affected'}" \
--user "username":"password"

{
  "result": {
    "worker": {
      "sysId": "f490f4c6dbac330084f07ffdbf961952",
      "link": "instance.service-now.com/api/sn_chg_rest/change/worker/f490f4c6dbac330084f07ffdbf961952"
    },
    "request": "{\"cmdb_ci_sys_ids\":[\"caf043a3b7fb23000999e4f6ee11a9c0\",\"06f043a3b7fb23000999e4f6ee11a9c1\"],\"association_type\":\"affected\",\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
    "state": {
      "value": 1,
      "display_value": "Waiting"
    },
    "type": "affected",
    "messages": {
      "errorMessages": [],
      "warningMessages": [],
      "infoMessages": []
    }
  }
}

Change-Management – POST /sn_chg_Rest/Change/{sys_ID}/Konflikt

Startet einen Change Request-Konflikt-Überprüfungsprozess für den angegebene Change Request (sys_id).

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/Konflikt

Standard-URL: /api/sn_chg_rest/change/{sys_id}/conflict

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 : 211. 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
sys_id	SYS_ID der Change-Management-Anforderung, für die der Konfliktprüfungsprozess gestartet werden soll. Weitere Informationen zum Konfliktprüfungsprozess finden Sie unter Konflikterkennung . Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 212. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 213. Anforderungstextparameter (XML oder JSON)

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 : 214. Anforderungskopfzeilen

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

Tabelle : 215. 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 : 216. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Die Anforderung konnte aufgrund nicht behebbarer Fehler nicht gestartet werden. Die zurückgegebene Nachricht enthält möglicherweise weitere Details.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Ergebnis	SYS_ID des Prozesses zur Konfliktprüfung für Change-Anforderungen. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
    result: "c0b5afe4b710230096c3e4f6ee11a93f"
}

Change-Management – NACH /sn_chg_Rest/Change/Emergency

Erstellt einen Notfall-Change Request basierend auf dem standardmäßigen Notfall-Change Request-Datensatz. Mehrere Notfall-Change Request-Erstellungen innerhalb eines einzelnen Anrufs werden nicht unterstützt.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Emergency

Standard-URL: /api/sn_chg_rest/change/emergency

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 : 217. 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

Tabelle : 218. Abfrageparameter

Name

Beschreibung

Schlüssel-Wert-Paare

Schlüssel-Wert-Paare von Feldern, die beim Erstellen der Anforderung geändert werden sollen. Der Schlüssel ist der Feldname in der Vorlage und der Wert die Informationen, die in das Feld eingefügt werden sollen. Felder, die nicht geändert werden können und bei der Übergabe ignoriert werden: Business-Regeln Schreibgeschützte Felder wie in ACLs definiert Felder, die nicht vorhanden sind Datentyp: Zeichenfolge

Tabelle : 219. Anforderungstextparameter (XML oder JSON)

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 : 220. Anforderungskopfzeilen

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

Tabelle : 221. 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 : 222. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare der Felder, die in der Notfall-Change-Anforderung erstellt wurden. Datentyp: Objekt
Status	Status des Change Requests vor dem Löschen. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Wert ist immer „Neu“. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Wert ist immer „-5“. Datentyp: Zeichenfolge
sys_id	SYS_ID der neu erstellten Notfall-Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge
__Meta.ignoredFelder	Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?no_such_field=something&description=test&short_description=Reboot server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "emergency",
        display_value: "Emergency"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Reboot server",
        display_value: "Reboot server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Change-Management – POST /sn_chg_Rest/Change/normal

Erstellt einen normalen Change Request basierend auf dem standardmäßigen normalen Change Request-Datensatz. Mehrere normale Change Request-Erstellungen innerhalb eines einzelnen Anrufs werden nicht unterstützt.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/normal

Standard-URL: /api/sn_chg_rest/change/normal

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 : 223. 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

Tabelle : 224. Abfrageparameter

Name	Beschreibung
Schlüssel-Wert-Paare	Felder, die beim Erstellen des Requests zu modifizieren sind. Der Schlüssel ist der Feldname in der Vorlage und der Wert die Informationen, die in das Feld eingefügt werden sollen. Felder, die nicht geändert werden können und bei der Übergabe ignoriert werden: Business-Regeln Schreibgeschützte Felder wie in ACLs definiert Felder, die nicht vorhanden sind Datentyp: Zeichenfolge

Tabelle : 225. Anforderungstextparameter (XML oder JSON)

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 : 226. Anforderungskopfzeilen

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

Tabelle : 227. 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 : 228. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Werte für alle Felder im zugehörigen Change Request. Datentyp: Objekt
Status	Status des neu erstellten Change Requests. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Status, der in einer UI angezeigt werden soll. Wert ist immer „Neu“. Datentyp: Zeichenfolge
status.Wert	Interner Statuswert. Wert ist immer „-5“. Datentyp: Zeichenfolge
sys_id	SYS_ID der neu erstellten normalen Change-Anforderung. Datentyp: Zeichenfolge
type	Typ der Change-Anforderung. Datentyp: Objekt type: { display_value: "String", value: "String" }
Typ.Display_value	Change-Typ, der in einer UI angezeigt werden soll. Wert ist immer „Normal“. Datentyp: Zeichenfolge
Typ.Wert	Interner Typwert. Wert ist immer „Normal“. Datentyp: Zeichenfolge
__Meta.ignoredFelder	Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?no_such_field=something&description=test&short_description=Remove server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
      state: {
        value: "-5", 
        display_value: "New"
      },
      type: {
        value: "normal",
        display_value: "Normal"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Remove server",
        display_value: "Remove server"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Change-Management – POST /sn_chg_Rest/Change/{sys_ID}/refresh_Impact_Services

Füllt die zugehörige Liste „Betroffene Services/Konfigurationselemente (CIs)“ basierend auf dem primären CI aus.

Das primäre CI wird im Formular „Change-Anforderung“ und der zugehörigen Liste „Betroffene CI“ angezeigt.

Hinweis:

Alle Arbeitselemente für diesen Endpunkt werden asynchron ausgeführt.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/refresh_Impact_Services

Standard-URL: /api/sn_chg_Rest/Change/{sys_ID}/refresh_Impact_Services

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 : 229. 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
sys_id	SYS_ID der Change-Anforderung, die zum Aktualisieren der betroffenen Services verwendet werden soll. Datentyp: Zeichenfolge

Tabelle : 230. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 231. Anforderungstextparameter (XML oder JSON)

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 : 232. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 233. 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 : 234. Statuscodes

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

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Nachrichten	Nachrichteninformationen. Datentyp: Objekt "messages": { "errorMessages": [Array], "infoMessages": [Array], "warningMessages": [Array] }
Nachrichten.FehlerNachrichten	Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben Datentyp: Array
messages.infoMessages	Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Zum Beispiel: CMDB_CI sys_ID ist bereits angegeben zugeordnet. Datentyp: Array
Nachrichten.WarnungsNachrichten	Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben. Datentyp: Array
Anforderung	Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge
Status	Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt state: { display_value: "String", value: "String" }
status.Display_value	Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueElement. Mögliche Werte: Abschließen Fehler In Bearbeitung Warten Datentyp: Zeichenfolge
status.Wert	Numerischer Wert des Status des Mitarbeiters. Mögliche Werte: 1 2 3 4 Datentyp: Zahl
type	Typ der Zuordnung zwischen dem CMDB-CI und der Change-Anforderung. Datentyp: Zeichenfolge
Mitarbeiter	Informationen zum zugehörigen Mitarbeiter. Datentyp: Objekt "worker": { "link": "String", "sysId": "String" }
Worker.Link	URL zum Abrufen des Status des zugeordneten Mitarbeiters und anderer relevanter Mitarbeiterinformationen. Datentyp: Zeichenfolge
Worker.sysId	SYS_ID des Mitarbeiters, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge

cURL-Anforderung

curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/refresh_impacted_services" \ 
--request POST \ 
--header "Accept:application/json" \
--header "Content-Type:application/json" \ 
--user "username":"password"

{ 
  result: { 
    worker: { 
      sysId: "aa31c308b75033000999e4f6ee11a9c2", 
      link: "http://instance.service-now.com/api/sn_chg_rest/change/worker/aa31c308b75033000999e4f6ee11a9c2" 
    }, 
    request: "", 
    state: { 
      value: 1, 
      display_value: "Waiting" 
    }, 
    type: "impacted", 
    messages: { 
      errorMessages: [], 
      warningMessages: [], 
      infoMessages: [] 
    } 
  } 
} 

Change-Management – POST /sn_chg_Rest/Change/Standard/{Standard_Change_template_ID}

Erstellt einen Standard-Change Request basierend auf einer vorhandenen Standard-Change-Vorlage, wie von der übergebenen Vorlagen-sys_id angegeben. Mehrere Standard-Change Request-Erstellungen innerhalb eines einzelnen Aufrufs werden nicht unterstützt.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Standard/{Standard_Change_template_ID}

Standard-URL: /api/sn_chg_rest/change/standard/{standard_change_template_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 : 235. Pfad-Parameter

Parameter	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
Standard_Change_template_ID	SYS_ID der Standard-Change-Vorlage, auf der die neue Standard-Change-Anforderung basieren soll. Datentyp: Zeichenfolge Tabelle: Standard-Change-Vorlage [Std_Change_Record_Producer]

Tabelle : 236. Abfrageparameter

Parameter

Beschreibung

Name-Wert-Paare

Felder innerhalb der angegebenen Standard-Change-Vorlage, die beim Erstellen des Requests geändert werden sollen. Der Schlüssel ist der Feldname in der Vorlage und der Wert die Informationen, die in das Feld eingefügt werden sollen. Felder, die nicht geändert werden können und bei der Übergabe ignoriert werden: Beschreibung Rückfallplan Testplan Implementierungsplan Schreibgeschützte Felder wie in ACLs definiert Felder, die in der angegebenen Standard-Change-Vorlage nicht vorhanden sind Datentyp: Zeichenfolge

Tabelle : 237. Anforderungstextparameter (XML oder JSON)

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 : 238. Anforderungskopfzeilen

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

Tabelle : 239. Antwortkopfzeilen

Kopfzeile	Beschreibung
Keine

Statuscodes

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 : 240. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antwort-Haupttext

Die API gibt diese JSON- oder XML-Elemente im Antwort-Haupttext zurück.

Tabelle : 241. Im Antwort-Haupttext zurückgegebene Elemente

Elemente	Beschreibung
Name-Wert-Paare	Name-Wert-Paare der Felder, die in der Standard-Change-Anforderung erstellt wurden. Datentyp: Objekt
sys_id	SYS_ID-Informationen der neu erstellten Standard-Change-Anforderung. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Standard-Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Standard-Change-Anforderung. Datentyp: Zeichenfolge
__Meta.ignoredFelder	Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array

Beispiel für eine cURL-Anforderung

curl "https://instance.servicenow.com" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "1c87925347c12200e0ef563dbb9a7177",
        display_value: "1c87925347c12200e0ef563dbb9a7177"
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Add network switch to cabinet",
        display_value: "Add network switch to cabinet"
      }
      __meta: {
        ignoredFields: ["no_such_field"]
      }
    }
  ]
}

Change-Management – NACH /sn_chg_Rest/Change/{Change_sys_ID}/Aufgabe

Erstellt eine Change Request-Aufgabe basierend auf der Standard-Change Request-Aufgabe und ordnet diese dem angegebenen Change Request zu. Mehrere Change Request-Aufgaben-Erstellungen innerhalb eines einzelnen Anrufs werden nicht unterstützt.

URL-Format

Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/Task

Standard-URL: /api/sn_chg_rest/change/{change_sys_id}/task

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 : 242. 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
change_sys_id	SYS_ID der Change-Anforderung, der diese Aufgabe zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request]

Tabelle : 243. Abfrageparameter

Name	Beschreibung
Schlüssel-Wert-Paare	Felder, die beim Erstellen des Requests zu modifizieren sind. Der Schlüssel ist der Feldname in der Vorlage und der Wert die Informationen, die in das Feld eingefügt werden sollen. Felder, die nicht geändert werden können und bei der Übergabe ignoriert werden: Business-Regeln Schreibgeschützte Felder wie in ACLs definiert Felder, die nicht vorhanden sind Datentyp: Zeichenfolge

Tabelle : 244. Anforderungstextparameter (XML oder JSON)

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 : 245. Anforderungskopfzeilen

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

Tabelle : 246. 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 : 247. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
404	Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
500	Interner Serverfehler. Im serverseitigen Code ein logischer Fehler aufgetreten.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Name-Wert-Paare	Name-Wert-Paare der Felder, die in der Change-Anforderungsaufgabe erstellt wurden. Datentyp: Objekt
übergeordnet	Informationen für die Change-Anforderung, die der Aufgabe zugeordnet ist. Datentyp: Objekt parent: { display_value: "String", value: "String" }
Parent.Display_value	Informationen, die in der Anwenderoberfläche für die Change-Anforderung angezeigt werden sollen, die der Aufgabe zugeordnet ist. Datentyp: Zeichenfolge
Übergeordnetes Element.Wert	SYS_ID der Change-Anforderung, die der Aufgabe zugeordnet ist. Datentyp: Zeichenfolge
sys_id	SYS_ID-Informationen der neu erstellten Change-Anforderungsaufgabe. Datentyp: Objekt sys_id: { display_value: "String", value: "String" }
sys_ID.Anzeigewert	SYS_ID der Change-Anforderungsaufgabe, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge
sys_ID.Wert	SYS_ID der Change-Anforderungsaufgabe. Datentyp: Zeichenfolge
__Meta.ignoredFelder	Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array

cURL-Anforderung

curl "https://instance.servicenow.com/api/now/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?short_description=Retire node&no_such_field=test" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"

{
  result: [
    {
      sys_id: {
        value: "12629ec4b750230096c3e4f6ee11a9d5",
        display_value: "12629ec4b750230096c3e4f6ee11a9d5"
      },
      parent: {
        value: "0f4ac6c4b750230096c3e4f6ee11a9fe ", 
        display_value: "CHG0033046 "
      },
      ..., // all valid fields in record, example below
      short_description: {
        value: "Retire node",
        display_value: "Retire node"
      }
      __meta.ignoredFields": ["no_such_field"]
    }
  ]
}