Change-Verwaltungs-API
Die Change Management- API bietet Endpunkte, die die Integration von Drittanbieteranwendungen mit dem ServiceNow Change-Management -Prozess ermöglichen.
Verwenden Sie diese REST-API, um Ihren Change-Management-Prozess in externe Anwendungen zu integrieren und ServiceNow clientseitige Anwendungen zu entwickeln.
Mit dieser REST-API können Integratoren:
- Initiieren Sie eine Standard-Change-Anforderung aus einer veröffentlichten Vorlage für Standard-Change-Anforderungen.
- Erstellen Sie eine Change-Anforderung vom Typ „Notfall“ oder „Normal“.
- Aktualisieren Sie ein beliebiges Feld, das in der Change-Anforderungstabelle für eine beliebige Change-Anforderung vorhanden ist.
- Aktualisieren Sie alle Felder, die in der Change-Aufgabentabelle vorhanden sind, und bearbeiten Sie Aufgaben 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 mithilfe der Paginierung mehrere Change-Anforderungen, Standardvorlagen und Change-Anforderungsaufgaben ab.
- Führen Sie eine Risikobewertung durch.
- Aktualisieren Sie betroffene Services.
- Generieren und verarbeiten Sie alle zugehörigen Genehmigungsaktivitäten, die mit einer Change-Anforderung verknüpft sind.
- Identifizieren Sie potenzielle Planungskonflikte und Zeiträume, in denen keine Konflikte bestehen.
- 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 den angegebenen Change Request ab, einschließlich des aktuellen Status.
- Herkömmliche ITIL-Typen: Standard, Notfall und Normal
- Change-Modell-Status: Neu, Geplant, Implementieren, Überprüfen und Geschlossen.
Sie können zusätzliche Change-Modelle in Ihrer Instanz ServiceNow konfigurieren und dann Change-Anforderungen basierend auf diesen Change-Modellen mithilfe von Endpunkten in dieser API erstellen. Verwenden Sie die Endpunkte Change Management – GET /sn_chg_rest/change/model/{sys_id} und Change Management – GET /sn_chg_rest/change/model, um die verfügbaren Change-Modelle in einer Instanz abzurufen. Verwenden Sie dann Change Management – POST /sn_chg_rest/change, um eine Change-Anforderung basierend auf einem angegebenen Change-Modell zu erstellen.
Weitere Informationen zum Konfigurieren von Change-Modellen finden Sie unter Change Management konfigurieren.
- 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 – DELETE /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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | Sys_id des Change Request, dem die Aufgabe zugeordnet ist. Befindet sich in der Change Request-Tabelle [change_request]. Überprüft, dass die Aufgabe tatsächlich dem angegebenen Change Request zugeordnet ist. Datentyp: Zeichenfolge |
| task_sys_id | Sys_id der zu löschenden Change Request-Aufgabe. Befindet sich in der Tabelle „Change-Aufgaben“ [change_task]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 den Change Request, dem diese Aufgabe zugeordnet wurde. Datentyp: Objekt |
| parent.display_value | Sys_id der übergeordneten Aufgabe, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| parent.value | Sys_id der übergeordneten Aufgabe. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen für den gelöschten Change Request. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | 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 – DELETE /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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des zu löschenden Change Request-Datensatzes. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Change-Anforderungsdatensatz, der gelöscht wurde. Jedes Element in diesem Objekt entspricht einem Feld im Datensatz der Change Request-Tabelle [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 – /sn_chg_rest/change/{sys_id}/conflict löschen
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}/conflict
Standard-URL: /api/sn_chg_rest/change/{sys_id}/conflict
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Change-Anforderungsdatensatzes, für den der laufende Konflikt-Überprüfungsprozess abgebrochen werden soll. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 – DELETE /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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des zu löschenden Notfall-Change Requests. Befindet sich in der Change Request-Tabelle [change_request]. |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in der Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen für den Change Request. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| type.value | 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 – DELETE /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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des normalen zu löschenden Change Requests in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in der Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in der Benutzeroberfläche angezeigt werden soll. Wert ist immer „Normal“. Datentyp: Zeichenfolge |
| type.value | 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 – DELETE /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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des zu löschenden Standard-Change Requests. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in der Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | 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 einer Option zum Einbeziehen der geplanten Startzeit.
Erforderliche Rolle: sn_change_writer.
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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| cmdb_ci_sys_id | Sys_id eines Datensatzes in der Tabelle „Konfigurationselemente“ [cmdb_ci]. Dieser Endpunkt erfordert keine Change-Anforderung. |
| Name | Beschreibung |
|---|---|
| duration_in_seconds | Dauer des Change in Sekunden, d. h. wie lange es dauert, bis die Change-Anforderungsaufgabe abgeschlossen ist. Datentyp: Ganzzahl |
| geplante_start_zeit | Optional. Zeitpunkt (Datum und Uhrzeit), zu dem die Change-Anforderung mit der Implementierung in UTC beginnen soll. Rufen Sie das verfügbare Zeitfenster ab, das zu diesem Zeitpunkt oder später beginnt. Wenn nicht angegeben, verwendet das System die aktuelle Uhrzeit als Startzeit. Zeitformat: jjjj-mm-tt hh:mm:ss Datentyp: Zeichenfolge |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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:
|
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Fehler | Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.FehlerNachrichten | Fehlermeldungen, die beim Verarbeiten der Anforderung aufgetreten sind. Datentyp: Array |
| message.infoMessages | Während der Verarbeitung der Anforderung aufgetretene Informationsmeldungen. Datentyp: Array |
| message.warningMessages | Während der Verarbeitung der Anforderung aufgetretene Warnmeldungen. Datentyp: Array |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt |
| state.display_value | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit dem Parameter state.value. Mögliche Werte:
Datentyp: Zeichenfolge |
| state.value | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| type | Gibt den Typ der Anforderung an. Gültiger Wert: schedule Datentyp: Zeichenfolge |
| Mitarbeiter | Informationen zum zugeordneten Mitarbeiter. Datentyp: Objekt |
| worker.link | Link zum Abrufen von Zeitfensterdaten. Verwenden Sie die sys_id in GET /sn_chg_rest/change/worker/{sys_id}, um die Ergebnisse anzuzeigen. Datentyp: Zeichenfolge |
| worker.sysId | Sys_id des Mitarbeiters, der dem Change Request 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 worker.link angegebenen Wert, um 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 worker_sys_id in GET /sn_chg_rest/change/worker/{sys_id}, um die Ergebnisse anzuzeigen.
Der Antworttext enthält den Status und liefert Ergebnisse, wenn die Verarbeitung abgeschlossen ist.
- Wenn das angegebene Zeitfenster für die Change-Anforderung innerhalb des Zeitplanzeitfensters verfügbar ist, listet die Worker-API die verfügbaren Zeitfenster in der Eigenschaft payload.spans auf. Die Eigenschaft payload.spans wird andernfalls nicht in den Ergebnissen aufgeführt.
- Wenn keine Zeitfenster für die Dauer der Change-Anforderung innerhalb des definierten Planungszeitfensters verfügbar sind, gibt messages.infoMessages Folgendes an:
DHinweis:Der Standardwert für das Change Request-Zeitfenster beträgt 90 Tage. Um diesen Wert zu ändern, ändern Sie die Eigenschaft change.conflict.next_available.schedule_window. Weitere Informationen finden Sie unter Konfliktanalyseeigenschaften konfigurieren.
Das folgende GET /sn_chg_rest/change/worker/{sys_id}-Beispiel zeigt die Ausgabe, die mit der im worker.link-Detail angegebenen ID bereitgestellt wird. In der Ergebnisliste werden offene Zeitspannen angezeigt, 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" Die Ergebnisse enthalten worker.link-Details, die Sie zum Ausführen der angegebenen sys_id im GET /sn_chg_rest/change/worker/-Endpunkt verwenden können.
{
"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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| 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 Datentyp: Zahl Standard: 0 |
| sysparm_query | Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet wird. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>.
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:
Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln Syntax:
Beispiel: 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 |
| textSearch | Zeichenfolge, die zum Durchsuchen aller normalen Change Request-Datensatzfelder verwendet wird. Diese Suche verwendet die Volltextsuchplattform-Funktionalität von ServiceNow. Weitere Informationen zu den Suchfunktionen von ServiceNow finden Sie unter Verwaltung der Suche. Standard: IR_AND_OR_QUERY |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Elemente | Beschreibung |
|---|---|
| Ergebnis | Liste mit einem oder mehreren Change Request-Datensatzobjekten. Jedes Objekt beschreibt eine Change-Anforderung. Jedes Element im Change Request-Objekt entspricht einem Feld in seinem zugeordneten Datensatz in der Change Request-Tabelle [change_request]. Alle Elemente enthalten Name-Wert-Paare Wert und display_value. Datumsfelder enthalten auch Name-Wert-Paare vom Typ display_value_internal. Datentyp: Array |
| action_status | Aktueller Aktionsstatus der zugeordneten Change-Anforderung. Mögliche Werte:
Datentyp: Zahl |
| aktiv | Kennzeichnung, die angibt, ob die Change-Anforderung aktiv ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: true |
| activity_due | Datum und Uhrzeit, zu der der zugeordnete Fall voraussichtlich abgeschlossen sein wird. Datentyp: Zeichenfolge |
| Additional_assignee_list | Liste der sys_ids zusätzlicher Personen, die zur Bearbeitung 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 zugeordneten Aktion. Datentyp: Zeichenfolge |
| assigned_to | Sys_id des Benutzers, der dem Change Request zugewiesen ist. Datentyp: Zeichenfolge |
| assignment_group | Sys_id der Gruppe, die dem Change Request zugewiesen ist. Datentyp: Zeichenfolge |
| backout_plan | Beschreibung des Plans, der ausgeführt werden soll, wenn der Change rückgängig gemacht werden muss. Datentyp: Zeichenfolge |
| business_duration | Dauer in geplanten Arbeitsstunden, Arbeitstagen und Arbeitswochen, die bis zum Abschluss des Change benötigt wurden. Datentyp: Zeichenfolge |
| business_service | Sys_id des Business Service, der dem Change Request zugeordnet ist. Befindet sich in der Tabelle „Service“ [cmdb_ci_service]. Datentyp: Zeichenfolge |
| CAB-Datum | Datum, an dem das Change Advisory Board (CAB) zusammentritt. Datentyp: Zeichenfolge |
| cab_delegate | Sys_id des Benutzers, der den CAB-Manager während eines CAB-Meetings vertreten kann. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| cab_recommendation | Beschreibung der CAB-Empfehlungen für den Change Request. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| cab_erforderlich | Kennzeichnung, die angibt, ob die CAB erforderlich ist. Mögliche Werte:
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: Sonstige |
| change_plan | Aktivitäten und Rollen für die Verwaltung und Steuerung von Change-Anforderungen. Datentyp: Zeichenfolge |
| chg_model | Sys_id des Change-Modells, auf dem die zugeordnete Change-Anforderung basiert. Befindet sich in der Tabelle „Change-Modell“ [chg_model]. Das Change-Modell definiert den Statusfluss, die Übergänge und die Prozessaktivitäten, die für die Change-Anforderung abgeschlossen werden müssen. Datentyp: Zeichenfolge |
| closed_at | Datum und Uhrzeit, zu der die zugeordnete Change-Anforderung geschlossen wurde. Datentyp: Zeichenfolge |
| closed_by | Sys_id der Person, die die Change-Anforderung geschlossen hat. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| close_code | Code, der dem Change Request zugewiesen wurde, als er geschlossen wurde. Beispiele: Erfolgreich, Erfolgreich mit Problemen und Nicht erfolgreich. Datentyp: Zeichenfolge |
| close_notes | Notizen, die die Person beim Schließen der Change-Anforderung eingegeben hat. Datentyp: Zeichenfolge |
| cmdb_ci | Sys_id des Konfigurationselements, das dem Change Request zugeordnet ist. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| Kommentare | Liste der Arbeitsnotizen für Kunden, die in die zugehörige Change-Anforderung eingegeben wurden. Datentyp: Array |
| Kommentare_und_Arbeitsnotizen | 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 dem Change Request zugeordnet ist. Befindet sich in der Tabelle „Unternehmen“ [core_company]. Datentyp: Zeichenfolge |
| konflikt_last_run | Datum und Uhrzeit der letzten Ausführung des Konflikterkennungsskripts für die Change-Anforderung. Datentyp: Zeichenfolge |
| konflikt_status | Aktueller Konfliktstatus, wie vom Konflikterkennungsskript erkannt, z. B. Konflikt und Nicht ausgeführt. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Nicht ausgeführt |
| contact_type | Methode, in der die Change-Anforderung ursprünglich angefordert wurde. Mögliche Werte:
Datentyp: Zeichenfolge |
| contract | Sys_id des Vertrags, der der Change-Anforderung zugeordnet ist. Befindet sich in der Tabelle „Vertrag“ [ast_contract]. Datentyp: Zeichenfolge |
| korrelation_display | Benutzerfreundlicher Name für correlation_id. Datentyp: Zeichenfolge Maximale Länge: 100 |
| correlation_id | Global eindeutige ID (GUID) eines übereinstimmenden Change-Anforderungsdatensatzes in einem Drittanbietersystem. Datentyp: Zeichenfolge Maximale Länge: 100 |
| Delivery_plan | Wird nicht mehr verwendet. Sys_id des Bereitstellungsplans, der der Change-Anforderung zugeordnet ist. Befindet sich in der Tabelle „Ausführungsplan“ [sc_cat_item_delivery_plan]. Datentyp: Zeichenfolge |
| Delivery_task | Wird nicht mehr verwendet. Sys_id der Bereitstellungsaufgabe, die der Change-Anforderung zugeordnet ist. Befindet sich in der Tabelle „Ausführungsplanaufgabe“ [sc_cat_item_delivery_task]. Datentyp: Zeichenfolge |
| Beschreibung | Detaillierte Beschreibung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| due_date | Fälligkeitsdatum der Aufgabe. Wird nicht vom Change-Anforderungsprozess verwendet. Datentyp: Zeichenfolge |
| end_date | Datum und Uhrzeit, zu der die Change-Anforderung abgeschlossen werden soll. Datentyp: Zeichenfolge |
| Eskalation | Aktuelle Eskalationsebene. Mögliche Werte:
Datentyp: Zahl (Integer) Standard: 0 |
| expected_start | Datum und Uhrzeit, zu der die Aufgabe beginnen soll. Wird nicht vom Change-Anforderungsprozess verwendet. Datentyp: Zeichenfolge |
| follow_up | Datum und Uhrzeit der Nachverfolgung eines Benutzers bei der Person, die die Change-Anforderung anfordert. Datentyp: Zeichenfolge |
| group_list | Liste der sys_ids und Namen der Gruppen, die dem Change Request zugeordnet sind. Datentyp: Array Maximale Länge: 4.000 |
| impact | Auswirkung der Change-Anforderung auf den Kunden. Mögliche Werte:
Datentyp: Zahl (Integer) Standard: 3 |
| „implementierung_plan“. | Sequenzielle Schritte, die ausgeführt werden sollen, um diesen Change zu implementieren. Sie enthält auch alle Abhängigkeiten zwischen Schritten und Beauftragtendetails für jeden Schritt. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Begründung | Vorteile der Implementierung dieses Change und die Auswirkungen, wenn dieser Change nicht implementiert wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Wissen | Kennzeichnung, die angibt, ob dem Change Request Knowledge Base-Artikel ()KB) zugeordnet sind. Mögliche Werte:
Datentyp: Boolesch |
| location | Sys_id und Name des Standorts der Ausrüstung, auf die in der Change-Anforderung verwiesen wird. Befindet sich in der Tabelle „Standort im Standort“ [cmn_location]. Datentyp: Zeichenfolge |
| hergestellt_sla | Wird nicht mehr verwendet. Kennzeichnung, die angibt, ob die Change-Anforderung in Übereinstimmung mit der zugehörigen Servicelevel-Vereinbarung implementiert wurde. Datentyp: Boolesch |
| Bedarf_Aufmerksam | Kennzeichnung, die angibt, ob die Change-Anforderung Aufmerksamkeit erfordert. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Nummer | Change-Nummer, die dem Change Request vom System zugewiesen wurde, z. B. CHG0040007. Datentyp: Zeichenfolge |
| on_hold | Kennzeichnung, die angibt, ob der Change Request derzeit angehalten ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| on_hold_reason | Wenn der Parameter on_hold „wahr“ ist, Beschreibung des Grunds, warum die Change-Anforderung zurückgehalten wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| on_hold_task | Wenn der Parameter on_hold auf „wahr“ festgelegt ist, Liste der sys_ids der Aufgaben, die abgeschlossen sein müssen, bevor die Warteschleife freigegeben wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| opened_at | Datum und Uhrzeit der Erstellung des Change-Release. Datentyp: Zeichenfolge |
| opened_by | Sys_id und Name des Benutzers, der das Change-Release erstellt hat. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| 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 (Integer) |
| outside_maintenance_schedule | Kennzeichnung, die angibt, ob die Wartung durch ein externes Unternehmen für die Change-Anforderung geplant wurde. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| übergeordnet | Sys_id und Name der übergeordneten Aufgabe zu diesem Change Request, falls vorhanden. Befindet sich in der Aufgabentabelle [Aufgabe]. Datentyp: Zeichenfolge |
| phase | Aktuelle Phase der Change-Anforderung. Dies definiert, was der Change im Detail tut. Mögliche Werte:
Datentyp: Zeichenfolge |
| Phase_state | Change_phase-Datensätze, die für einen Change erstellt werden sollen. Sie sind von der Kategorie abhängig, sodass jede Art von Change unterschiedliche change_phase-Datensätze haben kann. Die change_phase-Datensätze bieten die Möglichkeit, den Genehmigungsprozess zu steuern, da jede change_phase einen Zeitplan und eine Reihe von Genehmigern haben kann. Mögliche Werte:
Datentyp: Zeichenfolge |
| Priorität | Priorität der Change-Anforderung. Mögliche Werte:
Datentyp: Zahl (Integer) Standard: 4 |
| „production_system“ | Kennzeichnung, die angibt, ob die Change-Anforderung für eine ServiceNow -Instanz in einer Produktionsumgebung gilt. Mögliche Werte:
Datentyp: Boolesch |
| Grund | Beschreibung, warum die Change-Anforderung initiiert wurde. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 |
| reassignment_count | Anzahl, die angibt, wie oft die Change-Anforderung einem neuen Besitzer zugewiesen wurde. Datentyp: Zahl (Integer) Standard: 0 |
| Ablehnung_goto | Sys_id der Aufgabe, die ausgeführt werden soll, wenn die Change-Anforderung abgelehnt wird. Befindet sich in der Aufgabentabelle [table]. Datentyp: Zeichenfolge |
| angefordert_by | Sys_id des Benutzers, der den Change angefordert hat. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| „angefordert nach_Datum“. | Datum und Uhrzeit, zu der die Implementierung des Change durch angefordert wurde. 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 Überprüfung der angeforderten Change-Anforderung. Datentyp: Zeichenfolge |
| risk | Risikostufe, die der Change-Anforderung zugeordnet ist. Gültige Werte:
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, aus dem die Change-Anforderung übertragen wurde. Mögliche Werte:
Datentyp: Zahl |
| scope | Größe der Change-Anforderung. Mögliche Werte:
Datentyp: Zahl Standard: 3 |
| Service.Offering | Sys_id des Serviceangebots, das der Change-Anforderung zugeordnet ist. Serviceangebote definieren das Serviceniveau eindeutig in Bezug auf Verfügbarkeit, Umfang, Preisgestaltung und Paketoptionen. Befindet sich in der Angebotstabelle [service_offering]. Datentyp: Zeichenfolge |
| 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. Befindet sich in der Kompetenztabelle [cmn_skill]. Datentyp: Array |
| 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 beliebigen E-Signatur-Dokuments, das an die Change-Anforderung angehängt ist. Befindet sich in der Anhangtabelle [sys_attachment]. Datentyp: Zeichenfolge |
| sn_esign_esignature_configuration | Sys_id der E-Signatur-Signaturvorlage, die für das zugeordnete Dokument verwendet wird. Befindet sich in der Tabelle „E-Signatur-Vorlage“ [sn_esign_configuration]. Datentyp: Zeichenfolge |
| start_date | Zeitpunkt (Datum und Uhrzeit), zu dem die Change-Anforderung mit der Implementierung beginnen soll. Datentyp: Zeichenfolge |
| Status | Aktueller Status des Change Requests. Mögliche Werte sind im Change-Modell definiert. Datentyp: Zahl (Integer) Standard: 1 |
| std_change_producer_version | Sys_id des Datensatzerstellers und Change-Vorschlags, der dem Change Request zugeordnet ist. Enthält auch die Anzahl und den Prozentsatz erfolgreicher und nicht erfolgreicher Change-Anforderungen, die aus dem Vorschlag erstellt wurden. Befindet sich in der Tabelle „Standard-Change-Vorlagenversion“ [std_change_producer_version]. Datentyp: Zeichenfolge |
| sys_class_name | Name der Tabelle, in der sich der Change Request befindet. Datentyp: Zeichenfolge |
| sys_created_by | Name des Benutzers, 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 | Bei Verwendung von Domänen in der Instanz 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 Identifier des zugeordneten Change Request-Datensatzes. Datentyp: Zeichenfolge |
| sys_mod_count | Anzahl der Aktualisierungen des Falls seit seiner ursprünglichen Erstellung. Datentyp: Zahl (Integer) |
| 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_effektive_Nummer | Universal Request-Nummer. Datentyp: Zeichenfolge Maximale Länge: 40 |
| task_for | Nicht verwendet von Change-Management. Sys_id des Benutzers, für den die Aufgabe erstellt wurde. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| test_plan | Beschreibung des zugeordneten Testplans für den Change. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| time_worked | Gesamtbetrag der für die Change-Anforderung aufgewendeten Zeit. Datentyp: Zeichenfolge |
| type | Change-Anforderungstyp. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 |
| nicht autorisiert | Kennzeichnung, die angibt, ob die Change-Anforderung nicht autorisiert ist Mögliche Werte:
Datentyp: Boolesch |
| universal_request | Sys_id der übergeordneten universellen Anforderung, zu der diese Change-Anforderung gehört. Befindet sich in der Aufgabentabelle [Aufgabe]. Datentyp: Zeichenfolge |
| on_approval | Aktion, die ausgeführt werden soll, wenn die Change-Anforderung genehmigt wird. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fortfahren |
| on_reject | Aktion, die ausgeführt werden soll, wenn die Change-Anforderung abgelehnt wird. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Abbrechen |
| urgency | Dringlichkeit der Change-Anforderung. Mögliche Werte:
Datentyp: Zahl (Integer) Standard: 3 |
| Anwender_Eingabe | Zusätzliche Benutzereingabe. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| variables | Name-Wert-Paare von Variablen, die dem Change Request zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40 |
| uhr_liste | Liste der sys_ids der Benutzer, 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. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Array |
| wf_aktivität | Sys_id des Workflow-Aktivitätsdatensatzes, der dem Change Request zugeordnet ist. Befindet sich in der Workflow-Aktivitätstabelle [wf_aktivität]. Datentyp: Zeichenfolge |
| work_end | Datum und Uhrzeit, zu der die Arbeit an der Change-Anforderung beendet wurde. Datentyp: Zeichenfolge |
| work_notes | Informationen darüber, wie die Change-Anforderung gelöst werden kann, 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 Benutzer, die Benachrichtigungen zu dieser Change-Anforderung erhalten, wenn Arbeitsnotizen hinzugefügt werden. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Array |
| 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"
Der Kürze halber enthalten die Ergebnisse nur einen einzigen 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 den angegebenen Change Request ab, einschließlich des aktuellen Status.
Falls verfügbar, wird auch angegeben, wie basierend auf der Version des implementierten Change Managements in den nächsten Status übergegangen werden kann. Wenn die Änderungen durch Change-Modelle gesteuert werden, gibt der Endpunkt Bedingungen zurück, die erfüllt sind oder nicht. Sie enthält auch Informationen darüber, ob alle Bedingungen für einen bestimmten Übergang erfüllt wurden. Diese Informationen sind für typgesteuerte und ältere 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | Sys_id der Change-Anforderung. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| available_states | Werte für die Status, die für den angegebenen Change Request verfügbar sind, einschließlich des aktuellen Status. Datentyp: Array |
| state_label | Schlüssel-Wert-Paare, die den verfügbaren Status Bezeichnungen zuordnen. Datentyp: Objekt |
| state_transitions | Informationen darüber, was für den Übergang in jeden verfügbaren Status erforderlich ist. Jeder eindeutige verfügbare „Zu-Status“ befindet sich in einem eigenen -Array, wobei sich jeder unterschiedliche Satz von Bedingungen für diesen Zu-Status in einem eigenen Objekt befindet. Datentyp: Array |
| state_transitions.automatic_transition | Kennzeichnung, die angibt, ob automatisch in diesen Status übergegangen werden soll. Gültige Werte:
Datentyp: Boolesch |
| state_transitions.conditions | Liste der Bedingungen, die dem -Statuszugeordnet sind. Datentyp: Array von Objekten |
| state_transitions.conditions.condition | Werte einer bestimmten Bedingung. Datentyp: Objekt |
| 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.passed | Kennzeichnung, die angibt, ob die Change-Anforderung die zugehörige Bedingung erfüllt hat. Gültige Werte:
|
| state_transitions.display_value | Angezeigte Beschreibung des Status. Datentyp: Zeichenfolge |
| state_transitions.from_state | Wert des Status, aus 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 der Change Request übergeht. Datentyp: Zeichenfolge |
| state_transitions.transition_available | Kennzeichnung, die angibt, ob der Change Request vom aktuellen Status in diesen Status übergehen kann. Gültige Werte:
|
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.
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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | Sys_id des Change Request, in dem das nächste verfügbare Zeitfenster gefunden werden soll. Befindet sich in der Tabelle [change_request]. Die ausgewählte Change-Anforderung muss ein Konfigurationselement (cmdb_ci) mit geplanten Start- und geplanten Endzeiten aufweisen. |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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:
|
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
Mögliche Probleme:
|
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Fehler | Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.FehlerNachrichten | Fehlermeldungen, die beim Verarbeiten der Anforderung aufgetreten sind. Datentyp: Array |
| message.infoMessages | Während der Verarbeitung der Anforderung aufgetretene Informationsmeldungen. Datentyp: Array |
| message.warningMessages | Während der Verarbeitung der Anforderung aufgetretene Warnmeldungen. Datentyp: Array |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt |
| state.display_value | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit dem Parameter state.value. Mögliche Werte:
Datentyp: Zeichenfolge |
| state.value | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| type | Gibt den Typ der Anforderung an. Gültiger Wert: schedule Datentyp: Zeichenfolge |
| Mitarbeiter | Informationen zum zugeordneten Mitarbeiter. Datentyp: Objekt |
| worker.link | Link zum Abrufen von Zeitfensterdaten. Verwenden Sie die sys_id in GET /sn_chg_rest/change/worker/{sys_id}, um die Ergebnisse anzuzeigen. Datentyp: Zeichenfolge |
| worker.sysId | Sys_id des Mitarbeiters, der dem Change Request 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 worker.link angegebenen Wert, um 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 worker_sys_id in GET /sn_chg_rest/change/worker/{worker_sys_id}, um die Ergebnisse anzuzeigen.
Der Antworttext enthält den Status und liefert Ergebnisse, wenn die Verarbeitung abgeschlossen ist.
- Wenn das angegebene Zeitfenster für die Change-Anforderung innerhalb des Zeitplanzeitfensters verfügbar ist, listet die Worker-API die verfügbaren Zeitfenster in der Eigenschaft payload.spans auf. Die Eigenschaft payload.spans wird andernfalls nicht in den Ergebnissen aufgeführt.
- Wenn keine Zeitfenster für die Dauer der Change-Anforderung innerhalb des definierten Planungszeitfensters verfügbar sind, gibt messages.infoMessages Folgendes an:
DHinweis:Der Standardwert für das Change Request-Zeitfenster beträgt 90 Tage. Um diesen Wert zu ändern, ändern Sie die Eigenschaft change.conflict.next_available.schedule_window. Weitere Informationen finden Sie unter Konfliktanalyseeigenschaften konfigurieren.
Das folgende GET /sn_chg_rest/change/worker/{sys_id}-Beispiel zeigt die Ausgabe, die mit der im worker.link-Detail angegebenen ID bereitgestellt wird. In der Ergebnisliste werden offene Zeitspannen angezeigt, 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"
Die Ergebnisse enthalten worker.link-Details, die Sie zum Ausführen der angegebenen sys_id im GET /sn_chg_rest/change/worker/-Endpunkt verwenden können.
{
"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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | Sys_id des Change Request, dessen Aufgaben abgerufen werden sollen. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| 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:
Datentyp: Zeichenfolge |
| Bestellen | Feld, nach dem die zurückgesendeten Change Requests sortiert werden sollen. Standard: Zahl 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 Datentyp: Zahl Standard: 0 |
| sysparm_query | Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet wird. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>.
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:
Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln Syntax:
Beispiel: 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 |
| textSearch | Zeichenfolge, die zum Durchsuchen aller Change-Aufgaben-Datensatzfelder verwendet wird. Diese Suche verwendet die Funktionalität der Volltextsuchplattform von ServiceNow. Der Standardwert ist IR_AND_OR_QUERY.Datentyp: Zeichenfolge |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 den Change Request, der der Aufgabe zugeordnet ist. Datentyp: Objekt |
| parent.display_value | Change-Anforderungsinformationen, die in einer Benutzeroberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| parent.value | Sys_id des Change Request, der der Aufgabe zugeordnet ist. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen für die Change Request-Aufgabe. Datentyp: Objekt |
| sys_id.display_value | Sys_id der Change Request-Aufgabe, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | Sys_id der Change Request-Aufgabe. 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 den Change Request ab, der von der angegebenen 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Change-Anforderungsdatensatzes, der aus der Tabelle „Change-Anforderung“ [change_request] abgerufen werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Elemente | Beschreibung |
|---|---|
| Ergebnis | Liste mit einem oder mehreren Change Request-Datensatzobjekten. Jedes Objekt beschreibt eine Change-Anforderung. Jedes Element im Change Request-Objekt entspricht einem Feld in seinem zugeordneten Datensatz in der Change Request-Tabelle [change_request]. Alle Elemente enthalten Name-Wert-Paare Wert und display_value. Datumsfelder enthalten auch Name-Wert-Paare vom Typ display_value_internal. Datentyp: Array |
| action_status | Aktueller Aktionsstatus der zugeordneten Change-Anforderung. Mögliche Werte:
Datentyp: Zahl |
| aktiv | Kennzeichnung, die angibt, ob die Change-Anforderung aktiv ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: true |
| activity_due | Datum und Uhrzeit, zu der der zugeordnete Fall voraussichtlich abgeschlossen sein wird. Datentyp: Zeichenfolge |
| Additional_assignee_list | Liste der sys_ids zusätzlicher Personen, die zur Bearbeitung 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 zugeordneten Aktion. Datentyp: Zeichenfolge |
| assigned_to | Sys_id des Benutzers, der dem Change Request zugewiesen ist. Datentyp: Zeichenfolge |
| assignment_group | Sys_id der Gruppe, die dem Change Request zugewiesen ist. Datentyp: Zeichenfolge |
| backout_plan | Beschreibung des Plans, der ausgeführt werden soll, wenn der Change rückgängig gemacht werden muss. Datentyp: Zeichenfolge |
| business_duration | Dauer in geplanten Arbeitsstunden, Arbeitstagen und Arbeitswochen, die bis zum Abschluss des Change benötigt wurden. Datentyp: Zeichenfolge |
| business_service | Sys_id des Business Service, der dem Change Request zugeordnet ist. Befindet sich in der Tabelle „Service“ [cmdb_ci_service]. Datentyp: Zeichenfolge |
| CAB-Datum | Datum, an dem das Change Advisory Board (CAB) zusammentritt. Datentyp: Zeichenfolge |
| cab_delegate | Sys_id des Benutzers, der den CAB-Manager während eines CAB-Meetings vertreten kann. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| cab_recommendation | Beschreibung der CAB-Empfehlungen für den Change Request. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| cab_erforderlich | Kennzeichnung, die angibt, ob die CAB erforderlich ist. Mögliche Werte:
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: Sonstige |
| change_plan | Aktivitäten und Rollen für die Verwaltung und Steuerung von Change-Anforderungen. Datentyp: Zeichenfolge |
| chg_model | Sys_id des Change-Modells, auf dem die zugeordnete Change-Anforderung basiert. Befindet sich in der Tabelle „Change-Modell“ [chg_model]. Das Change-Modell definiert den Statusfluss, die Übergänge und die Prozessaktivitäten, die für die Change-Anforderung abgeschlossen werden müssen. Datentyp: Zeichenfolge |
| closed_at | Datum und Uhrzeit, zu der die zugeordnete Change-Anforderung geschlossen wurde. Datentyp: Zeichenfolge |
| closed_by | Sys_id der Person, die die Change-Anforderung geschlossen hat. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| close_code | Code, der dem Change Request zugewiesen wurde, als er geschlossen wurde. Beispiele: Erfolgreich, Erfolgreich mit Problemen und Nicht erfolgreich. Datentyp: Zeichenfolge |
| close_notes | Notizen, die die Person beim Schließen der Change-Anforderung eingegeben hat. Datentyp: Zeichenfolge |
| cmdb_ci | Sys_id des Konfigurationselements, das dem Change Request zugeordnet ist. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| Kommentare | Liste der Arbeitsnotizen für Kunden, die in die zugehörige Change-Anforderung eingegeben wurden. Datentyp: Array |
| Kommentare_und_Arbeitsnotizen | 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 dem Change Request zugeordnet ist. Befindet sich in der Tabelle „Unternehmen“ [core_company]. Datentyp: Zeichenfolge |
| konflikt_last_run | Datum und Uhrzeit der letzten Ausführung des Konflikterkennungsskripts für die Change-Anforderung. Datentyp: Zeichenfolge |
| konflikt_status | Aktueller Konfliktstatus, wie vom Konflikterkennungsskript erkannt, z. B. Konflikt und Nicht ausgeführt. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Nicht ausgeführt |
| contact_type | Methode, in der die Change-Anforderung ursprünglich angefordert wurde. Mögliche Werte:
Datentyp: Zeichenfolge |
| contract | Sys_id des Vertrags, der der Change-Anforderung zugeordnet ist. Befindet sich in der Tabelle „Vertrag“ [ast_contract]. Datentyp: Zeichenfolge |
| korrelation_display | Benutzerfreundlicher Name für correlation_id. Datentyp: Zeichenfolge Maximale Länge: 100 |
| correlation_id | Global eindeutige ID (GUID) eines übereinstimmenden Change-Anforderungsdatensatzes in einem Drittanbietersystem. Datentyp: Zeichenfolge Maximale Länge: 100 |
| Delivery_plan | Wird nicht mehr verwendet. Sys_id des Bereitstellungsplans, der der Change-Anforderung zugeordnet ist. Befindet sich in der Tabelle „Ausführungsplan“ [sc_cat_item_delivery_plan]. Datentyp: Zeichenfolge |
| Delivery_task | Wird nicht mehr verwendet. Sys_id der Bereitstellungsaufgabe, die der Change-Anforderung zugeordnet ist. Befindet sich in der Tabelle „Ausführungsplanaufgabe“ [sc_cat_item_delivery_task]. Datentyp: Zeichenfolge |
| Beschreibung | Detaillierte Beschreibung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| due_date | Fälligkeitsdatum der Aufgabe. Wird nicht vom Change-Anforderungsprozess verwendet. Datentyp: Zeichenfolge |
| end_date | Datum und Uhrzeit, zu der die Change-Anforderung abgeschlossen werden soll. Datentyp: Zeichenfolge |
| Eskalation | Aktuelle Eskalationsebene. Mögliche Werte:
Datentyp: Zahl (Integer) Standard: 0 |
| expected_start | Datum und Uhrzeit, zu der die Aufgabe beginnen soll. Wird nicht vom Change-Anforderungsprozess verwendet. Datentyp: Zeichenfolge |
| follow_up | Datum und Uhrzeit der Nachverfolgung eines Benutzers bei der Person, die die Change-Anforderung anfordert. Datentyp: Zeichenfolge |
| group_list | Liste der sys_ids und Namen der Gruppen, die dem Change Request zugeordnet sind. Datentyp: Array Maximale Länge: 4.000 |
| impact | Auswirkung der Change-Anforderung auf den Kunden. Mögliche Werte:
Datentyp: Zahl (Integer) Standard: 3 |
| „implementierung_plan“. | Sequenzielle Schritte, die ausgeführt werden sollen, um diesen Change zu implementieren. Sie enthält auch alle Abhängigkeiten zwischen Schritten und Beauftragtendetails für jeden Schritt. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Begründung | Vorteile der Implementierung dieses Change und die Auswirkungen, wenn dieser Change nicht implementiert wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Wissen | Kennzeichnung, die angibt, ob dem Change Request Knowledge Base-Artikel ()KB) zugeordnet sind. Mögliche Werte:
Datentyp: Boolesch |
| location | Sys_id und Name des Standorts der Ausrüstung, auf die in der Change-Anforderung verwiesen wird. Befindet sich in der Tabelle „Standort im Standort“ [cmn_location]. Datentyp: Zeichenfolge |
| hergestellt_sla | Wird nicht mehr verwendet. Kennzeichnung, die angibt, ob die Change-Anforderung in Übereinstimmung mit der zugehörigen Servicelevel-Vereinbarung implementiert wurde. Datentyp: Boolesch |
| Bedarf_Aufmerksam | Kennzeichnung, die angibt, ob die Change-Anforderung Aufmerksamkeit erfordert. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Nummer | Change-Nummer, die dem Change Request vom System zugewiesen wurde, z. B. CHG0040007. Datentyp: Zeichenfolge |
| on_hold | Kennzeichnung, die angibt, ob der Change Request derzeit angehalten ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| on_hold_reason | Wenn der Parameter on_hold „wahr“ ist, Beschreibung des Grunds, warum die Change-Anforderung zurückgehalten wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| on_hold_task | Wenn der Parameter on_hold auf „wahr“ festgelegt ist, Liste der sys_ids der Aufgaben, die abgeschlossen sein müssen, bevor die Warteschleife freigegeben wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| opened_at | Datum und Uhrzeit der Erstellung des Change-Release. Datentyp: Zeichenfolge |
| opened_by | Sys_id und Name des Benutzers, der das Change-Release erstellt hat. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| 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 (Integer) |
| outside_maintenance_schedule | Kennzeichnung, die angibt, ob die Wartung durch ein externes Unternehmen für die Change-Anforderung geplant wurde. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| übergeordnet | Sys_id und Name der übergeordneten Aufgabe zu diesem Change Request, falls vorhanden. Befindet sich in der Aufgabentabelle [Aufgabe]. Datentyp: Zeichenfolge |
| phase | Aktuelle Phase der Change-Anforderung. Dies definiert, was der Change im Detail tut. Mögliche Werte:
Datentyp: Zeichenfolge |
| Phase_state | Change_phase-Datensätze, die für einen Change erstellt werden sollen. Sie sind von der Kategorie abhängig, sodass jede Art von Change unterschiedliche change_phase-Datensätze haben kann. Die change_phase-Datensätze bieten die Möglichkeit, den Genehmigungsprozess zu steuern, da jede change_phase einen Zeitplan und eine Reihe von Genehmigern haben kann. Mögliche Werte:
Datentyp: Zeichenfolge |
| Priorität | Priorität der Change-Anforderung. Mögliche Werte:
Datentyp: Zahl (Integer) Standard: 4 |
| „production_system“ | Kennzeichnung, die angibt, ob die Change-Anforderung für eine ServiceNow -Instanz in einer Produktionsumgebung gilt. Mögliche Werte:
Datentyp: Boolesch |
| Grund | Beschreibung, warum die Change-Anforderung initiiert wurde. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 |
| reassignment_count | Anzahl, die angibt, wie oft die Change-Anforderung einem neuen Besitzer zugewiesen wurde. Datentyp: Zahl (Integer) Standard: 0 |
| Ablehnung_goto | Sys_id der Aufgabe, die ausgeführt werden soll, wenn die Change-Anforderung abgelehnt wird. Befindet sich in der Aufgabentabelle [table]. Datentyp: Zeichenfolge |
| angefordert_by | Sys_id des Benutzers, der den Change angefordert hat. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| „angefordert nach_Datum“. | Datum und Uhrzeit, zu der die Implementierung des Change durch angefordert wurde. 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 Überprüfung der angeforderten Change-Anforderung. Datentyp: Zeichenfolge |
| risk | Risikostufe, die der Change-Anforderung zugeordnet ist. Gültige Werte:
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, aus dem die Change-Anforderung übertragen wurde. Mögliche Werte:
Datentyp: Zahl |
| scope | Größe der Change-Anforderung. Mögliche Werte:
Datentyp: Zahl Standard: 3 |
| Service.Offering | Sys_id des Serviceangebots, das der Change-Anforderung zugeordnet ist. Serviceangebote definieren das Serviceniveau eindeutig in Bezug auf Verfügbarkeit, Umfang, Preisgestaltung und Paketoptionen. Befindet sich in der Angebotstabelle [service_offering]. Datentyp: Zeichenfolge |
| 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. Befindet sich in der Kompetenztabelle [cmn_skill]. Datentyp: Array |
| 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 beliebigen E-Signatur-Dokuments, das an die Change-Anforderung angehängt ist. Befindet sich in der Anhangtabelle [sys_attachment]. Datentyp: Zeichenfolge |
| sn_esign_esignature_configuration | Sys_id der E-Signatur-Signaturvorlage, die für das zugeordnete Dokument verwendet wird. Befindet sich in der Tabelle „E-Signatur-Vorlage“ [sn_esign_configuration]. Datentyp: Zeichenfolge |
| start_date | Zeitpunkt (Datum und Uhrzeit), zu dem die Change-Anforderung mit der Implementierung beginnen soll. Datentyp: Zeichenfolge |
| Status | Aktueller Status des Change Requests. Mögliche Werte sind im Change-Modell definiert. Datentyp: Zahl (Integer) Standard: 1 |
| std_change_producer_version | Sys_id des Datensatzerstellers und Change-Vorschlags, der dem Change Request zugeordnet ist. Enthält auch die Anzahl und den Prozentsatz erfolgreicher und nicht erfolgreicher Change-Anforderungen, die aus dem Vorschlag erstellt wurden. Befindet sich in der Tabelle „Standard-Change-Vorlagenversion“ [std_change_producer_version]. Datentyp: Zeichenfolge |
| sys_class_name | Name der Tabelle, in der sich der Change Request befindet. Datentyp: Zeichenfolge |
| sys_created_by | Name des Benutzers, 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 | Bei Verwendung von Domänen in der Instanz 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 Identifier des zugeordneten Change Request-Datensatzes. Datentyp: Zeichenfolge |
| sys_mod_count | Anzahl der Aktualisierungen des Falls seit seiner ursprünglichen Erstellung. Datentyp: Zahl (Integer) |
| 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_effektive_Nummer | Universal Request-Nummer. Datentyp: Zeichenfolge Maximale Länge: 40 |
| task_for | Nicht verwendet von Change-Management. Sys_id des Benutzers, für den die Aufgabe erstellt wurde. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| test_plan | Beschreibung des zugeordneten Testplans für den Change. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| time_worked | Gesamtbetrag der für die Change-Anforderung aufgewendeten Zeit. Datentyp: Zeichenfolge |
| type | Change-Anforderungstyp. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 |
| nicht autorisiert | Kennzeichnung, die angibt, ob die Change-Anforderung nicht autorisiert ist Mögliche Werte:
Datentyp: Boolesch |
| universal_request | Sys_id der übergeordneten universellen Anforderung, zu der diese Change-Anforderung gehört. Befindet sich in der Aufgabentabelle [Aufgabe]. Datentyp: Zeichenfolge |
| on_approval | Aktion, die ausgeführt werden soll, wenn die Change-Anforderung genehmigt wird. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fortfahren |
| on_reject | Aktion, die ausgeführt werden soll, wenn die Change-Anforderung abgelehnt wird. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Abbrechen |
| urgency | Dringlichkeit der Change-Anforderung. Mögliche Werte:
Datentyp: Zahl (Integer) Standard: 3 |
| Anwender_Eingabe | Zusätzliche Benutzereingabe. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| variables | Name-Wert-Paare von Variablen, die dem Change Request zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40 |
| uhr_liste | Liste der sys_ids der Benutzer, 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. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Array |
| wf_aktivität | Sys_id des Workflow-Aktivitätsdatensatzes, der dem Change Request zugeordnet ist. Befindet sich in der Workflow-Aktivitätstabelle [wf_aktivität]. Datentyp: Zeichenfolge |
| work_end | Datum und Uhrzeit, zu der die Arbeit an der Change-Anforderung beendet wurde. Datentyp: Zeichenfolge |
| work_notes | Informationen darüber, wie die Change-Anforderung gelöst werden kann, 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 Benutzer, die Benachrichtigungen zu dieser Change-Anforderung erhalten, wenn Arbeitsnotizen hinzugefügt werden. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Array |
| 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 (CIs) ab, die einer angegebenen Change-Anforderung basierend auf dem angegebenen Zuordnungstyp zugeordnet sind.
URL-Format
Versionierte URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/ci
Standard-URL: /api/sn_chg_rest/change/{sys_id}/ci
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Change Request, für den die zugeordneten CMDB-CIs zurückgegeben werden sollen. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| „association_type“ | Erforderlich. Typ der Zuordnung zwischen dem CMDB-CI und der Change-Anforderung. Gültige Werte:
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 Datentyp: Zahl Standard: 0 |
| sysparm_query | Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet wird. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>.
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:
Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln Syntax:
Beispiel: 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 |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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 Meldungen, 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| ci_item | cmdb_ci_service | Entweder die Variablen ci_item oder cmdb_ci_service, abhängig vom Zuordnungstyp. Datentyp: Array |
| ci_item | cmdb_ci_service.value | Sys_id von 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.value | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche 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}/conflict
Standard-URL: /api/sn_chg_rest/change/{sys_id}/conflict
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Change Request, für den der Status des laufenden/abgeschlossenen Konfliktüberprüfungsprozesses zurückgegeben werden soll. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 der Change Request keine Konflikte aufweist, wird dieses Feld auf „Konflikt“ festgelegt. Das Objekt conflicts ist jedoch 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Bestellen | Feld, nach dem die zurückgesendeten Change Requests sortiert werden sollen. Standard: Zahl 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 Datentyp: Zahl Standard: 0 |
| sysparm_query | Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet wird. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>.
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:
Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln Syntax:
Beispiel: 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 |
| textSearch | Zeichenfolge, die zum Durchsuchen aller Notfall-Change Request-Datensatzfelder verwendet wird. Diese Suche verwendet die Funktionalität der Volltextsuchplattform von ServiceNow. Der Standardwert ist IR_AND_OR_QUERY.Datentyp: Zeichenfolge |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen für den Change Request. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| type.value | 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Notfall-Change Requests, der aus der Change Request-Tabelle [change_request] abzurufen ist. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen für den Change Request. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| type.value | 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| 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 Datentyp: Zahl Standard: 0 |
| sysparm_query | Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet wird. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>.
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:
Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln Syntax:
Beispiel: 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 |
| textSearch | Zeichenfolge, die zum Durchsuchen aller Change-Modell-Datensatzfelder verwendet wird. Diese Suche verwendet die Volltextsuchplattform-Funktionalität von ServiceNow. Weitere Informationen zu den Suchfunktionen von ServiceNow finden Sie unter Verwaltung der Suche. Datentyp: Zeichenfolge Standard: IR_AND_OR_QUERY |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Liste mit einem oder mehreren Change-Modell-Datensatzobjekten. 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 Name-Wert-Paare Wert und display_value. Einige enthalten display_value_internal Name-Wert-Paare. Datentyp: Array |
| result.active | Kennzeichnung, die angibt, ob der zugeordnete Change-Modell-Datensatz aktiv und in der Instanz verfügbar ist. Gültige Werte:
Datentyp: Boolesch Standardwert: true |
| result.available_in_ui | Kennzeichnung, die angibt, ob der zugeordnete Change-Modell-Datensatz in der Benutzeroberfläche verfügbar ist. Gültige Werte:
Datentyp: Boolesch Standardwert: true |
| result.color | Farbe des zugeordneten Change-Modells auf der Zielseite der Change-Anforderung. 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:
Datentyp: Boolesch Standardwert: false |
| result.description | Kurzbeschreibung des Zwecks des Change-Modells. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| result.name | Name des Change-Modells. Datentyp: Zeichenfolge Maximale Länge: 200 |
| result.record_preset | Name-Wert-Paare der Felder, die automatisch mit ihren zugehörigen Werten ausgefüllt werden sollen, wenn ein neuer Change Request-Datensatz erstellt wird. Werte werden durch Einfügesymbole getrennt. Beispiel:
Datentyp: Zeichenfolge |
| result.state_field | Auswahllistenfeld, aus dem Auswahlmöglichkeiten gesammelt werden sollen, basierend auf dem in table_nameangegebenen . Für Change-Modelle ist dies immer auf „Status“ festgelegt. Datentyp: Zeichenfolge |
| result.sys_class_name | Ändern Sie den Namen der Modultabelle. Change-Modell/chg_model immer. Datentyp: Zeichenfolge |
| result.sys_created_by | Name des Benutzers, der den zugeordneten Change-Modul-Datensatz ursprünglich erstellt hat. Datentyp: Zeichenfolge |
| result.sys_created_on | Datum und Uhrzeit der ursprünglichen Erstellung des Change-Modul-Datensatzes. Datentyp: Zeichenfolge |
| result.sys_domain | Bei Verwendung von Domänen in der Instanz der Name der Domäne, der der Change-Modul-Datensatz zugeordnet ist. Datentyp: Zeichenfolge |
| result.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 |
| result.sys_id | Eindeutiger Identifier des zugeordneten Change-Modell-Datensatzes. Datentyp: Zeichenfolge |
| result.sys_mod_count | Anzahl der Änderungen des zugeordneten Change-Modell-Datensatzes. Datentyp: Zahl |
| result.sys_name | Name des Change-Modells. Immer identisch mit dem Parameter name. Datentyp: Zeichenfolge |
| result.sys_tags | System-Tags, die dem Change-Modell-Datensatz zugeordnet sind. Datentyp: Zeichenfolge |
| result.sys_updated_by | Name des Benutzers, der den zugehörigen Change-Modell-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| result.sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des zugehörigen Change-Modell-Datensatzes. Datentyp: Zeichenfolge |
| result.table_name | Tabelle, die das Auswahllistenfeld definiert, aus dem Auswahlmöglichkeiten gesammelt 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"
Der Kürze halber zeigt diese Antwort nur ein einziges Change-Modell-Objekt.
{
"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 von der angegebenen sys_id identifizierte Change-Modell ab.
Sie können dieses Change-Modell dann 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Change-Modell-Datensatzes, der aus der Change-Modell-Tabelle [chg_model] abgerufen werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 value und display_value Name-Wert-Paare. Einige enthalten display_value_internal Name-Wert-Paare. Datentyp: Objekt |
| result.active | Kennzeichnung, die angibt, ob der zugeordnete Change-Modell-Datensatz aktiv und in der Instanz verfügbar ist. Gültige Werte:
Datentyp: Boolesch Standardwert: true |
| result.available_in_ui | Kennzeichnung, die angibt, ob der zugeordnete Change-Modell-Datensatz in der Benutzeroberfläche verfügbar ist. Gültige Werte:
Datentyp: Boolesch Standardwert: true |
| result.color | Farbe des zugeordneten Change-Modells auf der Zielseite der Change-Anforderung. 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:
Datentyp: Boolesch Standardwert: false |
| result.description | Kurzbeschreibung des Zwecks des Change-Modells. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| result.name | Name des Change-Modells. Datentyp: Zeichenfolge Maximale Länge: 200 |
| result.record_preset | Name-Wert-Paare der Felder, die automatisch mit ihren zugehörigen Werten ausgefüllt werden sollen, wenn ein neuer Change Request-Datensatz erstellt wird. Werte werden durch Einfügesymbole getrennt. Beispiel:
Datentyp: Zeichenfolge |
| result.state_field | Auswahllistenfeld, aus dem Auswahlmöglichkeiten gesammelt werden sollen, basierend auf dem in table_nameangegebenen . Für Change-Modelle ist dies immer auf „Status“ festgelegt. Datentyp: Zeichenfolge |
| result.sys_class_name | Ändern Sie den Namen der Modultabelle. Change-Modell/chg_model immer. Datentyp: Zeichenfolge |
| result.sys_created_by | Name des Benutzers, der den zugeordneten Change-Modul-Datensatz ursprünglich erstellt hat. Datentyp: Zeichenfolge |
| result.sys_created_on | Datum und Uhrzeit der ursprünglichen Erstellung des Change-Modul-Datensatzes. Datentyp: Zeichenfolge |
| result.sys_domain | Bei Verwendung von Domänen in der Instanz der Name der Domäne, der der Change-Modul-Datensatz zugeordnet ist. Datentyp: Zeichenfolge |
| result.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 |
| result.sys_id | Eindeutiger Identifier des zugeordneten Change-Modell-Datensatzes. Datentyp: Zeichenfolge |
| result.sys_mod_count | Anzahl der Änderungen des zugeordneten Change-Modell-Datensatzes. Datentyp: Zahl |
| result.sys_name | Name des Change-Modells. Immer identisch mit dem Parameter name. Datentyp: Zeichenfolge |
| result.sys_tags | System-Tags, die dem Change-Modell-Datensatz zugeordnet sind. Datentyp: Zeichenfolge |
| result.sys_updated_by | Name des Benutzers, der den zugehörigen Change-Modell-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| result.sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des zugehörigen Change-Modell-Datensatzes. Datentyp: Zeichenfolge |
| result.table_name | Tabelle, die das Auswahllistenfeld definiert, aus dem Auswahlmöglichkeiten gesammelt 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| 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. Standard: Zahl 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 Datentyp: Zahl Standard: 0 |
| sysparm_query | Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet wird. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>.
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:
Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln Syntax:
Beispiel: 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 |
| textSearch | 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 |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen für den Change Request. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Normal“. Datentyp: Zeichenfolge |
| type.value | 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des normalen Change Requests, der aus der Change Request-Tabelle [change_request] abzurufen ist. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Normal“. Datentyp: Zeichenfolge |
| type.value | 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| 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. Standard: Zahl 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 Datentyp: Zahl Standard: 0 |
| sysparm_query | Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet wird. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>.
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:
Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln Syntax:
Beispiel: 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 |
| textSearch | Zeichenfolge, die zum Durchsuchen aller Standard-Change Request-Datensatzfelder verwendet wird. Diese Suche verwendet die Funktionalität der Volltextsuchplattform von ServiceNow. Der Standardwert ist IR_AND_OR_QUERY.Datentyp: Zeichenfolge |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen für den Change Request. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Standard“. Datentyp: Zeichenfolge |
| type.value | 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Standard-Change Requests, der aus der Change Request-Tabelle [change_request] abzurufen ist. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen für den Change Request. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| 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: 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 Datentyp: Zahl Standard: 0 |
| sysparm_query | Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet wird. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>.
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:
Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln Syntax:
Beispiel: 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 |
| textSearch | 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 |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 den Change Request. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| Vorlage | Informationen zur Standard-Change-Vorlage. Datentyp: Objekt |
| template.display_value | Vorlageninformationen, die in der Benutzeroberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| template.value | sys_id der Vorlage. 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id der Standard-Change-Vorlage, die aus der Tabelle [std_change_record_producer] abgerufen werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Vorlageninformationen, die in einer Benutzeroberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| template.value | sys_id der Vorlage. 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, die Informationen und die 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des asynchronen Change-Management-Workers. Befindet sich in der Change-Management-Worker-Tabelle [chg_mgt_worker]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.FehlerNachrichten | Fehlermeldungen, die beim Verarbeiten der Anforderung aufgetreten sind. Beispiel: Ungültige CMDB_CI-sys_id angegeben Datentyp: Array |
| message.infoMessages | Während der Verarbeitung der Anforderung aufgetretene Informationsmeldungen. Beispiel: CMDB_CI sys_id ist bereits angegeben. Datentyp: Array |
| message.warningMessages | Während der Verarbeitung der Anforderung aufgetretene Warnmeldungen. Beispiel: Ungültige CMDB_CI-sys_id angegeben. Datentyp: Array |
| Nutzlast | Eindeutige Nutzlast, die bei Verwendung einer Worker-sys_id aus dem erfolgreichen Antworttext eines Planungsendpunkts bereitgestellt wird.
Datentyp: Objekt |
| Nutzlast.Bereiche | Wenn eine Zeitspanne innerhalb der im Zeitplanendpunkt angegebenen Dauer verfügbar ist, listet die Worker-API die verfügbaren Zeitspannen auf.
Datentyp: Array |
| nutzlast.spannen.start |
Datentyp: Objekt |
| nutzlast.spannen.start.wert | Zeitpunkt (Datum und Uhrzeit), zu dem die Change-Anforderung mit der Implementierung 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 |
| Nutzlast.Bereiche.Ende |
Datentyp: Objekt |
| nutzlast.spannen.end.wert | Datum und Uhrzeit, zu der der Change Request abgeschlossen sein soll. 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 | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit dem Parameter state.value. Mögliche Werte:
Datentyp: Zeichenfolge |
| state.value | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| type | Typ der Zuordnung zwischen dem CMDB-CI und der Change-Anforderung. Datentyp: Zeichenfolge |
| Mitarbeiter | Informationen zum zugeordneten Mitarbeiter. Datentyp: Objekt |
| worker.link | URL zum Abrufen des Status des zugeordneten Mitarbeiters und anderer relevanter Mitarbeiterinformationen. Datentyp: Zeichenfolge |
| worker.sysId | Sys_id des Mitarbeiters, der dem Change Request 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 den Change Request, der von der angegebenen sys_id identifiziert wird, 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des zu ändernden Change Request. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| 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 |
| verschlüsselte_felder | Liste der durch Kommas getrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt die GlideRecord setDisplayValue() -Methode auf, anstatt die setValue()- Methode aufzurufen. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für unverschlüsselte Felder wie Referenz- oder Auswahlfelder zu übergeben, anstatt sys_ids oder Werte zu übergeben. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Daten | Name-Wert-Paare, die das Feld bzw. die Felder darstellen, die im zugehörigen Change Request 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 |
| verschlüsselte_felder | Liste der durch Kommas getrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt die GlideRecord setDisplayValue() -Methode auf, anstatt die setValue()- Methode aufzurufen. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für unverschlü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.
| 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 |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Aktualisierter Change-Anforderungsdatensatz. Jedes Element in diesem Objekt entspricht einem Feld im Datensatz in der Change Request-Tabelle [change_request]. Alle Elemente enthalten value und display_value Name-Wert-Paare. Einige enthalten display_value_internal Name-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 Benutzer, einen Change Request-Genehmigungsdatensatz für den angegebenen Change Request 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Change Request, für den die Genehmigung/Ablehnung gilt. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Kommentare | Erforderlich, wenn stateabgelehntwird. Grund, warum der Change abgelehnt wurde.Datentyp: Zeichenfolge |
| Status | Erforderlich. Genehmigungsstatus. Beispiel: Gültige Werte:
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.
| 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 |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Change Request, der genehmigt/abgelehnt wird. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Mögliche Werte:
Datentyp: Zeichenfolge |
| type.value | Interner Typwert. Mögliche Werte:
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 mit dem ersten gefundenen verfügbaren Zeitfenster.
Erforderliche Rolle: sn_change_writer.
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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | Sys_id des Change Request, der mit dem nächsten verfügbaren Zeitfenster aktualisiert werden soll. Befindet sich in der Tabelle „Change-Anforderungen“ [change_request]. Die ausgewählte Change-Anforderung muss ein Konfigurationselement (cmdb_ci) haben. |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| duration_in_seconds | Dauer des Change in Sekunden, d. h. wie lange es dauert, bis die Change-Anforderungsaufgabe abgeschlossen ist. Datentyp: Ganzzahl |
| geplante_start_zeit | Optional. Zeitpunkt (Datum und Uhrzeit), zu dem die Change-Anforderung mit der Implementierung in UTC beginnen soll. Rufen Sie das verfügbare Zeitfenster ab, das zu diesem Zeitpunkt oder später beginnt. Wenn nicht angegeben, verwendet das System die aktuelle Uhrzeit als Startzeit. Zeitformat: 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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:
|
| 403 | Unzulässig. Anwender hat keinen Schreibzugriff auf die Werte für das geplante Start- und Enddatum der Change-Anforderung. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
Mögliche Probleme:
|
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Fehler | Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.FehlerNachrichten | Fehlermeldungen, die beim Verarbeiten der Anforderung aufgetreten sind. Datentyp: Array |
| message.infoMessages | Während der Verarbeitung der Anforderung aufgetretene Informationsmeldungen. Datentyp: Array |
| message.warningMessages | Während der Verarbeitung der Anforderung aufgetretene Warnmeldungen. Datentyp: Array |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt |
| state.display_value | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit dem Parameter state.value. Mögliche Werte:
Datentyp: Zeichenfolge |
| state.value | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| type | Gibt den Typ der Anforderung an. Gültiger Wert: schedule Datentyp: Zeichenfolge |
| Mitarbeiter | Informationen zum zugeordneten Mitarbeiter. Datentyp: Objekt |
| worker.link | Link zum Abrufen des Status des Change Request-Zeitplans. Verwenden Sie die sys_id in GET /sn_chg_rest/change/worker/{sys_id}, um die Ergebnisse anzuzeigen. Datentyp: Zeichenfolge |
| worker.sysId | Sys_id des Mitarbeiters, der dem Change Request zugeordnet ist. Datentyp: Zeichenfolge |
| status | Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
Ruft den Status des Change Request-Zeitplans ab
Verwenden Sie den in worker.link angegebenen Wert, um zu bestimmen, 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 bereitgestellte sys_id in GET /sn_chg_rest/change/worker/{sys_id} auszuführen und die Ergebnisse anzuzeigen.
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, zeigt messages.infoMessages an, dass das erste verfügbare Zeitfenster festgelegt wurde.
Change wurde aktualisiert: Angeforderter Change wurde für das Zeitfenster aktualisiert.Keine Slots für gefunden<number> Tage ab jetzt – Keine Zeitfenster für die Dauer der Change-Anforderung innerhalb der im Zeitplanfenster definierten Anzahl von Tagen verfügbar.Hinweis:Der Standardwert für das Change Request-Zeitfenster beträgt 90 Tage. Um diesen Wert zu ändern, ändern Sie die Eigenschaft change.conflict.next_available.schedule_window. Weitere Informationen finden Sie unter Konfliktanalyseeigenschaften konfigurieren.
Das folgende GET /sn_chg_rest/change/worker/{sys_id}-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 der Change Request 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"
Die Ergebnisse enthalten worker.link-Details, die Sie zum Ausführen der angegebenen sys_id im GET /sn_chg_rest/change/worker/-Endpunkt verwenden können.
{
"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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | Sys_id des Change Request, dem die Aufgabe zugeordnet ist. Überprüft, ob die angegebene Aufgabe dem angegebenen Change Request zugeordnet ist. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| task_sys_id | Sys_id der zu ändernden Aufgabe. Befindet sich in der Change-Aufgabentabelle [change_task]. Datentyp: Zeichenfolge |
| 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 |
| Name | Beschreibung |
|---|---|
| Daten | Name-Wert-Paare, die das Feld bzw. die Felder darstellen, die im zugehörigen Change Request 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.
| 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 |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 Request-Aufgabe. Datentyp: Objekt |
| sys_id.display_value | Sys_id der Change Request-Aufgabe, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | Sys_id der Change Request-Aufgabe. Datentyp: Zeichenfolge |
| übergeordnet | Eindeutige Bezeichnerinformationen für den Change Request, der dieser Aufgabe zugeordnet ist. Datentyp: Objekt |
| parent.display_value | Aufgabeninformationen, die in einer Benutzeroberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| parent.value | Sys_id der übergeordneten Aufgabe. Datentyp: Zeichenfolge |
| __meta.ignorierteFelder | Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change Request angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des zu ändernden Change Request. Befindet sich in der Tabelle [change_request]. Datentyp: Zeichenfolge |
| 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 |
| Name | Beschreibung |
|---|---|
| Daten | Name-Wert-Paare, die das Feld bzw. die Felder darstellen, die im zugehörigen Change Request 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.
| 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 |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| type.value | Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| __meta.ignorierteFelder | Name-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf den Change Request 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des zu ändernden Change Request. Befindet sich in der Tabelle [change_request]. Datentyp: Zeichenfolge |
| 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 |
| Name | Beschreibung |
|---|---|
| Daten | Name-Wert-Paare, die das Feld bzw. die Felder darstellen, die im zugehörigen Change Request 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.
| 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 |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id der Change-Anforderung. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Normal“. Datentyp: Zeichenfolge |
| type.value | Interner Typwert. Wert ist immer „normal“. Datentyp: Zeichenfolge |
| __meta.ignorierteFelder | Name-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf den Change Request 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}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des zu ändernden Change Request. Befindet sich in der Tabelle [change_request]. Datentyp: Zeichenfolge |
| 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 |
| Name | Beschreibung |
|---|---|
| Daten | Name-Wert-Paare, die das Feld bzw. die Felder darstellen, die im zugehörigen Change Request 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.
| 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 |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen für den Change Request. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des auszuwertenden Standard-Change. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| impact | Auswirkungen im Zusammenhang mit dem angegebenen Standard-Change. Datentyp: Objekt |
| auswirkung.display_value | Auswirkungsinformationen, die in einer Benutzeroberfläche 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 |
| risk | Berechnetes Risiko für den angegebenen Standard-Change. Datentyp: Objekt |
| „risk.display_value“ | Risikoinformationen, die in einer Benutzeroberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| risiko.wert | Interner Risikowert. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen für den Standard-Change Request. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | 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 – POST /sn_chg_rest/change
Erstellt einen Change Request-Datensatz basierend auf dem Change Request. Das Erstellen mehrerer Change-Anforderungen innerhalb eines einzelnen Anrufs wird nicht unterstützt.
Sie können die Liste der verfügbaren Change-Modelle mit den Endpunkten Change Management – GET /sn_chg_rest/change/model oder Change Management – GET /sn_chg_rest/change/model/{sys_id} abrufen.
Legen Sie beim Erstellen einer Change-Anforderung das Change-Modell (chg_model) oder typefest. Wenn sowohl chg_modelals auch type festgelegt sind, ist der Typ einfach eine Kategorisierung des Change. Wenn Sie nicht mindestens einen dieser Werte angeben, führt dies zu einer Standardeinstellung, die bis zum Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen.
Werte können entweder als Abfrageparameter oder Anforderungstextparameter festgelegt werden.
URL-Format
Versionierte URL: /api/sn_chg_rest/{api_version}/change
Standard-URL: /api/sn_chg_rest/change
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| 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 Anforderungstextparameter festgelegt werden. Hinweis: Legen Sie beim Erstellen einer Change-Anforderung das Change-Modell (chg_model) oder typefest. Wenn sowohl chg_modelals auch type festgelegt sind, ist der Typ einfach eine Kategorisierung des Change. Wenn Sie nicht mindestens einen dieser Werte angeben, führt dies zu einer Standardeinstellung, die bis zum 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: Weitere Informationen finden Sie unter Change-Modelle. Hinweis: Wenn Sie weder das Change-Modell (chg_model) noch den Wert type angeben, erhalten Sie eine Standardeinstellung, die bis zum Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge |
| verschlüsselte_felder | Liste der durch Kommas getrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt die GlideRecord setDisplayValue() -Methode auf, anstatt die setValue()- Methode aufzurufen. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für unverschlü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_model ebenfalls ausgefüllt ist, wird dieses Feld nur als Change-Kategorisierung verwendet. Wird im folgenden Format bereitgestellt: Weitere Informationen finden Sie unter Neuen Change-Anforderungstypen hinzufügen. Hinweis: Wenn Sie weder das Change-Modell (chg_model) noch den Wert type angeben, erhalten Sie eine Standardeinstellung, die bis zum Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Objekt | Name-Wert-Paare, die das Feld bzw. die Felder darstellen, die im zugehörigen Change Request 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 |
| Objekt.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: Weitere Informationen finden Sie unter Change-Modelle. Hinweis: Wenn Sie weder das Change-Modell (chg_model) noch den Wert type angeben, erhalten Sie eine Standardeinstellung, die bis zum Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge |
| Object.encrypted_fields | Liste der durch Kommas getrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt die GlideRecord setDisplayValue() -Methode auf, anstatt die setValue()- Methode aufzurufen. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für unverschlü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_model ebenfalls ausgefüllt ist, wird dieses Feld nur als Change-Kategorisierung verwendet. Wird als Name-Wert-Paar im folgenden Format bereitgestellt: Weitere Informationen finden Sie unter Neuen Change-Anforderungstypen hinzufügen. Hinweis: Wenn Sie weder das Change-Modell (chg_model) noch den Wert type angeben, erhalten Sie eine Standardeinstellung, die bis zum 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.
| 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 |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Neuer Change-Anforderungsdatensatz. Die Elemente dieses Objekts entsprechen dem Datensatzformat in der Change Request-Tabelle [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 ein Change Request-Datensatz basierend auf dem Standard-Change-Modell und dem Standardtyp erstellt wird. 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 CHG0030022 hinzugefügt wurde.
{
"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) Konfigurationselementen (CI).
Die Erstellung der Zuordnung erfolgt asynchron, was bedeutet, dass sofort eine Antwort bereitgestellt wird, die Details für den Worker enthält. Der Mitarbeiter führt die eigentliche Arbeit nach der Antwort aus.
URL-Format
Versionierte URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/ci
Standard-URL: /api/sn_chg_rest/change/{sys_id}/ci
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id des Change Request, der dem CMDB-CI zugeordnet werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| „association_type“ | Erforderlich. Typ der Zuordnung zwischen dem CMDB-CI und der Change-Anforderung. Gültige Werte:
Datentyp: Zeichenfolge |
| cmdb_ci_sys_ids | Erforderlich. Liste der CMDB-CI-sys_ids, die der Change-Anforderung zugeordnet werden sollen. Datentyp: Array oder durch Kommas getrennte Zeichenfolge |
| refresh_impacted_services | Kennzeichnung, die bei „ association_type=affected “ verwendet wird, um betroffene Services basierend auf der Liste der betroffenen CIs auszufüllen.Gültige Werte:
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.
| 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 |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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 Meldungen, 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.FehlerNachrichten | Fehlermeldungen, die beim Verarbeiten der Anforderung aufgetreten sind. Beispiel: Ungültige CMDB_CI-sys_id angegeben Datentyp: Array |
| message.infoMessages | Während der Verarbeitung der Anforderung aufgetretene Informationsmeldungen. Beispiel: CMDB_CI sys_id ist bereits angegeben. Datentyp: Array |
| message.warningMessages | Während der Verarbeitung der Anforderung aufgetretene Warnmeldungen. Beispiel: Ungültige CMDB_CI-sys_id angegeben. Datentyp: Array |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. |
| state.display_value | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit dem Element state.value. Mögliche Werte:
Datentyp: Zeichenfolge |
| state.value | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| type | Typ der Zuordnung zwischen dem CMDB-CI und der Change-Anforderung. Datentyp: Zeichenfolge |
| Mitarbeiter | Informationen zum zugeordneten Mitarbeiter. Datentyp: Objekt |
| worker.link | URL zum Abrufen des Status des zugeordneten Mitarbeiters und anderer relevanter Mitarbeiterinformationen. Datentyp: Zeichenfolge |
| worker.sysId | Sys_id des Mitarbeiters, der dem Change Request 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}/conflict
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}/conflict
Standard-URL: /api/sn_chg_rest/change/{sys_id}/conflict
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id der Change-Management-Anforderung, für die der Konfliktüberprüfungsprozess gestartet werden soll. Befindet sich in der Change Request-Tabelle [change_request]. Weitere Informationen zum Konfliktüberprüfungsprozess finden Sie unter Konflikterkennung. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Sys_id des Change Request-Konflikt-Überprüfungsprozesses. 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 – POST /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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| 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:
Datentyp: Zeichenfolge |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare der Felder, die im Notfall-Change Request erstellt wurden. Datentyp: Objekt |
| Status | Status des Change Requests vor dem Löschen. Datentyp: Objekt |
| state.display_value | Status, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Neu“. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Wert ist immer „-5“. Datentyp: Zeichenfolge |
| sys_id | Sys_id der neu erstellten Notfall-Change-Anforderung. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| type.value | Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| __meta.ignorierteFelder | Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change Request angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden 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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| 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:
Datentyp: Zeichenfolge |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (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 | Status, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Neu“. Datentyp: Zeichenfolge |
| state.value | Interner Statuswert. Wert ist immer „-5“. Datentyp: Zeichenfolge |
| sys_id | Sys_id des neu erstellten normalen Change Requests. Datentyp: Zeichenfolge |
| type | Der Typ des Change Requests. Datentyp: Objekt |
| type.display_value | Change-Typ, der in einer Benutzeroberfläche angezeigt werden soll. Wert ist immer „Normal“. Datentyp: Zeichenfolge |
| type.value | Interner Typwert. Wert ist immer „normal“. Datentyp: Zeichenfolge |
| __meta.ignorierteFelder | Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change Request angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden 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_impacted_services
Füllt die zugehörige Liste der betroffenen Services/Konfigurationselemente (CIs) basierend auf dem primären CI aus.
Das primäre CI wird im Change Request-Formular und in der zugehörigen Liste der betroffenen CIs angezeigt.
URL-Format
Versionierte URL: /api/sn_chg_rest/{api_version}/change/{sys_id}/refresh_impacted_services
Standard-URL: /api/sn_chg_rest/change/{sys_id}/refresh_impacted_services
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | Sys_id der Change-Anforderung, die zum Aktualisieren der betroffenen Services verwendet werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| 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.
| 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 |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.FehlerNachrichten | Fehlermeldungen, die beim Verarbeiten der Anforderung aufgetreten sind. Beispiel: Ungültige CMDB_CI-sys_id angegeben Datentyp: Array |
| message.infoMessages | Während der Verarbeitung der Anforderung aufgetretene Informationsmeldungen. Beispiel: CMDB_CI sys_id ist bereits angegeben. Datentyp: Array |
| message.warningMessages | Während der Verarbeitung der Anforderung aufgetretene Warnmeldungen. Beispiel: Ungültige CMDB_CI-sys_id angegeben. Datentyp: Array |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt |
| state.display_value | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit dem Element state.value. Mögliche Werte:
Datentyp: Zeichenfolge |
| state.value | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| type | Typ der Zuordnung zwischen dem CMDB-CI und der Change-Anforderung. Datentyp: Zeichenfolge |
| Mitarbeiter | Informationen zum zugeordneten Mitarbeiter. Datentyp: Objekt |
| worker.link | URL zum Abrufen des Status des zugeordneten Mitarbeiters und anderer relevanter Mitarbeiterinformationen. Datentyp: Zeichenfolge |
| worker.sysId | Sys_id des Mitarbeiters, der dem Change Request 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}
Unterstützte Anforderungsparameter
| Parameter | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| standard_change_template_id | Sys_id der Standard-Change-Vorlage, auf der die neue Standard-Change-Anforderung basieren soll. Befindet sich in der Tabelle „Standard-Change-Vorlage“ [std_change_record_producer]. Datentyp: Zeichenfolge |
| 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:
Datentyp: Zeichenfolge |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| 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.
| 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.
| Elemente | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare der Felder, die im Standard-Change Request erstellt wurden. Datentyp: Objekt |
| sys_id | Sys_id-Informationen des neu erstellten Standard-Change Requests. Datentyp: Objekt |
| sys_id.display_value | Sys_id des Standard-Change Requests, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | Sys_id der Standard-Change-Anforderung. Datentyp: Zeichenfolge |
| __meta.ignorierteFelder | Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change Request angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden 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 – POST /sn_chg_rest/change/{change_sys_id}/task
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
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel v1 oder v2. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | Sys_id des Change Request, dem diese Aufgabe zugeordnet werden soll. Befindet sich in der Change Request-Tabelle [change_request]. Datentyp: Zeichenfolge |
| 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:
Datentyp: Zeichenfolge |
| 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.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter HTTP-Antwortcodesder REST-API.
| 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. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare der Felder, die in der Change Request-Aufgabe erstellt wurden. Datentyp: Objekt |
| übergeordnet | Informationen für den Change Request, der der Aufgabe zugeordnet ist. Datentyp: Objekt |
| parent.display_value | Informationen, die in der Benutzeroberfläche für den mit der Aufgabe verknüpften Change Request angezeigt werden sollen. Datentyp: Zeichenfolge |
| parent.value | Sys_id des Change Request, der der Aufgabe zugeordnet ist. Datentyp: Zeichenfolge |
| sys_id | Sys_id-Informationen der neu erstellten Change Request-Aufgabe. Datentyp: Objekt |
| sys_id.display_value | Sys_id der Change Request-Aufgabe, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_id.value | Sys_id der Change Request-Aufgabe. Datentyp: Zeichenfolge |
| __meta.ignorierteFelder | Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change Request angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden 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"]
}
]
}