Change-Management-API
Die Change-Management Die API stellt Endpunkte bereit, die die Integration von Drittpartei-Anwendungen mit ermöglichen ServiceNow Change-Management Prozess.
Verwenden Sie diese REST-API, um Ihren Change-Management-Prozess in externe Anwendungen und bei der Entwicklung zu integrieren ServiceNow Clientseitige Anwendungen.
Mit dieser REST-API können Integratoren:
- Initiieren Sie eine Standard-Change-Anforderung aus einer veröffentlichten Standard-Change-Anforderungsvorlage.
- Erstellen Sie eine Change-Anforderung vom Typ „Notfall“ oder „Normal“.
- Aktualisieren Sie alle Felder, die in der Change-Anforderungstabelle für jede Change-Anforderung vorhanden sind.
- Aktualisieren Sie alle Felder, die in der Change-Aufgabentabelle und Arbeitsaufgaben vorhanden sind, von der Erstellung bis zum Abschluss/Abbruch.
- Ruft eine bestimmte Change-Anforderung, eine Standardvorlage, eine Change-Anforderungsaufgabe oder ein Change-Modell ab.
- Ruft mehrere Change-Anforderungen, Standardvorlagen und Change-Anforderungsaufgaben mithilfe der Paginierung ab.
- Führen Sie eine Risikobewertung durch.
- Aktualisieren Sie die betroffenen Services.
- Generieren und verarbeiten Sie alle zugehörigen Genehmigungsaktivitäten, die einer Change-Anforderung zugeordnet sind.
- Identifizieren Sie potenzielle Planungskonflikte, und identifizieren Sie Zeiträume, in denen keine Konflikte vorhanden sind.
- Löschen Sie Change-Anforderungen, Change-Anforderungsaufgaben und Konfliktprüfungsprozesse.
- Erstellen Sie einen Change-Anforderungsdatensatz basierend auf einem Change-Modell-Datensatz.
- Ruft eine Liste der verfügbaren status für die angegebene Change-Anforderung ab, einschließlich des aktuellen Status.
- Traditionelle ITIL-Typen: Standard, Notfall und Normal.
- status des Change-Modells: Neu, geplant, Implementieren, Überprüfen und Geschlossen.
Sie können zusätzliche Change-Modelle in konfigurieren ServiceNow Instanz und erstellt dann Change-Anforderungen basierend auf diesen Change-Modellen, die Endpunkte in dieser API verwenden. Verwenden Sie Change-Management – GET /sn_chg_Rest/Change/model/{sys_ID} Und Change-Management – GET /sn_chg_Rest/Change/model Endpunkte zum Abrufen der verfügbaren Change-Modelle in einer Instanz. Verwenden Sie dann Change-Management – NACH /sn_chg_Rest/Change Dient zum Erstellen einer Change-Anforderung basierend auf einem angegebenen Change-Modell.
Informationen zum Konfigurieren von Change-Modellen finden Sie unter Konfigurieren Sie Das Change-Management .
- LÖSCHEN: Change_Manager oder admin
- RUFT AB: Change_Manager, itil, sn_Change_read oder admin
- PATCH/POST: Change_Manager, itil oder admin
Darüber hinaus können Administratoren Change-Eigenschaften festlegen, um das Verhalten des Change-Managements zu konfigurieren. Eine Liste dieser Eigenschaften und eine Beschreibung ihrer verfügbaren Funktionalität finden Sie unter Change-Management-Eigenschaften .
Change-Management: LÖSCHEN SIE /sn_chg_Rest/Change/{Change_sys_ID}/Aufgabe/{Task_sys_ID}
Löscht die durch die angegebenen sys_IDs identifizierte Change-Anforderungsaufgabe.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/Aufgabe/{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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | SYS_ID der Change-Anforderung, der die Aufgabe zugeordnet ist. Überprüft, ob die Aufgabe tatsächlich der angegebenen Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| task_sys_id | SYS_ID der zu löschenden Change-Anforderungsaufgabe. Datentyp: Zeichenfolge Tabelle: Change-Aufgaben [Change_Task] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Alle Felder (Schlüssel) mit ihren zugehörigen Werten für die identifizierte Change-Anforderungsaufgabe vor dem Löschen. Datentyp: Objekt |
| übergeordnet | Informationen für die Change-Anforderung, der diese Aufgabe zugeordnet war. Datentyp: Objekt |
| Parent.Display_value | SYS_ID der übergeordneten Aufgabe, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| Übergeordnet.Wert | SYS_ID der übergeordneten Aufgabe. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen für die gelöschte Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire both nodes",
display_value: "Retire both nodes"
}
}
]
}
Change-Management: LÖSCHEN SIE /sn_chg_Rest/Change/{sys_ID}
Löscht die Change-Anforderung, die der angegebenen sys_ID zugeordnet ist
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}
Standard-URL: /api/sn_chg_Rest/Change/{sys_ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des zu löschenden Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Datensatz der Change-Anforderung, der gelöscht wurde. Jedes Element in diesem Objekt entspricht einem Feld im Datensatz der Tabelle „Change-Anforderung“ [Change_Request]. Datentyp: Objekt |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
"result":
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Reboot the server at 6 am",
"value": "Reboot the server at 6 am"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "b0dbda5347c12200e0ef563dbb9a718f",
"value": "b0dbda5347c12200e0ef563dbb9a718f"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
}
Change-Management: LÖSCHEN SIE /sn_chg_Rest/Change/{sys_ID}/Konflikt
Bricht den laufenden Konfliktprüfungsprozess für die angegebene Change-Anforderung (sys_ID) ab.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/Konflikt
Standard-URL: /api/sn_chg_Rest/Change/{sys_ID}/Konflikt
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des Change-Anforderungsdatensatzes, für den der laufende Konfliktprüfungsprozess abgebrochen werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Keine |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Abbruchanforderung fehlgeschlagen. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Keine |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request DELETE \
--user "username":"password"
None
Change-Management: LÖSCHEN SIE /sn_chg_Rest/Change/Emergency/{sys_ID}
Löscht die Notfall-Change-Anforderung, die durch die angegebene sys_ID identifiziert wurde
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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der zu löschenden Notfall-Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change-Anforderung [ Change_Request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Werte für alle Felder in der zugehörigen Change-Anforderung. Datentyp: Objekt |
| Status | Status der Change-Anforderung vor dem Löschen. Datentyp: Objekt |
| status.Anzeigewert | Status, der in der Anwenderoberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "b0dbda5347c12200e0ef563dbb9a718f",
display_value: "b0dbda5347c12200e0ef563dbb9a718f"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
},
},
]
}
Change-Management: LÖSCHEN SIE /sn_chg_Rest/Change/normal/{sys_ID}
Löscht die normale Change-Anforderung, die durch die angegebene 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der normalen zu löschenden Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Werte für alle Felder in der zugehörigen Change-Anforderung. Datentyp: Objekt |
| Status | Status der Change-Anforderung vor dem Löschen. Datentyp: Objekt |
| status.Anzeigewert | Status, der in der Anwenderoberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in der Anwenderoberfläche angezeigt werden soll. Wert ist immer „normal“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „normal“. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
},
},
]
}
Change-Management: LÖSCHEN SIE /sn_chg_Rest/Change/Standard/{sys_ID}
Löscht die Standard-Change-Anforderung, die durch die angegebene 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der zu löschenden Standard-Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Alle Felder (Schlüssel) mit ihren zugehörigen Werten für die identifizierte Change-Anforderung. |
| Status | Status der Change-Anforderung vor dem Löschen. Datentyp: Objekt |
| status.Anzeigewert | Status, der in der Anwenderoberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | Eindeutiger Bezeichner der Change-Anforderung. |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177" \
--request DELETE \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "1c87925347c12200e0ef563dbb9a7177",
state: {
value: "-5",
display_value: "New"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
]
}
Change-Management – GET /sn_chg_Rest/Change/ci/{cmdb_ci_sys_id}/schedule
Ermöglicht das Abrufen verfügbarer Zeitfenster nach Konfigurationselement-ID und Dauer mit der Option, die geplante Startzeit einzubeziehen.
Erforderliche Rolle: sn_Change_Writer.
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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| cmdb_ci_sys_id | SYS_ID des Konfigurationselementdatensatzes. Für diesen Endpunkt ist keine Change-Anforderung erforderlich. Datentyp: Zeichenfolge Tabelle: Konfigurationselemente [cmdb_ci] |
| Name | Beschreibung |
|---|---|
| Duration_in_seconds | Dauer des Change in Sekunden, d. h. wie viel Zeit zum Abschließen der Change-Anforderungsaufgabe erforderlich ist. Datentyp: Ganzzahl |
| Planned_Start_time | Optional. Datum und Uhrzeit, zu der die Implementierung der Change-Anforderung in UTC beginnen soll. Rufen Sie das verfügbare Zeitfenster ab, das um oder nach diesem Zeitpunkt beginnt. Wenn nicht angegeben, verwendet das System die aktuelle Zeit als Startzeit. Format: jjjj-mm-tt hh:mm:ss Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 202 | Das System hat die Anforderung akzeptiert. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Mögliche Probleme:
|
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Fehler | Informationen zu Fehlern, die beim Verarbeiten der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| error.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.Fehlernachrichten | Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Datentyp: Array |
| messages.infoMessages | Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Datentyp: Array |
| Nachrichten.WarnungsNachrichten | Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Datentyp: Array |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt |
| status.Anzeigewert | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| status.Wert | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| Typ | Typ der Anforderung. Gültiger Wert: Zeitplan Datentyp: Zeichenfolge |
| Mitarbeiter | Informationen zum zugeordneten Mitarbeiter. Datentyp: Objekt |
| Worker.Link | Link zum Abrufen von Zeitfensterdaten. Verwenden Sie die sys_ID in RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Zum Anzeigen von Ergebnissen. Datentyp: Zeichenfolge |
| Worker.sysId | SYS_ID des Worker, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge |
| Status | Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
Rufen Sie verfügbare Zeitfenster ab
Verwenden Sie den in angegebenen Wert worker.linkZum Abrufen von Zeitplanfensterdetails. 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 RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Zum Anzeigen von Ergebnissen.
Der Antworttext enthält den Status und liefert Ergebnisse, wenn die Verarbeitung abgeschlossen ist.
- Wenn das angegebene Zeitfenster für die Change-Anforderung innerhalb des Zeitfensters verfügbar ist, listet die Worker-API die verfügbaren Zeitfenster in auf payload.spans Eigenschaft. Die payload.spans Eigenschaft ist andernfalls nicht in den Ergebnissen aufgeführt.
- Wenn innerhalb des definierten Zeitfensters keine Zeitfenster für die angegebene Dauer der Change-Anforderung verfügbar sind, wird messages.infoMessages gibt Folgendes an:
DHinweis:Der Standardwert für das Zeitfenster für die Change-Anforderung ist 90 Tage. Um diesen Wert zu ändern, ändern Sie change.conflict.next_available.schedule_windowEigenschaft. Weitere Informationen finden Sie unter Konfigurieren Sie Konfliktanalyseeigenschaften .
Folgendes RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Das Beispiel zeigt die Ausgabe, die mithilfe der im Worker.Link-Detail angegebenen ID bereitgestellt wird. Die offene Zeitspannen der Ergebnisliste, die für die Aufgabendauer verfügbar sind.
{
"result": {
"worker": {
"sysId": "d7d1f2b4a444b010f87712198fe9caae",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/d7d1f2b4a444b010f87712198fe9caae"
},
"request": "{\"cmdb_ci_sys_id\":\"82967cdd0ad3370236092104ce988d76\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
},
"payload": {
"spans": [
{
"start": {
"value": "2021-05-15 08:00:00",
"display_value": "2021-05-15 01:00:00"
},
"end": {
"value": "2021-05-15 11:00:00",
"display_value": "2021-05-15 04:00:00"
}
},
{
"start": {
"value": "2021-05-22 08:00:00",
"display_value": "2021-05-22 01:00:00"
},
"end": {
"value": "2021-05-22 11:00:00",
"display_value": "2021-05-22 04:00:00"
}
},
...
]
}
}
}
cURL-Anforderung
curl "https://instance.service-now.com/api/sn_chg_rest/change/ci/<cmdb_ci_sys_id>/schedule?duration_in_seconds=10800" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Ergebnisse enthalten Worker.Link-Details, die Sie verwenden können, um die angegebene sys_ID im Endpunkt GET /sn_chg_Rest/Change/Worker/ auszuführen.
{
"result": {
"worker": {
"sysId": "1049419c1b4c3010f58a6572604bcb7a",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/1049419c1b4c3010f58a6572604bcb7a"
},
"request": "{\"cmdb_ci_sys_id\":\"<cmdb_ci_sys_id>\",\"planned_start_time\":\"\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}
Change-Management – GET /sn_chg_Rest/Change
Ruft eine oder mehrere Change-Anforderungen basierend auf den angegebenen Kriterien ab.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change
Standard-URL: /api/sn_chg_Rest/Change
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare, die zum Filtern des Ergebnissatzes verwendet werden sollen. Der Name ist das Feld, nach dem der angegebene Wert gefiltert wird. Dieser Parameter schließt sich gegenseitig aus sysparm_query. Beispiel: Anstatt zu verwenden &Sysparm_query=Active=true , Sie können die aufrufende Anweisung vereinfachen, indem Sie verwenden &Active=wahr . Sie können den Anzeigewert auch verwenden, wenn das Feld ein Auswahl- oder Referenztypfeld ist, z. B. &Status=Geschlossen Anstelle von &Status=7 . Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie jedes durch ein und-Zeichen, z. B. &Active=wahr&assigned_to=john.smith . Datentyp: Zeichenfolge |
| Bestellen | Feld, nach dem die zurückgegebenen Change-Anforderungen sortiert werden sollen. Datentyp: Zeichenfolge Standard: Name |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage Wird verwendet, um den Ergebnissatz zu filtern. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: Sysparm_query=<col_name> <operator> <value> . Bei Spaltennamen, Operatoren und Werten wird zwischen Groß- und Kleinschreibung unterschieden.
Abfragen können mehrere Bedingungen enthalten. Die folgende Abfrage gibt beispielsweise Datensätze zurück, bei denen der Anrufer der aktuelle Anwender ist und der Datensatz aktiv ist.
Codierte Abfragen unterstützen auch die Funktion zum Sortieren nach aufsteigender und absteigender Reihenfolge. Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie Syntax:
Die folgende Abfrage ruft beispielsweise alle aktiven Datensätze ab und ordnet die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie an.
Wenn ein Teil einer Abfrage ungültig ist, z. B. ein ungültiger Feldname, ignoriert die Instanz standardmäßig das ungültige Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Legen Sie die Eigenschaft fest glide.invalid_query.returns_no_rowsBis Wahr Um stattdessen keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| Textsuche | Zeichenfolge, die zum Durchsuchen aller normalen Change-Anforderungsdatensatzfelder verwendet werden soll. Diese Suche verwendet ServiceNow Funktionalität der Volltextsuchplattform. Weitere Informationen zu finden ServiceNow Suchfähigkeiten, siehe Suchverwaltung . Standard: IR_AND_OR_QUERY |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Element | Beschreibung |
|---|---|
| Ergebnis | Liste, die mindestens ein Change-Anforderungsdatensatz-Objekt enthält. Jedes Objekt beschreibt eine Change-Anforderung. Jedes Element im Change-Anforderungsobjekt entspricht einem Feld im zugehörigen Datensatz in der Tabelle „Change-Anforderung“ [Change_Request]. Alle Elemente enthalten Wert Und Display_value Name-Wert-Paare. Datumsfelder enthalten ebenfalls Display_value_internal Name-Wert-Paare. Datentyp: Array |
| action_status | Aktueller Aktionsstatus der zugehörigen Change-Anforderung. Mögliche Werte:
Datentyp: Zahl |
| aktiv | Kennzeichnung, die angibt, ob die Change-Anforderung aktiv ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: wahr |
| Activity_due | Datum und Uhrzeit, für die der zugeordnete Fall voraussichtlich abgeschlossen sein soll. Datentyp: Zeichenfolge |
| Zusätzliche_Beauftragte_Liste | Liste der sys_IDs zusätzlicher Personen, die der Arbeit an der Change-Anforderung zugewiesen sind. Datentyp: Array |
| Genehmigung | Typ des erforderlichen Genehmigungsprozesses. Datentyp: Zeichenfolge Standard: Nicht angefordert |
| Approval_history | Letzter Journaleintrag für Genehmigungsverlauf. Datentyp: Zeichenfolge |
| Approval_Set | Datum und Uhrzeit der Genehmigung der zugeordneten Aktion. Datentyp: Zeichenfolge |
| assigned_to | SYS_ID des Anwenders, der der Change-Anforderung zugewiesen ist. Datentyp: Zeichenfolge |
| assignment_group | SYS_ID der Gruppe, die der Change-Anforderung zugewiesen ist. Datentyp: Zeichenfolge |
| Backout_Plan | Beschreibung des auszuführenden Plans, wenn der Change rückgängig gemacht werden muss. Datentyp: Zeichenfolge |
| Business_duration | Dauer in geplanten Arbeitsstunden, Arbeitstagen und Arbeitswochen, die zum Abschluss des Change benötigt wurde. Datentyp: Zeichenfolge |
| Business_Service | SYS_ID des Business-Service, der der Change-Anforderung zugeordnet ist. Befindet sich in der Tabelle „Service“ [cmdb_ci_Service]. Datentyp: Zeichenfolge |
| Cab_date | Datum, an dem der Change-Beratungsausschuss (CAB) zusammentritt. Datentyp: Zeichenfolge |
| Cab_Delegate | SYS_ID des Anwenders, der den CAB-Manager während einer CAB-Besprechung ersetzen kann. Befindet sich in der Anwendertabelle [sys_user] Datentyp: Zeichenfolge |
| Cab_Recommendation | Beschreibung der CAB-Empfehlungen für die Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Cab_required | Kennzeichnung, die angibt, ob das CAB erforderlich ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Calendar_duration | Derzeit nicht verwendet von Change-Management. Datentyp: Zeichenfolge |
| Kategorie | Kategorie des Change, z. B. Hardware, Netzwerk oder Software. Datentyp: Zeichenfolge Standard: Sonstiges |
| Change_Plan | Aktivitäten und Rollen für die Verwaltung und Steuerung der Change-Anforderung. Datentyp: Zeichenfolge |
| chg_model | SYS_ID des Change-Modells, auf dem die zugehörige Change-Anforderung basiert. Das Change-Modell definiert den Status-Flow, die Übergänge und die Prozessaktivitäten, die für die Change-Anforderung abgeschlossen werden müssen. Datentyp: Zeichenfolge Tabelle: Change-Modell [chg_model] |
| Closed_at | Datum und Uhrzeit, zu der die zugehörige Change-Anforderung geschlossen wurde. Datentyp: Zeichenfolge |
| Closed_by | SYS_ID der Person, die die Change-Anforderung geschlossen hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| close_code | Code, der der Change-Anforderung zugewiesen wurde, als sie geschlossen wurde. Beispiel: Erfolgreich, erfolgreich mit Problemen und nicht erfolgreich. Datentyp: Zeichenfolge |
| close_notes | Merkt an, dass die Person beim Schließen der Change-Anforderung eingegeben hat. Datentyp: Zeichenfolge |
| cmdb_ci | SYS_ID des Konfigurationselements, das der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Konfigurationselement [cmdb_ci] |
| Kommentare | Liste der kundenorientierten Arbeitsnotizen, die in der zugehörigen Change-Anforderung eingegeben wurden. Datentyp: Array |
| comments_and_work_notes | Liste der internen und kundenorientierten Arbeitsnotizen, die für die zugehörige Change-Anforderung eingegeben wurden. Datentyp: Array Maximale Länge: 4.000 |
| Unternehmen | SYS_ID des Unternehmens, das der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Unternehmen [Core_Company] |
| Conflict_Last_Run | Datum und Uhrzeit der letzten Ausführung des Konflikterkennungsskripts für die Change-Anforderung. Datentyp: Zeichenfolge |
| Conflict_Status | Aktueller Konfliktstatus, der vom Konflikterkennungsskript erkannt wird, z. B. Konflikt und nicht ausgeführt. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Nicht Ausgeführt |
| Contact_type | Methode, mit der die Change-Anforderung anfänglich angefordert wurde. Mögliche Werte:
Datentyp: Zeichenfolge |
| contract | SYS_ID des Vertrags, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Vertrag [ast_Contract] |
| Correlation_Display | Anwenderfreundlicher Name für correlation_id. Datentyp: Zeichenfolge Maximale Länge: 100 |
| correlation_id | Global eindeutige ID (GUID) eines übereinstimmenden Change-Anforderungsdatensatzes in einem Drittparteisystem. Datentyp: Zeichenfolge Maximale Länge: 100 |
| Delivery_Plan | Wird nicht mehr verwendet. SYS_ID des Bereitstellungsplans, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Ausführungsplan [sc_cat_item_delivery_plan] |
| Delivery_Task | Wird nicht mehr verwendet. SYS_ID der Bereitstellungsaufgabe, die der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Ausführungsplanaufgabe [sc_cat_item_delivery_task] |
| Beschreibung | Detaillierte Beschreibung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| due_date | Fälligkeitsdatum der Aufgabe. 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 (Ganzzahl) Standard: 0 |
| expected_start | Datum und Uhrzeit des Starts der Aufgabe. Wird vom Change-Anforderungsprozess nicht verwendet. Datentyp: Zeichenfolge |
| follow_up | Datum und Uhrzeit, zu der ein Anwender mit der Person nachverfolgt hat, die die Change-Anforderung anfordert. Datentyp: Zeichenfolge |
| Group_list | Liste der sys_IDs und Namen der Gruppen, die der Change-Anforderung zugeordnet sind. Datentyp: Array Maximale Länge: 4.000 |
| Impact | Auswirkungen auf die Change-Anforderung auf den Kunden. Mögliche Werte:
Datentyp: Zahl (Ganzzahl) Standard: 3 |
| Implementation_Plan | Sequenzielle Schritte, die zur Implementierung dieses Change ausgeführt werden sollen. Enthält auch alle Abhängigkeiten zwischen Schritten und Details zum Beauftragten für jeden Schritt. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Begründung | Vorteile der Implementierung dieses Change und die Auswirkungen, wenn dieser Change nicht implementiert wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Wissen | Kennzeichnung, die angibt, ob der Change-Anforderung Knowledge Base-Artikel ()KB-Artikel zugeordnet sind. Mögliche Werte:
Datentyp: Boolesch |
| location | SYS_ID und Name des Standorts der Ausrüstung, auf die in der Change-Anforderung verwiesen wird. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] |
| Made_sla | Nicht mehr verwendet. Kennzeichnung, die angibt, ob die Change-Anforderung in Übereinstimmung mit der zugehörigen Servicelevel-Vereinbarung implementiert wurde. Datentyp: Boolesch |
| Needs_Attention | Kennzeichnung, die angibt, ob die Change-Anforderung Aufmerksamkeit erfordert. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Nummer | Change-Nummer, die der Change-Anforderung vom System zugewiesen ist, z. B. CHG0040007. Datentyp: Zeichenfolge |
| on_hold | Kennzeichnung, die angibt, ob die Change-Anforderung derzeit angehalten ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| On_hold_reason | Wenn on_holdParameter ist „wahr“, Beschreibung des Grunds, aus dem die Change-Anforderung angehalten wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| On_hold_Task | Wenn on_holdParameter ist „wahr“, Liste der sys_IDs der Aufgaben, die abgeschlossen werden müssen, bevor die Sperre freigegeben wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Geöffnet_um | Datum und Uhrzeit der Erstellung des Change-Release. Datentyp: Zeichenfolge |
| opened_by | SYS_ID und Name des Anwenders, der das Change-Release erstellt hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Bestellen | Nicht verwendet von Change-Management. Optionales numerisches Feld, nach dem Datensätze sortiert werden sollen, z. B. beim Abrufen aus einer Datenbank. Datentyp: Zahl (Ganzzahl) |
| Outside_Maintenance_schedule | Kennzeichnung, die angibt, ob die Wartung durch ein externes Unternehmen für die Change-Anforderung geplant wurde. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| übergeordnet | SYS_ID und Name der übergeordneten Aufgabe für diese Change-Anforderung, falls vorhanden. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe] |
| phase | Aktuelle Phase der Change-Anforderung. Dies definiert detaillierter, was der Change bewirkt. Mögliche Werte:
Datentyp: Zeichenfolge |
| Phase_Status | Change_Phase-Datensätze, die für einen Change erstellt werden sollen. Sie sind von der Kategorie abhängig, sodass jeder Change-Typ verschiedene Change_Phase-Datensätze haben kann. Die Change_Phase-Datensätze bieten eine Möglichkeit, den Genehmigungsprozess zu steuern, da jede Change_Phase einen Zeitplan und eine Reihe von Genehmigern haben kann. Mögliche Werte:
Datentyp: Zeichenfolge |
| Priorität | Priorität der Change-Anforderung. Mögliche Werte:
Datentyp: Zahl (Ganzzahl) Standard: 4 |
| Produktionssystem | Kennzeichnung, die angibt, ob die Change-Anforderung für gilt ServiceNow Instanz, die sich in einer Produktionsumgebung befindet. 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 der Neuzuweisungen der Change-Anforderung an einen neuen Besitzer. Datentyp: Zahl (Ganzzahl) Standard: 0 |
| Rejection_Goto | SYS_ID der auszuführenden Aufgabe, wenn die Change-Anforderung abgelehnt wird. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe] |
| Angefordert_von | SYS_ID des Anwenders, der den Change angefordert hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Request_by_date | Datum und Uhrzeit, zu der die Implementierung des Change angefordert wird. Datentyp: Zeichenfolge |
| Review_comments | Kommentare, die bei der Überprüfung der Change-Anforderung eingegeben wurden. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Review_date | Datum, an dem die Change-Anforderung überprüft wurde. Datentyp: Zeichenfolge |
| Review_Status | Aktueller Status der angeforderten Überprüfung der Change-Anforderung. Datentyp: Zeichenfolge |
| Risiko | Risikostufe, die der Change-Anforderung zugeordnet ist. Gültige Werte:
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 Servicelevel in Bezug auf Verfügbarkeit, Umfang, Preise und Verpackungsoptionen eindeutig. Datentyp: Zeichenfolge Tabelle: Angebot [Service_Offering] |
| short_description | Beschreibung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Kompetenzen | Liste der sys_IDs aller Kompetenzen, die zum Implementieren der Change-Anforderung erforderlich sind. Datentyp: Array Tabelle: Kompetenz [cmn_Skill] |
| sla_due | Wird nicht mehr verwendet. Datum und Uhrzeit, zu der die Change-Anforderung basierend auf der zugehörigen Servicelevel-Vereinbarung abgeschlossen werden muss. Datentyp: Zeichenfolge |
| sn_esign_document | SYS_ID eines E-signierten Dokuments, das an die Change-Anforderung angehängt ist. Datentyp: Zeichenfolge Tabelle: Anhang [sys_attachment] |
| sn_esign_esignature_configuration | SYS_ID der E-Signaturvorlage, die für das zugehörige Dokument verwendet wird. Datentyp: Zeichenfolge Tabelle: E-Signatur-Vorlage [sn_esign_Configuration] |
| start_date | Datum und Uhrzeit, zu der die Implementierung der Change-Anforderung beginnen soll. Datentyp: Zeichenfolge |
| Status | Aktueller Status der Change-Anforderung. Mögliche Werte sind im Change-Modell definiert. Datentyp: Zahl (Ganzzahl) Standard: 1 |
| std_change_producer_version | SYS_ID des Datensatzerstellers und des Change-Vorschlags, die der Change-Anforderung zugeordnet sind. Enthält auch die Anzahl und den Prozentsatz erfolgreicher und nicht erfolgreicher Change-Anforderungen, die aus dem Vorschlag erstellt wurden. Datentyp: Zeichenfolge Tabelle: Standard-Change-Vorlagenversion [std_change_producer_version] |
| sys_class_name | Name der Tabelle, in der sich die Change-Anforderung befindet. Datentyp: Zeichenfolge |
| sys_created_by | Name des Anwenders, der die Change-Anforderung ursprünglich erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_created_on | Datum und Uhrzeit der ursprünglichen Erstellung des zugehörigen Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge |
| sys_Domain | Bei Verwendung von Domänen in der Instanz der Name der Domäne, der der Change-Moduldatensatz zugeordnet ist. Datentyp: Zeichenfolge |
| sys_Domain_path | Bei Verwendung von Domänen in der Instanz der Domänenpfad, in dem sich der zugeordnete Change-Moduldatensatz befindet. Datentyp: Zeichenfolge |
| sys_id | Eindeutiger Bezeichner des zugehörigen Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge |
| sys_mod_count | Anzahl der Updates für den Fall seit der anfänglichen Erstellung. Datentyp: Zahl (Ganzzahl) |
| sys_updated_by | Person, die den Fall zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des Falls. Datentyp: Zeichenfolge |
| Task_EFFECTIVE_number | Universal-Anforderungsnummer. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Aufgabe_für | Nicht verwendet von Change-Management. SYS_ID des Anwenders, für den die Aufgabe erstellt wurde. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Test_Plan | Beschreibung des zugehörigen Testplans für den Change. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Zeit_gearbeitet | Gesamtzeit, die an der Change-Anforderung gearbeitet wurde. Datentyp: Zeichenfolge |
| Typ | 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 Universal-Anforderung, zu der diese Change-Anforderung gehört. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe] |
| On_Approval | Aktion, die ausgeführt werden soll, wenn die Change-Anforderung genehmigt wird. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fortfahren |
| Bei_ablehnen | Auszuführende Aktion, wenn die Change-Anforderung abgelehnt wird. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Abbrechen |
| Dringlichkeit | Dringlichkeit der Change-Anforderung. Mögliche Werte:
Datentyp: Zahl (Ganzzahl) Standard: 3 |
| Anwender_Eingabe | Zusätzliche Anwendereingabe. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| variables | Name-Wert-Paare von Variablen, die der Change-Anforderung zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Watch_list | Liste der sys_IDs der Anwender, die Benachrichtigungen zu dieser Change-Anforderung erhalten, wenn zusätzliche Kommentare hinzugefügt werden oder wenn der Status einer Change-Anforderung in „gelöst“ oder „Geschlossen“ geändert wird. Datentyp: Array Tabelle: Benutzer [sys_user] |
| wf_activity | SYS_ID des Workflow-Aktivitätsdatensatzes, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Workflow-Aktivität [wf_activity] |
| Work_End | Datum und Uhrzeit der Beendigung der Arbeit an der Change-Anforderung. Datentyp: Zeichenfolge |
| work_notes | Informationen darüber, wie die Change-Anforderung gelöst wird, oder Schritte, die zu ihrer Lösung unternommen wurden. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Work_Notes_list | Liste der sys_IDs der internen Anwender, die Benachrichtigungen zu dieser Change-Anforderung erhalten, wenn Arbeitsnotizen hinzugefügt werden. Datentyp: Array Tabelle: Benutzer [sys_user] |
| Work_Start | Datum und Uhrzeit des Beginns der Arbeit an der Change-Anforderung. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Aus Kürze enthalten die Ergebnisse nur einen einzelnen Change-Anforderungsdatensatz.
{
"result": [
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Clear BGP sessions on a Cisco router",
"value": "Clear BGP sessions on a Cisco router"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "1766f1de47410200e90d87e8dee490f6",
"value": "1766f1de47410200e90d87e8dee490f6"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
]
}
Change-Management – GET /sn_chg_Rest/Change/{Change_sys_ID}/nextstates
Ruft eine Liste der verfügbaren status für die angegebene Change-Anforderung ab, einschließlich des aktuellen Status.
Falls verfügbar, bietet es auch den Übergang zum nächsten Status basierend auf der Version des implementierten Change-Managements. Wenn die Changes vom Change-Modell gesteuert werden, gibt der Endpunkt Bedingungen zurück, die bestanden wurden oder nicht. Es enthält auch Informationen darüber, ob alle Bedingungen für einen bestimmten Übergang bestanden wurden. Diese Informationen sind für typgesteuerte und veraltete 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Available_states | Werte für die status, die für die angegebene Change-Anforderung verfügbar sind, einschließlich des aktuellen Status. Datentyp: Array |
| state_label | Schlüssel-Wert-Paare, die Bezeichnungen den verfügbaren status zuordnen. Datentyp: Objekt |
| state_Transitions | Informationen darüber, was für den Übergang zu jedem verfügbaren Status erforderlich ist. Jeder eindeutige verfügbare „bis Status“ ist ein eigener Status Array mit jedem unterschiedlichen Satz von Bedingungen, damit sie in einem eigenen Objekt angegeben werden. 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 zugeordnet sind status . 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.Pass | 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, von dem die Change-Anforderung wechselt. Datentyp: Zeichenfolge |
| state_Transitions.sys_ID | SYS_ID des Übergangsstatus. Datentyp: Zeichenfolge |
| state_Transitions.to_State | Wert des Status, in den die Change-Anforderung übergeht. Datentyp: Zeichenfolge |
| state_Transitions.Transition_available | Kennzeichnung, die angibt, ob die Change-Anforderung 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | SYS_ID der Change-Anforderung, für die das nächste verfügbare Zeitfenster gesucht werden soll. Die ausgewählte Change-Anforderung muss ein Konfigurationselement (cmdb_ci) mit geplanten Start- und Endzeiten aufweisen. Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 202 | Das System hat die Anforderung akzeptiert. |
| 400 | Ungültige 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:
|
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Fehler | Informationen zu Fehlern, die beim Verarbeiten der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| error.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.Fehlernachrichten | Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Datentyp: Array |
| messages.infoMessages | Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Datentyp: Array |
| Nachrichten.WarnungsNachrichten | Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Datentyp: Array |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt |
| status.Anzeigewert | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| status.Wert | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| Typ | Typ der Anforderung. Gültiger Wert: Zeitplan Datentyp: Zeichenfolge |
| Mitarbeiter | Informationen zum zugeordneten Mitarbeiter. Datentyp: Objekt |
| Worker.Link | Link zum Abrufen von Zeitfensterdaten. Verwenden Sie die sys_ID in RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Zum Anzeigen von Ergebnissen. Datentyp: Zeichenfolge |
| Worker.sysId | SYS_ID des Worker, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge |
| Status | Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
Rufen Sie verfügbare Zeitfenster ab
Verwenden Sie den in angegebenen Wert worker.linkZum Abrufen von Zeitplanfensterdetails. 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 RUFEN SIE /sn_chg_Rest/Change/Worker/{Worker_sys_ID} AB Zum Anzeigen von Ergebnissen.
Der Antworttext enthält den Status und liefert Ergebnisse, wenn die Verarbeitung abgeschlossen ist.
- Wenn das angegebene Zeitfenster für die Change-Anforderung innerhalb des Zeitfensters verfügbar ist, listet die Worker-API die verfügbaren Zeitfenster in auf payload.spans Eigenschaft. Die payload.spans Eigenschaft ist andernfalls nicht in den Ergebnissen aufgeführt.
- Wenn innerhalb des definierten Zeitfensters keine Zeitfenster für die angegebene Dauer der Change-Anforderung verfügbar sind, wird messages.infoMessages gibt Folgendes an:
DHinweis:Der Standardwert für das Zeitfenster für die Change-Anforderung ist 90 Tage. Um diesen Wert zu ändern, ändern Sie change.conflict.next_available.schedule_windowEigenschaft. Weitere Informationen finden Sie unter Konfigurieren Sie Konfliktanalyseeigenschaften .
Folgendes RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Das Beispiel zeigt die Ausgabe, die mithilfe der im Worker.Link-Detail angegebenen ID bereitgestellt wird. Die offene Zeitspannen der Ergebnisliste, die für die Aufgabendauer verfügbar sind.
{
"result": {
"worker": {
"sysId": "9b3f62e0a4c87010f87712198fe9cad1",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
},
"payload": {
"spans": [
{
"start": {
"value": "2021-05-08 08:00:00",
"display_value": "2021-05-08 01:00:00"
},
"end": {
"value": "2021-05-08 11:00:00",
"display_value": "2021-05-08 04:00:00"
}
},
{
"start": {
"value": "2021-05-15 08:00:00",
"display_value": "2021-05-15 01:00:00"
},
"end": {
"value": "2021-05-15 11:00:00",
"display_value": "2021-05-15 04:00:00"
}
},
...
]
}
}
}
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/change/{change_sys_id}/schedule" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Ergebnisse enthalten Worker.Link-Details, die Sie verwenden können, um die angegebene sys_ID im Endpunkt GET /sn_chg_Rest/Change/Worker/ auszuführen.
{
"result": {
"worker": {
"sysId": "9b3f62e0a4c87010f87712198fe9cad1",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/9b3f62e0a4c87010f87712198fe9cad1"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}
Change-Management – GET /sn_chg_Rest/Change/{Change_sys_ID}/Task
Ruft eine oder mehrere Aufgaben ab, die einer angegebenen Change-Anforderung zugeordnet sind, basierend auf den angegebenen Kriterien.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/Aufgabe
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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | SYS_ID der Change-Anforderung, deren Aufgaben abgerufen werden sollen. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Schlüssel-Wert-Paare | Felder, die beim Erstellen der Anforderung geändert werden sollen. Der Schlüssel ist der Feldname in der Vorlage, und der Wert ist die Informationen, die im Feld ausgefüllt werden sollen. Felder, die nicht geändert werden können und bei Übergabe ignoriert werden:
Datentyp: Zeichenfolge |
| Bestellen | Feld, nach dem die zurückgegebenen Change-Anforderungen sortiert werden sollen. Datentyp: Zeichenfolge |
| Sysparm_limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 500 |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage Wird verwendet, um den Ergebnissatz zu filtern. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: Sysparm_query=<col_name> <operator> <value> . Bei Spaltennamen, Operatoren und Werten wird zwischen Groß- und Kleinschreibung unterschieden.
Abfragen können mehrere Bedingungen enthalten. Die folgende Abfrage gibt beispielsweise Datensätze zurück, bei denen der Anrufer der aktuelle Anwender ist und der Datensatz aktiv ist.
Codierte Abfragen unterstützen auch die Funktion zum Sortieren nach aufsteigender und absteigender Reihenfolge. Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie Syntax:
Die folgende Abfrage ruft beispielsweise alle aktiven Datensätze ab und ordnet die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie an.
Wenn ein Teil einer Abfrage ungültig ist, z. B. ein ungültiger Feldname, ignoriert die Instanz standardmäßig das ungültige Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Legen Sie die Eigenschaft fest glide.invalid_query.returns_no_rowsBis Wahr Um stattdessen keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| Textsuche | Zeichenfolge, die zum Durchsuchen aller Change-Aufgabendatensatzfelder verwendet werden soll. Diese Suche verwendet ServiceNowVolltextsuche-Plattformfunktionalität und ist standardmäßig auf IR_AND_OR_QUERY .Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Alle Felder (Schlüssel) mit ihren zugehörigen Werten für die identifizierte Change-Anforderungsaufgabe vor dem Löschen. Datentyp: Objekt |
| übergeordnet | Informationen für die Change-Anforderung, die der Aufgabe zugeordnet ist. Datentyp: Objekt |
| Parent.Display_value | Change-Anforderungsinformationen, die in einer Anwenderoberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| Übergeordnet.Wert | SYS_ID der Change-Anforderung, die der Aufgabe zugeordnet ist. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen für die Change-Anforderungsaufgabe. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderungsaufgabe, die in einer Anwenderoberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderungsaufgabe. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe ",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire node",
display_value: "Retire node"
}
},
{ // next record found }, ... // and so on
]
}
Change-Management – GET /sn_chg_Rest/Change/{sys_ID}
Ruft die durch die angegebene sys_ID identifizierte Change-Anforderung ab
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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Element | Beschreibung |
|---|---|
| Ergebnis | Liste, die mindestens ein Change-Anforderungsdatensatz-Objekt enthält. Jedes Objekt beschreibt eine Change-Anforderung. Jedes Element im Change-Anforderungsobjekt entspricht einem Feld im zugehörigen Datensatz in der Tabelle „Change-Anforderung“ [Change_Request]. Alle Elemente enthalten Wert Und Display_value Name-Wert-Paare. Datumsfelder enthalten ebenfalls Display_value_internal Name-Wert-Paare. Datentyp: Array |
| action_status | Aktueller Aktionsstatus der zugehörigen Change-Anforderung. Mögliche Werte:
Datentyp: Zahl |
| aktiv | Kennzeichnung, die angibt, ob die Change-Anforderung aktiv ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: wahr |
| Activity_due | Datum und Uhrzeit, für die der zugeordnete Fall voraussichtlich abgeschlossen sein soll. Datentyp: Zeichenfolge |
| Zusätzliche_Beauftragte_Liste | Liste der sys_IDs zusätzlicher Personen, die der Arbeit an der Change-Anforderung zugewiesen sind. Datentyp: Array |
| Genehmigung | Typ des erforderlichen Genehmigungsprozesses. Datentyp: Zeichenfolge Standard: Nicht angefordert |
| Approval_history | Letzter Journaleintrag für Genehmigungsverlauf. Datentyp: Zeichenfolge |
| Approval_Set | Datum und Uhrzeit der Genehmigung der zugeordneten Aktion. Datentyp: Zeichenfolge |
| assigned_to | SYS_ID des Anwenders, der der Change-Anforderung zugewiesen ist. Datentyp: Zeichenfolge |
| assignment_group | SYS_ID der Gruppe, die der Change-Anforderung zugewiesen ist. Datentyp: Zeichenfolge |
| Backout_Plan | Beschreibung des auszuführenden Plans, wenn der Change rückgängig gemacht werden muss. Datentyp: Zeichenfolge |
| Business_duration | Dauer in geplanten Arbeitsstunden, Arbeitstagen und Arbeitswochen, die zum Abschluss des Change benötigt wurde. Datentyp: Zeichenfolge |
| Business_Service | SYS_ID des Business-Service, der der Change-Anforderung zugeordnet ist. Befindet sich in der Tabelle „Service“ [cmdb_ci_Service]. Datentyp: Zeichenfolge |
| Cab_date | Datum, an dem der Change-Beratungsausschuss (CAB) zusammentritt. Datentyp: Zeichenfolge |
| Cab_Delegate | SYS_ID des Anwenders, der den CAB-Manager während einer CAB-Besprechung ersetzen kann. Befindet sich in der Anwendertabelle [sys_user] Datentyp: Zeichenfolge |
| Cab_Recommendation | Beschreibung der CAB-Empfehlungen für die Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Cab_required | Kennzeichnung, die angibt, ob das CAB erforderlich ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Calendar_duration | Derzeit nicht verwendet von Change-Management. Datentyp: Zeichenfolge |
| Kategorie | Kategorie des Change, z. B. Hardware, Netzwerk oder Software. Datentyp: Zeichenfolge Standard: Sonstiges |
| Change_Plan | Aktivitäten und Rollen für die Verwaltung und Steuerung der Change-Anforderung. Datentyp: Zeichenfolge |
| chg_model | SYS_ID des Change-Modells, auf dem die zugehörige Change-Anforderung basiert. Das Change-Modell definiert den Status-Flow, die Übergänge und die Prozessaktivitäten, die für die Change-Anforderung abgeschlossen werden müssen. Datentyp: Zeichenfolge Tabelle: Change-Modell [chg_model] |
| Closed_at | Datum und Uhrzeit, zu der die zugehörige Change-Anforderung geschlossen wurde. Datentyp: Zeichenfolge |
| Closed_by | SYS_ID der Person, die die Change-Anforderung geschlossen hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| close_code | Code, der der Change-Anforderung zugewiesen wurde, als sie geschlossen wurde. Beispiel: Erfolgreich, erfolgreich mit Problemen und nicht erfolgreich. Datentyp: Zeichenfolge |
| close_notes | Merkt an, dass die Person beim Schließen der Change-Anforderung eingegeben hat. Datentyp: Zeichenfolge |
| cmdb_ci | SYS_ID des Konfigurationselements, das der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Konfigurationselement [cmdb_ci] |
| Kommentare | Liste der kundenorientierten Arbeitsnotizen, die in der zugehörigen Change-Anforderung eingegeben wurden. Datentyp: Array |
| comments_and_work_notes | Liste der internen und kundenorientierten Arbeitsnotizen, die für die zugehörige Change-Anforderung eingegeben wurden. Datentyp: Array Maximale Länge: 4.000 |
| Unternehmen | SYS_ID des Unternehmens, das der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Unternehmen [Core_Company] |
| Conflict_Last_Run | Datum und Uhrzeit der letzten Ausführung des Konflikterkennungsskripts für die Change-Anforderung. Datentyp: Zeichenfolge |
| Conflict_Status | Aktueller Konfliktstatus, der vom Konflikterkennungsskript erkannt wird, z. B. Konflikt und nicht ausgeführt. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Nicht Ausgeführt |
| Contact_type | Methode, mit der die Change-Anforderung anfänglich angefordert wurde. Mögliche Werte:
Datentyp: Zeichenfolge |
| contract | SYS_ID des Vertrags, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Vertrag [ast_Contract] |
| Correlation_Display | Anwenderfreundlicher Name für correlation_id. Datentyp: Zeichenfolge Maximale Länge: 100 |
| correlation_id | Global eindeutige ID (GUID) eines übereinstimmenden Change-Anforderungsdatensatzes in einem Drittparteisystem. Datentyp: Zeichenfolge Maximale Länge: 100 |
| Delivery_Plan | Wird nicht mehr verwendet. SYS_ID des Bereitstellungsplans, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Ausführungsplan [sc_cat_item_delivery_plan] |
| Delivery_Task | Wird nicht mehr verwendet. SYS_ID der Bereitstellungsaufgabe, die der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Ausführungsplanaufgabe [sc_cat_item_delivery_task] |
| Beschreibung | Detaillierte Beschreibung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| due_date | Fälligkeitsdatum der Aufgabe. 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 (Ganzzahl) Standard: 0 |
| expected_start | Datum und Uhrzeit des Starts der Aufgabe. Wird vom Change-Anforderungsprozess nicht verwendet. Datentyp: Zeichenfolge |
| follow_up | Datum und Uhrzeit, zu der ein Anwender mit der Person nachverfolgt hat, die die Change-Anforderung anfordert. Datentyp: Zeichenfolge |
| Group_list | Liste der sys_IDs und Namen der Gruppen, die der Change-Anforderung zugeordnet sind. Datentyp: Array Maximale Länge: 4.000 |
| Impact | Auswirkungen auf die Change-Anforderung auf den Kunden. Mögliche Werte:
Datentyp: Zahl (Ganzzahl) Standard: 3 |
| Implementation_Plan | Sequenzielle Schritte, die zur Implementierung dieses Change ausgeführt werden sollen. Enthält auch alle Abhängigkeiten zwischen Schritten und Details zum Beauftragten für jeden Schritt. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Begründung | Vorteile der Implementierung dieses Change und die Auswirkungen, wenn dieser Change nicht implementiert wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Wissen | Kennzeichnung, die angibt, ob der Change-Anforderung Knowledge Base-Artikel ()KB-Artikel zugeordnet sind. Mögliche Werte:
Datentyp: Boolesch |
| location | SYS_ID und Name des Standorts der Ausrüstung, auf die in der Change-Anforderung verwiesen wird. Datentyp: Zeichenfolge Tabelle: Standort [cmn_location] |
| Made_sla | Nicht mehr verwendet. Kennzeichnung, die angibt, ob die Change-Anforderung in Übereinstimmung mit der zugehörigen Servicelevel-Vereinbarung implementiert wurde. Datentyp: Boolesch |
| Needs_Attention | Kennzeichnung, die angibt, ob die Change-Anforderung Aufmerksamkeit erfordert. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Nummer | Change-Nummer, die der Change-Anforderung vom System zugewiesen ist, z. B. CHG0040007. Datentyp: Zeichenfolge |
| on_hold | Kennzeichnung, die angibt, ob die Change-Anforderung derzeit angehalten ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| On_hold_reason | Wenn on_holdParameter ist „wahr“, Beschreibung des Grunds, aus dem die Change-Anforderung angehalten wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| On_hold_Task | Wenn on_holdParameter ist „wahr“, Liste der sys_IDs der Aufgaben, die abgeschlossen werden müssen, bevor die Sperre freigegeben wird. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Geöffnet_um | Datum und Uhrzeit der Erstellung des Change-Release. Datentyp: Zeichenfolge |
| opened_by | SYS_ID und Name des Anwenders, der das Change-Release erstellt hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Bestellen | Nicht verwendet von Change-Management. Optionales numerisches Feld, nach dem Datensätze sortiert werden sollen, z. B. beim Abrufen aus einer Datenbank. Datentyp: Zahl (Ganzzahl) |
| Outside_Maintenance_schedule | Kennzeichnung, die angibt, ob die Wartung durch ein externes Unternehmen für die Change-Anforderung geplant wurde. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| übergeordnet | SYS_ID und Name der übergeordneten Aufgabe für diese Change-Anforderung, falls vorhanden. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe] |
| phase | Aktuelle Phase der Change-Anforderung. Dies definiert detaillierter, was der Change bewirkt. Mögliche Werte:
Datentyp: Zeichenfolge |
| Phase_Status | Change_Phase-Datensätze, die für einen Change erstellt werden sollen. Sie sind von der Kategorie abhängig, sodass jeder Change-Typ verschiedene Change_Phase-Datensätze haben kann. Die Change_Phase-Datensätze bieten eine Möglichkeit, den Genehmigungsprozess zu steuern, da jede Change_Phase einen Zeitplan und eine Reihe von Genehmigern haben kann. Mögliche Werte:
Datentyp: Zeichenfolge |
| Priorität | Priorität der Change-Anforderung. Mögliche Werte:
Datentyp: Zahl (Ganzzahl) Standard: 4 |
| Produktionssystem | Kennzeichnung, die angibt, ob die Change-Anforderung für gilt ServiceNow Instanz, die sich in einer Produktionsumgebung befindet. 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 der Neuzuweisungen der Change-Anforderung an einen neuen Besitzer. Datentyp: Zahl (Ganzzahl) Standard: 0 |
| Rejection_Goto | SYS_ID der auszuführenden Aufgabe, wenn die Change-Anforderung abgelehnt wird. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe] |
| Angefordert_von | SYS_ID des Anwenders, der den Change angefordert hat. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Request_by_date | Datum und Uhrzeit, zu der die Implementierung des Change angefordert wird. Datentyp: Zeichenfolge |
| Review_comments | Kommentare, die bei der Überprüfung der Change-Anforderung eingegeben wurden. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Review_date | Datum, an dem die Change-Anforderung überprüft wurde. Datentyp: Zeichenfolge |
| Review_Status | Aktueller Status der angeforderten Überprüfung der Change-Anforderung. Datentyp: Zeichenfolge |
| Risiko | Risikostufe, die der Change-Anforderung zugeordnet ist. Gültige Werte:
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 Servicelevel in Bezug auf Verfügbarkeit, Umfang, Preise und Verpackungsoptionen eindeutig. Datentyp: Zeichenfolge Tabelle: Angebot [Service_Offering] |
| short_description | Beschreibung der Change-Anforderung. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Kompetenzen | Liste der sys_IDs aller Kompetenzen, die zum Implementieren der Change-Anforderung erforderlich sind. Datentyp: Array Tabelle: Kompetenz [cmn_Skill] |
| sla_due | Wird nicht mehr verwendet. Datum und Uhrzeit, zu der die Change-Anforderung basierend auf der zugehörigen Servicelevel-Vereinbarung abgeschlossen werden muss. Datentyp: Zeichenfolge |
| sn_esign_document | SYS_ID eines E-signierten Dokuments, das an die Change-Anforderung angehängt ist. Datentyp: Zeichenfolge Tabelle: Anhang [sys_attachment] |
| sn_esign_esignature_configuration | SYS_ID der E-Signaturvorlage, die für das zugehörige Dokument verwendet wird. Datentyp: Zeichenfolge Tabelle: E-Signatur-Vorlage [sn_esign_Configuration] |
| start_date | Datum und Uhrzeit, zu der die Implementierung der Change-Anforderung beginnen soll. Datentyp: Zeichenfolge |
| Status | Aktueller Status der Change-Anforderung. Mögliche Werte sind im Change-Modell definiert. Datentyp: Zahl (Ganzzahl) Standard: 1 |
| std_change_producer_version | SYS_ID des Datensatzerstellers und des Change-Vorschlags, die der Change-Anforderung zugeordnet sind. Enthält auch die Anzahl und den Prozentsatz erfolgreicher und nicht erfolgreicher Change-Anforderungen, die aus dem Vorschlag erstellt wurden. Datentyp: Zeichenfolge Tabelle: Standard-Change-Vorlagenversion [std_change_producer_version] |
| sys_class_name | Name der Tabelle, in der sich die Change-Anforderung befindet. Datentyp: Zeichenfolge |
| sys_created_by | Name des Anwenders, der die Change-Anforderung ursprünglich erstellt hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_created_on | Datum und Uhrzeit der ursprünglichen Erstellung des zugehörigen Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge |
| sys_Domain | Bei Verwendung von Domänen in der Instanz der Name der Domäne, der der Change-Moduldatensatz zugeordnet ist. Datentyp: Zeichenfolge |
| sys_Domain_path | Bei Verwendung von Domänen in der Instanz der Domänenpfad, in dem sich der zugeordnete Change-Moduldatensatz befindet. Datentyp: Zeichenfolge |
| sys_id | Eindeutiger Bezeichner des zugehörigen Change-Anforderungsdatensatzes. Datentyp: Zeichenfolge |
| sys_mod_count | Anzahl der Updates für den Fall seit der anfänglichen Erstellung. Datentyp: Zahl (Ganzzahl) |
| sys_updated_by | Person, die den Fall zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des Falls. Datentyp: Zeichenfolge |
| Task_EFFECTIVE_number | Universal-Anforderungsnummer. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Aufgabe_für | Nicht verwendet von Change-Management. SYS_ID des Anwenders, für den die Aufgabe erstellt wurde. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Test_Plan | Beschreibung des zugehörigen Testplans für den Change. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Zeit_gearbeitet | Gesamtzeit, die an der Change-Anforderung gearbeitet wurde. Datentyp: Zeichenfolge |
| Typ | 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 Universal-Anforderung, zu der diese Change-Anforderung gehört. Datentyp: Zeichenfolge Tabelle: Aufgabe [Aufgabe] |
| On_Approval | Aktion, die ausgeführt werden soll, wenn die Change-Anforderung genehmigt wird. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Fortfahren |
| Bei_ablehnen | Auszuführende Aktion, wenn die Change-Anforderung abgelehnt wird. Mögliche Werte:
Datentyp: Zeichenfolge Maximale Länge: 40 Standard: Abbrechen |
| Dringlichkeit | Dringlichkeit der Change-Anforderung. Mögliche Werte:
Datentyp: Zahl (Ganzzahl) Standard: 3 |
| Anwender_Eingabe | Zusätzliche Anwendereingabe. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| variables | Name-Wert-Paare von Variablen, die der Change-Anforderung zugeordnet sind. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Watch_list | Liste der sys_IDs der Anwender, die Benachrichtigungen zu dieser Change-Anforderung erhalten, wenn zusätzliche Kommentare hinzugefügt werden oder wenn der Status einer Change-Anforderung in „gelöst“ oder „Geschlossen“ geändert wird. Datentyp: Array Tabelle: Benutzer [sys_user] |
| wf_activity | SYS_ID des Workflow-Aktivitätsdatensatzes, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Workflow-Aktivität [wf_activity] |
| Work_End | Datum und Uhrzeit der Beendigung der Arbeit an der Change-Anforderung. Datentyp: Zeichenfolge |
| work_notes | Informationen darüber, wie die Change-Anforderung gelöst wird, oder Schritte, die zu ihrer Lösung unternommen wurden. Datentyp: Zeichenfolge Maximale Länge: 4.000 |
| Work_Notes_list | Liste der sys_IDs der internen Anwender, die Benachrichtigungen zu dieser Change-Anforderung erhalten, wenn Arbeitsnotizen hinzugefügt werden. Datentyp: Array Tabelle: Benutzer [sys_user] |
| Work_Start | Datum und Uhrzeit des Beginns der Arbeit an der Change-Anforderung. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result":
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Clear BGP sessions on a Cisco router",
"value": "Clear BGP sessions on a Cisco router"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "1766f1de47410200e90d87e8dee490f6",
"value": "1766f1de47410200e90d87e8dee490f6"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
}
Change-Management – GET /sn_chg_Rest/Change/{sys_ID}/ci
Ruft mehrere Konfigurationselemente (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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung, für die die 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, die zum Filtern des Ergebnissatzes verwendet werden sollen. Der Name ist das Feld, nach dem der angegebene Wert gefiltert wird. Dieser Parameter schließt sich gegenseitig aus sysparm_query. Beispiel: Anstatt zu verwenden &Sysparm_query=Active=true , Sie können die aufrufende Anweisung vereinfachen, indem Sie verwenden &Active=wahr . Sie können den Anzeigewert auch verwenden, wenn das Feld ein Auswahl- oder Referenztypfeld ist, z. B. &Status=Geschlossen Anstelle von &Status=7 . Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie jedes durch ein und-Zeichen, z. B. &Active=wahr&assigned_to=john.smith . Datentyp: Zeichenfolge |
| Sysparm_limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 500 |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage Wird verwendet, um den Ergebnissatz zu filtern. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: Sysparm_query=<col_name> <operator> <value> . Bei Spaltennamen, Operatoren und Werten wird zwischen Groß- und Kleinschreibung unterschieden.
Abfragen können mehrere Bedingungen enthalten. Die folgende Abfrage gibt beispielsweise Datensätze zurück, bei denen der Anrufer der aktuelle Anwender ist und der Datensatz aktiv ist.
Codierte Abfragen unterstützen auch die Funktion zum Sortieren nach aufsteigender und absteigender Reihenfolge. Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie Syntax:
Die folgende Abfrage ruft beispielsweise alle aktiven Datensätze ab und ordnet die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie an.
Wenn ein Teil einer Abfrage ungültig ist, z. B. ein ungültiger Feldname, ignoriert die Instanz standardmäßig das ungültige Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Legen Sie die Eigenschaft fest glide.invalid_query.returns_no_rowsBis Wahr Um stattdessen keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Die Fehlerantwort enthält relevante Nachrichten, die bei der Behebung des Problems helfen. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| ci_item|cmdb_ci_Service | Entweder die Variablen „ci_item“ oder „cmdb_ci_Service“, je nach Zuordnungstyp. Datentyp: Array |
| ci_item|cmdb_ci_Service.value | SYS_ID des ci_item oder cmdb_ci_Service. Datentyp: Zeichenfolge |
| ci_item|cmdb_ci_service.display_value | Anzeigewert des ci_item oder cmdb_ci_Service. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen der Change-Anforderung. Datentyp: Objekt |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| <record_fields> | Alle gültigen Felder im Datensatz „ci_item“ oder „cmdb_ci_Service“; Tabelle basierend auf 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 derzeit ausgeführten Konfliktprüfungsprozesses für Change-Anforderungen oder die Ergebnisse des letzten abgeschlossenen Konfliktprüfungsprozesses für die angegebene Change-Anforderung ab.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/Konflikt
Standard-URL: /api/sn_chg_Rest/Change/{sys_ID}/Konflikt
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung, für die der Status des laufenden/abgeschlossenen Konfliktprüfungsprozesses zurückgegeben werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Aktueller Status des Konfliktprüfungsprozesses; einschließlich Konflikten, falls vorhanden. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Konflikte | Liste der für die Change-Anforderung gefundenen Konflikte. Ein leeres Objekt gibt an, dass keine Konflikte erkannt wurden. Datentyp: Array |
| job_status | Status des tatsächlichen Konfliktprüfungsauftrags. Datentyp: Zeichenfolge |
| last_run | Datum und Uhrzeit, zu der der letzte Konfliktprüfungsprozess gestartet wurde. Datentyp: Zeichenfolge |
| record_count | Anzahl der geprüften Datensätze. Datentyp: Zeichenfolge |
| Status | Ergebnis des Konfliktprüfungsprozesses, z. B. „Konflikt“ oder „nicht ausgeführt“. Hinweis:
Auch wenn die Change-Anforderung keine Konflikte aufweist, wird dieses Feld auf „Konflikt“ festgelegt. Jedoch conflictsObjekt ist leer. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Erfolgreiche Antwort – keine Konflikte
{
result: {
status: "Conflict",
last_run": "2018-08-30 12:58:05",
record_count: "1",
job_status: "2",
conflicts: []
}
}
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Erfolgreiche Antwort – mit Konflikten
{
result: {
status: "Conflict",
last_run": "2018-08-30 12:58:05",
record_count: "1",
job_status: "2",
conflicts: [
{
change: {
display_value: "CHG0030001",
value: "afbffb24b758230096c3e4f6ee11a972"
},
type: {
display_value: "Not In Maintenance Window",
value: "not_in_maintenance_window"
}
..., // all valid fields in record, example below
}
]
}
}
Change-Management – GET /sn_chg_Rest/Change/Emergency
Ruft eine oder mehrere Notfall-Change-Anforderungen 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. 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ückgegebenen Change-Anforderungen sortiert werden sollen. Datentyp: Zeichenfolge Standard: Nummer |
| Sysparm_limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 500 |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage Wird verwendet, um den Ergebnissatz zu filtern. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: Sysparm_query=<col_name> <operator> <value> . Bei Spaltennamen, Operatoren und Werten wird zwischen Groß- und Kleinschreibung unterschieden.
Abfragen können mehrere Bedingungen enthalten. Die folgende Abfrage gibt beispielsweise Datensätze zurück, bei denen der Anrufer der aktuelle Anwender ist und der Datensatz aktiv ist.
Codierte Abfragen unterstützen auch die Funktion zum Sortieren nach aufsteigender und absteigender Reihenfolge. Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie Syntax:
Die folgende Abfrage ruft beispielsweise alle aktiven Datensätze ab und ordnet die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie an.
Wenn ein Teil einer Abfrage ungültig ist, z. B. ein ungültiger Feldname, ignoriert die Instanz standardmäßig das ungültige Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Legen Sie die Eigenschaft fest glide.invalid_query.returns_no_rowsBis Wahr Um stattdessen keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| Schlüssel-Wert-Paare | Name-Wert-Paare, die zum Filtern des Ergebnissatzes verwendet werden sollen. Der Name ist das Feld, nach dem der angegebene Wert gefiltert wird. Dieser Parameter schließt sich gegenseitig aus sysparm_query. Beispiel: Anstatt zu verwenden &Sysparm_query=Active=true , Sie können die aufrufende Anweisung vereinfachen, indem Sie verwenden &Active=wahr . Sie können den Anzeigewert auch verwenden, wenn das Feld ein Auswahl- oder Referenztypfeld ist, z. B. &Status=Geschlossen Anstelle von &Status=7 . Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie jedes durch ein und-Zeichen, z. B. &Active=wahr&assigned_to=john.smith . Datentyp: Zeichenfolge |
| Textsuche | Zeichenfolge, die zum Durchsuchen aller Notfall-Change-Anforderungsdatensatzfelder verwendet werden soll. Diese Suche verwendet ServiceNow Volltextsuche-Plattformfunktionalität und ist standardmäßig auf IR_AND_OR_QUERY .Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Werte für alle Felder in der zugehörigen Change-Anforderung. Datentyp: Objekt |
| Status | Status der Change-Anforderung. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
},
},
{ // next record found }, ... // and so on
]
}
Change-Management – GET /sn_chg_Rest/Change/Emergency/{sys_ID}
Ruft die Notfall-Change-Anforderung ab, die durch die angegebene sys_ID identifiziert wurde
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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der abzurufenden Notfall-Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Werte für alle Felder in der zugehörigen Change-Anforderung. Datentyp: Objekt |
| Status | Status der Change-Anforderung. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "b0dbda5347c12200e0ef563dbb9a718f",
display_value: "b0dbda5347c12200e0ef563dbb9a718f"
},
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
},
},
]
}
Change-Management – GET /sn_chg_Rest/Change/model
Ruft ein oder mehrere Change-Modelle basierend auf den angegebenen Kriterien ab.
Verwenden Sie diesen Endpunkt, um ein Change-Modell zu finden, das am besten zu der Change-Anforderung passt, die Sie erstellen möchten. Weitere Informationen finden Sie unter Change-Modelle .
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/model
Standard-URL: /api/sn_chg_Rest/Change/model
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare, die zum Filtern des Ergebnissatzes verwendet werden sollen. Der Name ist das Feld, nach dem der angegebene Wert gefiltert wird. Dieser Parameter schließt sich gegenseitig aus sysparm_query. Beispiel: Anstatt zu verwenden &Sysparm_query=Active=true , Sie können die aufrufende Anweisung vereinfachen, indem Sie verwenden &Active=wahr . Sie können den Anzeigewert auch verwenden, wenn das Feld ein Auswahl- oder Referenztypfeld ist, z. B. &Status=Geschlossen Anstelle von &Status=7 . Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie jedes durch ein und-Zeichen, z. B. &Active=wahr&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 mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage Wird verwendet, um den Ergebnissatz zu filtern. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: Sysparm_query=<col_name> <operator> <value> . Bei Spaltennamen, Operatoren und Werten wird zwischen Groß- und Kleinschreibung unterschieden.
Abfragen können mehrere Bedingungen enthalten. Die folgende Abfrage gibt beispielsweise Datensätze zurück, bei denen der Anrufer der aktuelle Anwender ist und der Datensatz aktiv ist.
Codierte Abfragen unterstützen auch die Funktion zum Sortieren nach aufsteigender und absteigender Reihenfolge. Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie Syntax:
Die folgende Abfrage ruft beispielsweise alle aktiven Datensätze ab und ordnet die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie an.
Wenn ein Teil einer Abfrage ungültig ist, z. B. ein ungültiger Feldname, ignoriert die Instanz standardmäßig das ungültige Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Legen Sie die Eigenschaft fest glide.invalid_query.returns_no_rowsBis Wahr Um stattdessen keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| Textsuche | Zeichenfolge, die zum Durchsuchen aller Change-Modell-Datensatzfelder verwendet werden soll. Diese Suche verwendet ServiceNow Funktionalität der Volltextsuchplattform. Weitere Informationen zu finden ServiceNow Suchfähigkeiten, siehe Suchverwaltung . Datentyp: Zeichenfolge Standard: IR_AND_OR_QUERY |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Liste, die mindestens ein Change-Modell-Datensatzobjekt enthält. Jedes Objekt beschreibt ein Change-Modell. Jedes Element im Change-Modellobjekt entspricht einem Feld im zugehörigen Datensatz in der Tabelle „Change-Modell“ [chg_model]. Alle Elemente enthalten Wert Und Display_value Name-Wert-Paare. Einige enthalten Display_value_internal Name-Wert-Paare. Datentyp: Array |
| Ergebnis.aktiv | Kennzeichnung, die angibt, ob der zugehörige Change-Modelldatensatz aktiv und in der Instanz verfügbar ist. Gültige Werte:
Datentyp: Boolesch Standardwert: wahr |
| Ergebnis.available_in_ui | Kennzeichnung, die angibt, ob der zugehörige Change-Modelldatensatz in der Anwenderoberfläche verfügbar ist. Gültige Werte:
Datentyp: Boolesch Standardwert: wahr |
| Ergebnis.Farbe | 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-Modelldatensatz 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 |
| Ergebnis.Datensatz_Voreinstellung | Name-Wert-Paare der Felder, die automatisch mit den zugehörigen Werten ausgefüllt werden sollen, wenn ein neuer Change-Anforderungsdatensatz erstellt wird. Werte werden durch Caret-Symbole getrennt. Zum Beispiel:
Datentyp: Zeichenfolge |
| Result.State_field | Auswahllistenfeld, aus dem Auswahlmöglichkeiten erfasst werden sollen, basierend auf den in angegebenen table_name. Für Change-Modelle ist dies immer auf „Status“ festgelegt. Datentyp: Zeichenfolge |
| Result.sys_class_Name | Ändern Sie den Modultabellennamen. Ändern Sie immer Modell/chg_model. Datentyp: Zeichenfolge |
| Ergebnis.sys_created_by | Name des Anwenders, der den zugehörigen Change-Moduldatensatz ursprünglich erstellt hat. Datentyp: Zeichenfolge |
| Ergebnis.sys_created_on | Datum und Uhrzeit der ursprünglichen Erstellung des Change-Moduldatensatzes. Datentyp: Zeichenfolge |
| Result.sys_Domain | Bei Verwendung von Domänen in der Instanz der Name der Domäne, der der Change-Moduldatensatz 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-Moduldatensatz befindet. Datentyp: Zeichenfolge |
| Ergebnis.sys_ID | Eindeutiger Bezeichner des zugeordneten Change-Modelldatensatzes. Datentyp: Zeichenfolge |
| Ergebnis.sys_mod_count | Gibt an, wie oft der zugehörige Change-Modelldatensatz geändert wurde. Datentyp: Zahl |
| Ergebnis.sys_Name | Name des Change-Modells. Immer identisch mit nameParameter. Datentyp: Zeichenfolge |
| Ergebnis.sys_Tags | System-Tags, die dem Change-Modelldatensatz zugeordnet sind. Datentyp: Zeichenfolge |
| Ergebnis.sys_updated_by | Name des Anwenders, der den zugehörigen Change-Modelldatensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Ergebnis.sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des zugehörigen Change-Modelldatensatzes. Datentyp: Zeichenfolge |
| Result.table_Name | Tabelle, die das Auswahllistenfeld definiert, aus dem Auswahlmöglichkeiten erfasst werden sollen. Für Change-Modelle ist dies immer auf „Change_Request“ festgelegt. Datentyp: Zeichenfolge Maximale Länge: 80 |
cURL-Anforderung
Dieses Beispiel zeigt eine Anforderung zum Abrufen aller Change-Modelldatensätze.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
Aus Kürze zeigt diese Antwort nur ein einzelnes Change-Modellobjekt an.
{
"result": [
{
"record_preset": {
"display_value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ",
"value": "type=normal^assignment_group=a715cd759f2002002920bde8132e7018^short_description=Automated : Change^EQ"
},
"color": {
"display_value": "#488df4",
"value": "#488df4"
},
"default_change_model": {
"display_value": "false",
"value": false
},
"sys_mod_count": {
"display_value": "6",
"value": 6.0
},
"description": {
"display_value": "This model is intended to capture a record of an automated change. There are no approvals associated with this change model.\r\n",
"value": "This model is intended to capture a record of an automated change. There are no approvals associated with this change model.\r\n"
},
"active": {
"display_value": "true",
"value": true
},
"sys_updated_on": {
"display_value": "2020-10-02 06:24:24",
"value": "2020-10-02 13:24:24",
"display_value_internal": "2020-10-02 06:24:24"
},
"sys_tags": {
"display_value": "",
"value": ""
},
"table_name": {
"display_value": "change_request",
"value": "change_request"
},
"sys_class_name": {
"display_value": "Change Model",
"value": "chg_model"
},
"sys_id": {
"display_value": "7840d2515323101034d1ddeeff7b12a6",
"value": "7840d2515323101034d1ddeeff7b12a6"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"available_in_ui": {
"display_value": "false",
"value": false
},
"state_field": {
"display_value": "state",
"value": "state"
},
"sys_created_on": {
"display_value": "2020-09-28 07:33:25",
"value": "2020-09-28 14:33:25",
"display_value_internal": "2020-09-28 07:33:25"
},
"name": {
"display_value": "Change Registration",
"value": "Change Registration"
},
"sys_name": {
"display_value": "Change Registration",
"value": "Change Registration"
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
}
}
]
}
Change-Management – GET /sn_chg_Rest/Change/model/{sys_ID}
Ruft das durch die angegebene sys_ID identifizierte Change-Modell ab
Sie können dann dieses Change-Modell verwenden, um die gewünschte Change-Anforderung zu erstellen. Weitere Informationen zu Change-Modellen finden Sie unter Change-Modelle .
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/model/{sys_ID}
Standard-URL: /api/sn_chg_Rest/Change/model/{sys_ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des Change-Modelldatensatzes, der aus der Tabelle „Change-Modell“ [chg_model] abgerufen werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Angefordertes Change-Modell-Datensatzobjekt. Jedes Element in diesem Objekt entspricht einem Feld im Datensatz in der Tabelle „Change-Modell“ [chg_model]. Alle Elemente enthalten valueUnd display_valueName-Wert-Paare. Einige enthalten display_value_internalName-Wert-Paare. Datentyp: Objekt |
| Ergebnis.aktiv | Kennzeichnung, die angibt, ob der zugehörige Change-Modelldatensatz aktiv und in der Instanz verfügbar ist. Gültige Werte:
Datentyp: Boolesch Standardwert: wahr |
| Ergebnis.available_in_ui | Kennzeichnung, die angibt, ob der zugehörige Change-Modelldatensatz in der Anwenderoberfläche verfügbar ist. Gültige Werte:
Datentyp: Boolesch Standardwert: wahr |
| Ergebnis.Farbe | 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-Modelldatensatz 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 |
| Ergebnis.Datensatz_Voreinstellung | Name-Wert-Paare der Felder, die automatisch mit den zugehörigen Werten ausgefüllt werden sollen, wenn ein neuer Change-Anforderungsdatensatz erstellt wird. Werte werden durch Caret-Symbole getrennt. Zum Beispiel:
Datentyp: Zeichenfolge |
| Result.State_field | Auswahllistenfeld, aus dem Auswahlmöglichkeiten erfasst werden sollen, basierend auf den in angegebenen table_name. Für Change-Modelle ist dies immer auf „Status“ festgelegt. Datentyp: Zeichenfolge |
| Result.sys_class_Name | Ändern Sie den Modultabellennamen. Ändern Sie immer Modell/chg_model. Datentyp: Zeichenfolge |
| Ergebnis.sys_created_by | Name des Anwenders, der den zugehörigen Change-Moduldatensatz ursprünglich erstellt hat. Datentyp: Zeichenfolge |
| Ergebnis.sys_created_on | Datum und Uhrzeit der ursprünglichen Erstellung des Change-Moduldatensatzes. Datentyp: Zeichenfolge |
| Result.sys_Domain | Bei Verwendung von Domänen in der Instanz der Name der Domäne, der der Change-Moduldatensatz 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-Moduldatensatz befindet. Datentyp: Zeichenfolge |
| Ergebnis.sys_ID | Eindeutiger Bezeichner des zugeordneten Change-Modelldatensatzes. Datentyp: Zeichenfolge |
| Ergebnis.sys_mod_count | Gibt an, wie oft der zugehörige Change-Modelldatensatz geändert wurde. Datentyp: Zahl |
| Ergebnis.sys_Name | Name des Change-Modells. Immer identisch mit nameParameter. Datentyp: Zeichenfolge |
| Ergebnis.sys_Tags | System-Tags, die dem Change-Modelldatensatz zugeordnet sind. Datentyp: Zeichenfolge |
| Ergebnis.sys_updated_by | Name des Anwenders, der den zugehörigen Change-Modelldatensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge Maximale Länge: 40 |
| Ergebnis.sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des zugehörigen Change-Modelldatensatzes. Datentyp: Zeichenfolge |
| Result.table_Name | Tabelle, die das Auswahllistenfeld definiert, aus dem Auswahlmöglichkeiten erfasst werden sollen. Für Change-Modelle ist dies immer auf „Change_Request“ festgelegt. Datentyp: Zeichenfolge Maximale Länge: 80 |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/model/c0efda5347c12200e0ef563dbb9a81e3" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": {
"record_preset": {
"display_value": "type=emergency^EQ",
"value": "type=emergency^EQ"
},
"color": {
"display_value": "#ea3423",
"value": "#ea3423"
},
"default_change_model": {
"display_value": "false",
"value": false
},
"sys_mod_count": {
"display_value": "2",
"value": 2.0
},
"description": {
"display_value": "ITIL Mode 1 Emergency Change",
"value": "ITIL Mode 1 Emergency Change"
},
"active": {
"display_value": "true",
"value": true
},
"sys_updated_on": {
"display_value": "2020-09-28 08:53:12",
"value": "2020-09-28 15:53:12",
"display_value_internal": "2020-09-28 08:53:12"
},
"sys_tags": {
"display_value": "",
"value": ""
},
"table_name": {
"display_value": "change_request",
"value": "change_request"
},
"sys_class_name": {
"display_value": "Change Model",
"value": "chg_model"
},
"sys_id": {
"display_value": "c0efda5347c12200e0ef563dbb9a81e3",
"value": "c0efda5347c12200e0ef563dbb9a81e3"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"available_in_ui": {
"display_value": "true",
"value": true
},
"state_field": {
"display_value": "state",
"value": "state"
},
"sys_created_on": {
"display_value": "2020-09-04 09:16:03",
"value": "2020-09-04 16:16:03",
"display_value_internal": "2020-09-04 09:16:03"
},
"name": {
"display_value": "Emergency",
"value": "Emergency"
},
"sys_name": {
"display_value": "Emergency",
"value": "Emergency"
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
}
}
}
Change-Management – GET /sn_chg_Rest/Change/normal
Ruft eine oder mehrere normale Change-Anforderungen basierend auf den angegebenen Kriterien ab.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/normal
Standard-URL: /api/sn_chg_Rest/Change/normal
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare, die zum Filtern des Ergebnissatzes verwendet werden sollen. Der Name ist das Feld, nach dem der angegebene Wert gefiltert wird. Dieser Parameter schließt sich gegenseitig aus sysparm_query. Beispiel: Anstatt zu verwenden &Sysparm_query=Active=true , Sie können die aufrufende Anweisung vereinfachen, indem Sie verwenden &Active=wahr . Sie können den Anzeigewert auch verwenden, wenn das Feld ein Auswahl- oder Referenztypfeld ist, z. B. &Status=Geschlossen Anstelle von &Status=7 . Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie jedes durch ein und-Zeichen, z. B. &Active=wahr&assigned_to=john.smith . Datentyp: Zeichenfolge |
| Bestellen | Feld, nach dem die zurückgegebenen Change-Anforderungen sortiert werden sollen. Datentyp: Zeichenfolge |
| Sysparm_limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 500 |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage Wird verwendet, um den Ergebnissatz zu filtern. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: Sysparm_query=<col_name> <operator> <value> . Bei Spaltennamen, Operatoren und Werten wird zwischen Groß- und Kleinschreibung unterschieden.
Abfragen können mehrere Bedingungen enthalten. Die folgende Abfrage gibt beispielsweise Datensätze zurück, bei denen der Anrufer der aktuelle Anwender ist und der Datensatz aktiv ist.
Codierte Abfragen unterstützen auch die Funktion zum Sortieren nach aufsteigender und absteigender Reihenfolge. Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie Syntax:
Die folgende Abfrage ruft beispielsweise alle aktiven Datensätze ab und ordnet die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie an.
Wenn ein Teil einer Abfrage ungültig ist, z. B. ein ungültiger Feldname, ignoriert die Instanz standardmäßig das ungültige Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Legen Sie die Eigenschaft fest glide.invalid_query.returns_no_rowsBis Wahr Um stattdessen keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| Textsuche | Zeichenfolge, die zum Durchsuchen aller normalen Change-Anforderungsdatensatzfelder verwendet werden soll. Diese Suche verwendet die Funktionalität der ServiceNow-Volltextsuchplattform und ist standardmäßig auf festgelegt IR_AND_OR_QUERY .Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Werte für alle Felder in der zugehörigen Change-Anforderung. Datentyp: Objekt |
| Status | Status der Change-Anforderung vor dem Löschen. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Wert ist immer „normal“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „normal“. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?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 die normale Change-Anforderung ab, die durch die angegebene 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der normalen Change-Anforderung, die abgerufen werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Werte für alle Felder in der zugehörigen Change-Anforderung. Datentyp: Objekt |
| Status | Status der Change-Anforderung vor dem Löschen. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Wert ist immer „normal“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „normal“. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f" \
--request 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 eine oder mehrere Standard-Change-Anforderungen 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. 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 zum Filtern des Ergebnissatzes verwendet werden sollen. Der Name ist das Feld, nach dem der angegebene Wert gefiltert wird. Dieser Parameter schließt sich gegenseitig aus sysparm_query. Beispiel: Anstatt zu verwenden &Sysparm_query=Active=true , Sie können die aufrufende Anweisung vereinfachen, indem Sie verwenden &Active=wahr . Sie können den Anzeigewert auch verwenden, wenn das Feld ein Auswahl- oder Referenztypfeld ist, z. B. &Status=Geschlossen Anstelle von &Status=7 . Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie jedes durch ein und-Zeichen, z. B. &Active=wahr&assigned_to=john.smith . Datentyp: Zeichenfolge |
| Bestellen | Feld, nach dem die zurückgegebenen Change-Anforderungen sortiert werden sollen. Datentyp: Zeichenfolge |
| Sysparm_limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zeichenfolge Standard: 500 |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage Wird verwendet, um den Ergebnissatz zu filtern. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: Sysparm_query=<col_name> <operator> <value> . Bei Spaltennamen, Operatoren und Werten wird zwischen Groß- und Kleinschreibung unterschieden.
Abfragen können mehrere Bedingungen enthalten. Die folgende Abfrage gibt beispielsweise Datensätze zurück, bei denen der Anrufer der aktuelle Anwender ist und der Datensatz aktiv ist.
Codierte Abfragen unterstützen auch die Funktion zum Sortieren nach aufsteigender und absteigender Reihenfolge. Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie Syntax:
Die folgende Abfrage ruft beispielsweise alle aktiven Datensätze ab und ordnet die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie an.
Wenn ein Teil einer Abfrage ungültig ist, z. B. ein ungültiger Feldname, ignoriert die Instanz standardmäßig das ungültige Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Legen Sie die Eigenschaft fest glide.invalid_query.returns_no_rowsBis Wahr Um stattdessen keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| Textsuche | Zeichenfolge, die zum Durchsuchen aller Standard-Change-Anforderungsdatensatzfelder verwendet werden soll. Diese Suche verwendet ServiceNow Volltextsuche-Plattformfunktionalität und ist standardmäßig auf IR_AND_OR_QUERY .Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Alle Felder (Schlüssel) mit ihren zugehörigen Werten für die identifizierte Change-Anforderung. Datentyp: Objekt |
| Status | Status der Change-Anforderung vor dem Löschen. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Wert ist immer „Standard“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „Standard“. Datentyp: Zeichenfolge |
Beispiel für 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 die Standard-Change-Anforderung ab, die durch die angegebene 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der abzurufenden Standard-Change-Anforderung. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Alle Felder (Schlüssel) mit ihren zugehörigen Werten für die identifizierte Change-Anforderung. Datentyp: Objekt |
| Status | Status der Change-Anforderung vor dem Löschen. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/b0dbda5347c12200e0ef563dbb9a718f" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
..., // all valid fields in record, example below
short_description: {
value: "Add network switch to cabinet",
display_value: "Add network switch to cabinet"
},
},
]
}
Change-Management – GET /sn_chg_Rest/Change/Standard/template
Ruft eine oder mehrere Standard-Change-Vorlagen basierend auf den angegebenen Kriterien ab.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Standard/template
Standard-URL: /api/sn_chg_Rest/Change/Standard/template
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare, die zum Filtern des Ergebnissatzes verwendet werden sollen. Der Name ist das Feld, nach dem der angegebene Wert gefiltert wird. Dieser Parameter schließt sich gegenseitig aus sysparm_query. Beispiel: Anstatt zu verwenden &Sysparm_query=Active=true , Sie können die aufrufende Anweisung vereinfachen, indem Sie verwenden &Active=wahr . Sie können den Anzeigewert auch verwenden, wenn das Feld ein Auswahl- oder Referenztypfeld ist, z. B. &Status=Geschlossen Anstelle von &Status=7 . Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie jedes durch ein und-Zeichen, z. B. &Active=wahr&assigned_to=john.smith . Datentyp: Zeichenfolge |
| Bestellen | Feld, nach dem die zurückgegebenen Standard-Change-Vorlagen sortiert werden sollen. Datentyp: Zeichenfolge Standard: Zahl |
| Sysparm_limit | Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 500 |
| Sysparm_Offset | Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0“ festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie Datentyp: Zahl Standard: 0 |
| Sysparm_query | Codierte Abfrage Wird verwendet, um den Ergebnissatz zu filtern. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: Sysparm_query=<col_name> <operator> <value> . Bei Spaltennamen, Operatoren und Werten wird zwischen Groß- und Kleinschreibung unterschieden.
Abfragen können mehrere Bedingungen enthalten. Die folgende Abfrage gibt beispielsweise Datensätze zurück, bei denen der Anrufer der aktuelle Anwender ist und der Datensatz aktiv ist.
Codierte Abfragen unterstützen auch die Funktion zum Sortieren nach aufsteigender und absteigender Reihenfolge. Um Antworten basierend auf bestimmten Feldern zu sortieren, verwenden Sie Syntax:
Die folgende Abfrage ruft beispielsweise alle aktiven Datensätze ab und ordnet die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie an.
Wenn ein Teil einer Abfrage ungültig ist, z. B. ein ungültiger Feldname, ignoriert die Instanz standardmäßig das ungültige Teil. Gibt dann Zeilen zurück, die nur den gültigen Teil der Abfrage verwenden. Legen Sie die Eigenschaft fest glide.invalid_query.returns_no_rowsBis Wahr Um stattdessen keine Zeilen für eine ungültige Abfrage zurückzugeben. Hinweis: Die glide.invalid_query.returns_no_rowsEigenschaft steuert das Verhalten aller Abfragen in der Instanz, z. B. in Listen, Skripts ( GlideRecord.Abfrage() ) Und Webservice-APIs. Datentyp: Zeichenfolge |
| Textsuche | Zeichenfolge, die zum Durchsuchen aller Standard-Change-Anforderungsdatensatzfelder verwendet werden soll. Diese Suche verwendet die Funktionalität der ServiceNow-Volltextsuchplattform und ist standardmäßig auf festgelegt IR_AND_OR_QUERY .Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Alle Felder mit ihren zugehörigen Werten für die identifizierte Standard-Change-Vorlage. Datentyp: Objekt |
| sys_id | SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Vorlage | Informationen zur Standard-Change-Vorlage. Datentyp: Objekt |
| Template.Display_value | Vorlageninformationen, die in der Anwenderoberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| Vorlage.Wert | Vorlage sys_ID Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template?sysparm_query=active=true^ORDERBYnumber" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "92b8544047810200e90d87e8dee490b0",
display_value: "92b8544047810200e90d87e8dee490b0"
},
template : {
value: "1c8e02ec47410200e90d87e8dee49057",
display_value: "Add network switch to datacenter cabinet"
},
..., // all valid fields in record, example below
short_description: {
value: "Standard change template to add network switch to cabinet",
display_value: "Standard change template to add network switch to cabinet"
},
},
{ // next record found }, ... // and so on
]
}
Change-Management – GET /sn_chg_Rest/Change/Standard/template/{sys_ID}
Ruft die Standard-Change-Vorlage ab, die durch die angegebene sys_ID identifiziert wird
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Standard/template/{sys_ID}
Standard-URL: /api/sn_chg_Rest/Change/Standard/template/{sys_ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der abzurufenden Standard-Change-Vorlage. Datentyp: Zeichenfolge Tabelle: Standard-Change-Vorlage [std_change_record_producer] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Alle Felder mit ihren zugehörigen Werten für die identifizierte Standard-Change-Vorlage. Datentyp: Objekt |
| sys_id | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Vorlage | Informationen zur Standard-Change-Vorlage. Datentyp: Objekt |
| Template.Display_value | Vorlageninformationen, die in einer Anwenderoberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| Vorlage.Wert | Vorlage sys_ID Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/template/92b8544047810200e90d87e8dee490b0" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "92b8544047810200e90d87e8dee490b0",
template : {
value: "1c8e02ec47410200e90d87e8dee49057",
display_value: "Add network switch to datacenter cabinet"
},
..., // all valid fields in record, example below
short_description: {
value: "Standard change template to add network switch to cabinet",
display_value: "Standard change template to add network switch to cabinet"
},
},
]
}
Change-Management – GET /sn_chg_Rest/Change/Worker/{sys_ID}
Ruft den aktuellen Status, Informationen und Fehler für den angegebenen asynchronen Worker ab.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/Worker/{sys_ID}
Standard-URL: /api/sn_chg_Rest/{Change/Worker/{sys_ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des asynchronen Worker für das Change-Management. Datentyp: Zeichenfolge Tabelle: Change-Management-Mitarbeiter [chg_mgt_Worker] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.Fehlernachrichten | Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben Datentyp: Array |
| messages.infoMessages | Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Zum Beispiel: CMDB_CI sys_ID ist bereits angegeben. Datentyp: Array |
| Nachrichten.WarnungsNachrichten | Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben. Datentyp: Array |
| Nutzlast | Eindeutige Nutzlast, die bereitgestellt wird, wenn eine Worker-sys_ID aus dem erfolgreichen Antworttext eines Zeitplanendpunkts verwendet wird.Datentyp: Objekt |
| Nutzlast.Spannen | Wenn eine Zeitspanne innerhalb der im Zeitplan-Endpunkt angegebenen Dauer verfügbar ist, listet die Worker-API die verfügbaren Zeitspannen auf.Datentyp: Array |
| Nutzlast.Spannen.Start |
Datentyp: Objekt |
| Payload.Spans.Start.value | Datum und Uhrzeit, zu der die Implementierung der Change-Anforderung beginnen soll. Datentyp: Zeichenfolge |
| Payload.Spans.Start.Display_value | Zeigt den Wert der Startzeit der Change-Anforderung an. Zeitformat: jjjj-mm-TT hh:mm:ss Datentyp: Zeichenfolge |
| Nutzlast.Spannen.Ende |
Datentyp: Objekt |
| Payload.Spans.end.value | Datum und Uhrzeit, zu der der Abschluss der Change-Anforderung geplant ist. Zeitformat: jjjj-mm-TT hh:mm:ss Datentyp: Zeichenfolge |
| Payload.Spans.end.Display_value | Zeigt den Wert der Abschlusszeit der Change-Anforderung an. Datentyp: Zeichenfolge |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt |
| status.Anzeigewert | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| status.Wert | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| Typ | 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 Worker, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge |
| <other_params> | Andere prozessspezifische Parameter, z. B. ignored_cmdb_ci_sys_ids. |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/worker/0644cd02dbec330084f07ffdbf9619c1" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": {
"worker": {
"sysId": "0644cd02dbec330084f07ffdbf9619c1",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/0644cd02dbec330084f07ffdbf9619c1"
},
"request": "{\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "impacted",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}
Change-Management – PATCH /sn_chg_Rest/Change/{sys_ID}
Aktualisiert die durch die angegebene sys_ID identifizierte Change-Anforderung mit den Schlüssel-Wert-Paaren im Anforderungstext oder 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung, die geändert werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstext-Parameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Datentyp: Zeichenfolge |
| Encrypted_fields | Liste der kommagetrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt den GlideRecord auf SetDisplayWert() Methode, anstatt aufzurufen SetWert() Methode. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für nicht verschlüsselte Felder wie Referenz- oder Auswahlfelder zu übergeben, anstatt sys_IDs oder Werte zu übergeben. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Daten | Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um beispielsweise die Kurzbeschreibungsdatei zu aktualisieren, geben Sie ein Name-Wert-Paar ähnlich dem folgenden ein: --Data „{\"short_description\": \"meine Kurzbeschreibung\" }" \ . Datentyp: Zeichenfolge |
| Encrypted_fields | Liste der kommagetrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt den GlideRecord auf SetDisplayWert() Methode, anstatt aufzurufen SetWert() Methode. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für nicht verschlüsselte Felder wie Referenz- oder Auswahlfelder zu übergeben, anstatt sys_IDs oder Werte zu übergeben. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Change-Anforderungsdatensatz aktualisiert. Jedes Element in diesem Objekt entspricht einem Feld im Datensatz in der Tabelle „Change-Anforderung“ [Change_Request]. Alle Elemente enthalten valueUnd display_valueName-Wert-Paare. Einige enthalten display_value_internalName-Wert-Paare. Datentyp: Objekt |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"short_desription\": \"Reboot the server at 6 am\" }" \
--user "username":"password"
{
"result":
{
"reason": {
"display_value": "",
"value": ""
},
"parent": {
"display_value": "",
"value": ""
},
"watch_list": {
"display_value": "",
"value": ""
},
"proposed_change": {
"display_value": "",
"value": ""
},
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2015-07-06 11:59:27",
"value": "2015-07-06 18:59:27",
"display_value_internal": "2015-07-06 11:59:27"
},
"type": {
"display_value": "Standard",
"value": "standard"
},
"approval_history": {
"display_value": "",
"value": ""
},
"skills": {
"display_value": "",
"value": ""
},
"test_plan": {
"display_value": "--Confirm that there are no monitoring alerts for the router",
"value": "--Confirm that there are no monitoring alerts for the router"
},
"number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"is_bulk": {
"display_value": "false",
"value": false
},
"cab_delegate": {
"display_value": "",
"value": ""
},
"requested_by_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "Closed",
"value": 3.0
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"order": {
"display_value": "",
"value": ""
},
"phase": {
"display_value": "Requested",
"value": "requested"
},
"cmdb_ci": {
"display_value": "",
"value": ""
},
"delivery_plan": {
"display_value": "",
"value": ""
},
"impact": {
"display_value": "3 - Low",
"value": 3.0
},
"contract": {
"display_value": "",
"value": ""
},
"active": {
"display_value": "false",
"value": false
},
"work_notes_list": {
"display_value": "",
"value": ""
},
"priority": {
"display_value": "4 - Low",
"value": 4.0
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"cab_recommendation": {
"display_value": "",
"value": ""
},
"production_system": {
"display_value": "false",
"value": false
},
"rejection_goto": {
"display_value": "",
"value": ""
},
"review_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"business_duration": {
"display_value": "",
"value": ""
},
"group_list": {
"display_value": "",
"value": ""
},
"change_plan": {
"display_value": "",
"value": ""
},
"approval_set": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"wf_activity": {
"display_value": "",
"value": ""
},
"implementation_plan": {
"display_value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform",
"value": "-- Place router into maintenance mode in the monitoring platform\r\n-- Logon to router through SSH\r\n-- Run the following command\r\n\r\nrouter(config-router)#router bgp 12345\r\nrouter(config-router)#neighbor {neighbor ip} soft-reconfig [inbound]\r\nrouter#clear ip bgp {neighbor ip} soft in\r\n\r\n-- Confirm the sessions have been cleared\r\n-- Place router back into operational mode in the monitoring platform"
},
"universal_request": {
"display_value": "",
"value": ""
},
"end_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"short_description": {
"display_value": "Reboot the server at 6 am",
"value": "Reboot the server at 6 am"
},
"correlation_display": {
"display_value": "",
"value": ""
},
"work_start": {
"display_value": "2015-07-06 11:56:04",
"value": "2015-07-06 18:56:04",
"display_value_internal": "2015-07-06 11:56:04"
},
"delivery_task": {
"display_value": "",
"value": ""
},
"outside_maintenance_schedule": {
"display_value": "false",
"value": false
},
"additional_assignee_list": {
"display_value": "",
"value": ""
},
"std_change_producer_version": {
"display_value": "Clear BGP sessions on a Cisco router - 1",
"value": "16c2273c47010200e90d87e8dee49006"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"service_offering": {
"display_value": "",
"value": ""
},
"closed_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"follow_up": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"review_status": {
"display_value": "",
"value": ""
},
"reassignment_count": {
"display_value": "2",
"value": 2.0
},
"start_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"assigned_to": {
"display_value": "",
"value": ""
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments_and_work_notes": {
"display_value": "",
"value": ""
},
"escalation": {
"display_value": "Normal",
"value": 0.0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"correlation_id": {
"display_value": "",
"value": ""
},
"made_sla": {
"display_value": "true",
"value": true
},
"backout_plan": {
"display_value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work",
"value": "Due to the limited number of commands in the implementation plan it is not possible to backout the change.\r\n\r\nIf required you are authorized to reboot the router if BGP fails to work"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0000024",
"value": "CHG0000024"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"user_input": {
"display_value": "",
"value": ""
},
"sys_created_on": {
"display_value": "2015-07-06 11:55:46",
"value": "2015-07-06 18:55:46",
"display_value_internal": "2015-07-06 11:55:46"
},
"on_hold_task": {
"display_value": "",
"value": ""
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"route_reason": {
"display_value": "",
"value": ""
},
"closed_at": {
"display_value": "2015-07-06 11:56:23",
"value": "2015-07-06 18:56:23",
"display_value_internal": "2015-07-06 11:56:23"
},
"review_comments": {
"display_value": "",
"value": ""
},
"business_service": {
"display_value": "",
"value": ""
},
"time_worked": {
"display_value": "",
"value": ""
},
"chg_model": {
"display_value": "",
"value": ""
},
"expected_start": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"opened_at": {
"display_value": "2015-06-09 11:55:46",
"value": "2015-06-09 18:55:46",
"display_value_internal": "2015-06-09 11:55:46"
},
"work_end": {
"display_value": "2015-07-06 11:56:10",
"value": "2015-07-06 18:56:10",
"display_value_internal": "2015-07-06 11:56:10"
},
"phase_state": {
"display_value": "Open",
"value": "open"
},
"cab_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"work_notes": {
"display_value": "",
"value": ""
},
"close_code": {
"display_value": "Successful",
"value": "successful"
},
"assignment_group": {
"display_value": "Network",
"value": "287ebd7da9fe198100f92cc8d1d2154e"
},
"description": {
"display_value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n",
"value": "Resend the complete BGP table to neighboring routers\r\n\r\n--Both neighbors need to support soft reset route refresh capability.\r\n--Stores complete BGP table of you neighbor in router memory.\r\n--Not a good idea on a peering router with full feed, due to the memory requirements.\r\n"
},
"on_hold_reason": {
"display_value": "",
"value": ""
},
"calendar_duration": {
"display_value": "",
"value": ""
},
"close_notes": {
"display_value": "Completed without issues",
"value": "Completed without issues"
},
"sys_id": {
"display_value": "b0dbda5347c12200e0ef563dbb9a718f",
"value": "b0dbda5347c12200e0ef563dbb9a718f"
},
"contact_type": {
"display_value": "Phone",
"value": "phone"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3.0
},
"scope": {
"display_value": "Medium",
"value": 3.0
},
"company": {
"display_value": "",
"value": ""
},
"justification": {
"display_value": "",
"value": ""
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"comments": {
"display_value": "",
"value": ""
},
"approval": {
"display_value": "Approved",
"value": "approved"
},
"due_date": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"sys_mod_count": {
"display_value": "10",
"value": 10.0
},
"on_hold": {
"display_value": "false",
"value": false
},
"sys_tags": {
"display_value": "",
"value": ""
},
"conflict_last_run": {
"display_value": "",
"value": "",
"display_value_internal": ""
},
"risk_value": {
"display_value": "",
"value": ""
},
"unauthorized": {
"display_value": "false",
"value": false
},
"risk": {
"display_value": "Moderate",
"value": 3.0
},
"location": {
"display_value": "",
"value": ""
},
"category": {
"display_value": "Other",
"value": "Other"
},
"risk_impact_analysis": {
"display_value": "",
"value": ""
}
}
}
cURL-Anforderung
Das folgende Beispiel zeigt, wie verschlüsselte Felder im Anforderungstext übergeben werden.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"encrypted_fields\":\"short_description,description\",
\"short_description\":\"my short desc\",
\"description\":\"my desc\"
}" \
--user "username":"password"
cURL-Anforderung
Das folgende Beispiel zeigt, wie verschlüsselte Felder als Abfrageparameter übergeben werden.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/b0dbda5347c12200e0ef563dbb9a718f?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"
Change-Management – PATCH /sn_chg_Rest/Change/{sys_ID}/Approvals
Ermöglicht dem aktuellen Anwender, einen Change-Anforderungsgenehmigungsdatensatz für die angegebene Change-Anforderung zu genehmigen oder abzulehnen.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/Genehmigungen
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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung, für die die Genehmigung/Ablehnung gilt. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Kommentare | Erforderlich, wenn stateIst Abgelehnt . Grund, aus dem der Change abgelehnt wurde.Datentyp: Zeichenfolge |
| Staat | Erforderlich. Genehmigungsstatus. Beispiel: Gültige Werte:
Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 400 | Ungültige Anforderung. Gibt einen ungültigen Anforderungstyp an, z. B. den Anwender, der nicht berechtigt ist, die Change-Anforderung zu genehmigen oder abzulehnen. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Werte für alle Felder in der zugehörigen Change-Anforderung. Datentyp: Objekt |
| Status | Aktueller Status der Change-Anforderung. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung, die genehmigt/abgelehnt wird. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Mögliche Werte:
Datentyp: Zeichenfolge |
| Typ.Wert | 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 mithilfe des ersten gefundenen verfügbaren Zeitfensters.
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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | SYS_ID der Change-Anforderung, für die mit dem nächsten verfügbaren Zeitfenster aktualisiert werden soll. Die ausgewählte Change-Anforderung muss ein Konfigurationselement (cmdb_ci) haben. Datentyp: Zeichenfolge Tabelle: Change-Anforderungen [Change_Request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Duration_in_seconds | Dauer des Change in Sekunden, d. h. wie viel Zeit zum Abschließen der Change-Anforderungsaufgabe erforderlich ist. Datentyp: Ganzzahl |
| Planned_Start_time | Optional. Datum und Uhrzeit, zu der die Implementierung der Change-Anforderung in UTC beginnen soll. Rufen Sie das verfügbare Zeitfenster ab, das um oder nach diesem Zeitpunkt beginnt. Wenn nicht angegeben, verwendet das System die aktuelle Zeit als Startzeit. Format: jjjj-mm-tt hh:mm:ss Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 202 | Das System hat die Anforderung akzeptiert. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Mögliche Probleme:
|
| 403 | Unzulässig. Anwender hat keinen Schreibzugriff auf die geplanten Start- und Enddatumswerte der Change-Anforderung. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden.
Mögliche Probleme:
|
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Fehler | Informationen zu Fehlern, die beim Verarbeiten der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| error.detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.Fehlernachrichten | Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Datentyp: Array |
| messages.infoMessages | Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Datentyp: Array |
| Nachrichten.WarnungsNachrichten | Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Datentyp: Array |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt |
| status.Anzeigewert | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| status.Wert | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| Typ | Typ der Anforderung. Gültiger Wert: Zeitplan Datentyp: Zeichenfolge |
| Mitarbeiter | Informationen zum zugeordneten Mitarbeiter. Datentyp: Objekt |
| Worker.Link | Link zum Abrufen des Zeitplanstatus der Change-Anforderung. Verwenden Sie die sys_ID in RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Zum Anzeigen von Ergebnissen. Datentyp: Zeichenfolge |
| Worker.sysId | SYS_ID des Worker, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge |
| Status | Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
Ruft den Zeitplanstatus der Change-Anforderung ab
Verwenden Sie den in angegebenen Wert worker.linkUm 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 angegebene sys_ID in auszuführen RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Zum Anzeigen von Ergebnissen.
Der Antworttext enthält den Status und liefert Ergebnisse, wenn die Verarbeitung abgeschlossen ist.
Wenn ein verfügbares Zeitfenster gefunden wird, aktualisiert das System die Change-Anforderung mit dem ersten verfügbaren Zeitfenster. Wenn der Status „Abgeschlossen“ ist, wird messages.infoMessagesZeigt an, dass das erste verfügbare Zeitfenster festgelegt wurde.
Change wurde aktualisiert– Angeforderter Change wurde für Zeitfenster aktualisiert.Keine Zeitfenster für <number> Days ab jetzt gefunden– Keine Zeitfenster für die Dauer der Change-Anforderung verfügbar, die innerhalb der im Zeitplanfenster definierten Anzahl von Tagen angegeben wird.Hinweis:Der Standardwert für das Zeitfenster für die Change-Anforderung ist 90 Tage. Um diesen Wert zu ändern, ändern Sie change.conflict.next_available.schedule_windowEigenschaft. Weitere Informationen finden Sie unter Konfigurieren Sie Konfliktanalyseeigenschaften .
Folgendes RUFEN SIE /sn_chg_Rest/Change/Worker/{sys_ID} AB Das Beispiel zeigt die Ausgabe, die mithilfe der im Worker.Link-Detail angegebenen ID bereitgestellt wird. Die Ergebnisse zeigen an, dass die Verarbeitung abgeschlossen ist und die Change-Anforderung mit dem ersten verfügbaren Zeitfenster aktualisiert wurde.
{
"result": {
"worker": {
"sysId": "355c62e0a4c87010f87712198fe9cacf",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 3,
"display_value": "Complete"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": [
"Change has been updated"
]
}
}
}
cURL-Anforderung
curl "https://instance.service-now.com/api/sn_chg_rest/change/87ae5e900a0a2c3e263e8304e727c646/schedule/first_available" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"duration_in_seconds\":\"10800\"}" \
--user "username":"password"
Ergebnisse enthalten Worker.Link-Details, die Sie verwenden können, um die angegebene sys_ID im Endpunkt GET /sn_chg_Rest/Change/Worker/ auszuführen.
{
"result": {
"worker": {
"sysId": "355c62e0a4c87010f87712198fe9cacf",
"link": "https://instance.service-now.com/api/sn_chg_rest/change/worker/355c62e0a4c87010f87712198fe9cacf"
},
"request": "{\"change_sys_id\":\"87ae5e900a0a2c3e263e8304e727c646\",\"duration_in_seconds\":10800,\"timezone\":\"America/Los_Angeles\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "schedule",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}
Change-Management – PATCH /sn_chg_Rest/Change/{Change_sys_ID}/Task/{Task_sys_ID}
Aktualisiert die von den angegebenen sys_IDs identifizierte Change-Anforderungsaufgabe mit den Schlüssel-Wert-Paaren im Anforderungstext oder in der URL.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/Aufgabe/{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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | SYS_ID der Change-Anforderung, der die Aufgabe zugeordnet ist. Überprüft, ob die angegebene Aufgabe der angegebenen Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| task_sys_id | SYS_ID der zu ändernden Aufgabe. Datentyp: Zeichenfolge Tabelle: Change-Aufgabe [Change_Task] |
| Name | Beschreibung |
|---|---|
| Schlüssel-Wert-Paare | Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstext-Parameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Daten | Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um beispielsweise die Kurzbeschreibungsdatei zu aktualisieren, geben Sie ein Name-Wert-Paar ähnlich dem folgenden ein: --Data „{\"short_description\": \"meine Kurzbeschreibung\" }" \ . Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Alle Felder (Schlüssel) mit ihren zugehörigen Werten für die identifizierte Change-Anforderungsaufgabe vor dem Löschen. Datentyp: Objekt |
| sys_id | SYS_ID-Informationen für die Change-Anforderungsaufgabe. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderungsaufgabe, die in einer Anwenderoberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderungsaufgabe. Datentyp: Zeichenfolge |
| übergeordnet | Eindeutige Bezeichnerinformationen für die Change-Anforderung, die dieser Aufgabe zugeordnet ist. Datentyp: Objekt |
| Parent.Display_value | Aufgabeninformationen, die in einer Anwenderoberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| Übergeordnet.Wert | SYS_ID der übergeordneten Aufgabe. Datentyp: Zeichenfolge |
| __Meta.ignoredFelder | Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task/12629ec4b750230096c3e4f6ee11a9d5?short_description=Retire both nodes" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire both nodes",
display_value: "Retire both nodes"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
Change-Management – PATCH /sn_chg_Rest/Change/Emergency/{sys_ID}
Aktualisiert die Notfall-Change-Anforderung, die durch die angegebene 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/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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung, die geändert werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstext-Parameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Daten | Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um beispielsweise die Kurzbeschreibungsdatei zu aktualisieren, geben Sie ein Name-Wert-Paar ähnlich dem folgenden ein: --Data „{\"short_description\": \"meine Kurzbeschreibung\" }" \ . Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Werte für alle Felder in der zugehörigen Change-Anforderung. Datentyp: Zeichenfolge |
| Status | Aktueller Status der Change-Anforderung. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| __Meta.ignoredFelder | Name-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency/b0dbda5347c12200e0ef563dbb9a718f" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"no_such_field\": \"this will be ignored\", }" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f", },
state: {
value: "-4",
display_value: "Assess"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
Change-Management – PATCH /sn_chg_Rest/Change/normal/{sys_ID}
Aktualisiert die normale Change-Anforderung, die durch die angegebene sys_ID identifiziert wird, mit den Parametern im Anforderungstext oder in 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung, die geändert werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstext-Parameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Daten | Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um beispielsweise die Kurzbeschreibungsdatei zu aktualisieren, geben Sie ein Name-Wert-Paar ähnlich dem folgenden ein: --Data „{\"short_description\": \"meine Kurzbeschreibung\" }" \ . Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Werte für alle Felder in der zugehörigen Change-Anforderung. Datentyp: Objekt |
| Status | Aktueller Status der Change-Anforderung. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Wert ist immer „normal“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „normal“. Datentyp: Zeichenfolge |
| __Meta.ignoredFelder | Name-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal/b0dbda5347c12200e0ef563dbb9a718f?state=assess" \
--request PATCH \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data "{\"state\": \"assess\", \"no_such_field\": \"this will be ignored\" }" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-4",
display_value: "Assess"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
Change-Management – PATCH /sn_chg_Rest/Change/Standard/{sys_ID}
Aktualisiert die Standard-Change-Anforderung, die durch die angegebene sys_ID identifiziert wird, mit den Parametern im Anforderungstext oder in 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung, die geändert werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare, die die zu aktualisierenden Felder darstellen. Anforderungstext-Parameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Daten | Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um beispielsweise die Kurzbeschreibungsdatei zu aktualisieren, geben Sie ein Name-Wert-Paar ähnlich dem folgenden ein: --Data „{\"short_description\": \"meine Kurzbeschreibung\" }" \ . Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Alle Felder (Schlüssel) mit ihren zugehörigen Werten für die identifizierte Change-Anforderung. Datentyp: Objekt |
| Status | Status der Change-Anforderung. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen für die Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI bereitgestellt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/standard/1c87925347c12200e0ef563dbb9a7177?description=Reboot my email server" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"short_description\": \"my short desc\" }" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
state: {
value: "-5",
display_value: "New"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot my email server",
display_value: "Reboot my email server"
},
}
]
}
Change-Management – PATCH /sn_chg_Rest/Change/Standard/{sys_ID}/Risk
Berechnet das Risiko und die Auswirkung des angegebenen Standard-Change basierend auf einer Bewertung der Risikobedingungen.
Wenn das Plugin „Change-Risikobewertung“ installiert ist, wird auch das kumulative höchste Risiko berechnet, 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des auszuwertenden Standard-Change. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Risikobewertung erfolgreich abgeschlossen. |
| 400 | Risikobewertung fehlgeschlagen. Details zur Art des Fehlers sind in den Fehlerdaten enthalten. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Impact | Auswirkung, die dem angegebenen Standard-Change zugeordnet ist. Datentyp: Objekt |
| Impact.Display_value | Auswirkungsinformationen, die in einer Anwenderoberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| Impact.Wert | Interner Auswirkungswert. Datentyp: Zeichenfolge |
| Name-Wert-Paare | Alle gültigen Felder im Standard-Change-Datensatz. Datentyp: Objekt |
| Risiko | Für den angegebenen Standard-Change berechnetes Risiko. Datentyp: Objekt |
| Risk.Display_value | Risikoinformationen, die in einer Anwenderoberfläche angezeigt werden sollen. Datentyp: Zeichenfolge |
| Risiko.Wert | Interner Risikowert. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen für die Standard-Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderung. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/1c87925347c12200e0ef563dbb9a7177/risk" \
--request PATCH \
--header "Accept:application/json" \
--user "username":"password"
{
sys_id: {
value: "1c87925347c12200e0ef563dbb9a7177",
display_value: "1c87925347c12200e0ef563dbb9a7177"
},
risk: {
value: "4",
display_value: "Low"
},
impact: {
value: "3",
display_value: "3 - Low"
}
..., // all valid fields in record
}
Change-Management – NACH /sn_chg_Rest/Change
Erstellt einen Change-Anforderungsdatensatz basierend auf der Change-Anforderung. Das Erstellen mehrerer Change-Anforderungen innerhalb eines einzelnen Anrufs wird nicht unterstützt.
Sie können die Liste der verfügbaren Change-Modelle mit abrufen Change-Management – GET /sn_chg_Rest/Change/model Oder Change-Management – GET /sn_chg_Rest/Change/model/{sys_ID} Endpunkte.
Legen Sie beim Erstellen einer Change-Anforderung das Change-Modell fest ( chg_model) Oder type. Wenn beides chg_modelUnd typeSind festgelegt, ist der Typ einfach eine Kategorisierung des Change. Wenn Sie nicht mindestens einen dieser Werte angeben, wird eine Standardeinstellung erstellt, die nach Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen.
Werte können entweder als Abfrageparameter oder Anforderungstext-Parameter 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. 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. Anforderungstext-Parameter überschreiben URL-Parameter. Erforderliche Parameter müssen jedoch in der URL angegeben werden. Dieselben Werte können stattdessen als Anforderungstext-Parameter festgelegt werden. Hinweis: Legen Sie beim Erstellen einer Change-Anforderung das Change-Modell fest ( chg_model) Oder type. Wenn beides chg_modelUnd typeSind festgelegt, ist der Typ einfach eine Kategorisierung des Change. Wenn Sie nicht mindestens einen dieser Werte angeben, wird eine Standardeinstellung erstellt, die nach Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge |
| chg_model | Name eines Change-Modells, das in der Tabelle „Change-Modell“ [chg_model] aufgeführt ist. Wird im folgenden Format bereitgestellt: Weitere Informationen finden Sie unter Change-Modelle . Hinweis: Das Change-Modell ( chg_model) Oder typeWert führt zu einer Standardeinstellung, die nach Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge |
| Encrypted_fields | Liste der kommagetrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt den GlideRecord auf SetDisplayWert() Methode, anstatt aufzurufen SetWert() Methode. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für nicht verschlüsselte Felder wie Referenz- oder Auswahlfelder zu übergeben, anstatt sys_IDs oder Werte zu übergeben. Datentyp: Zeichenfolge |
| Typ | Name des Change-Anforderungstyps, der in der Auswahltabelle [sys_choice] aufgeführt ist. Wenn chg_modelIst ebenfalls ausgefüllt. Dieses Feld wird nur als Change-Kategorisierung verwendet. Wird im folgenden Format bereitgestellt: Weitere Informationen finden Sie unter Fügen Sie einen neuen Change-Anforderungstyp hinzu . Hinweis: Das Change-Modell ( chg_model) Oder typeWert führt zu einer Standardeinstellung, die nach Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Objekt | Name-Wert-Paare, die die Felder darstellen, die in der zugehörigen Change-Anforderung aktualisiert werden sollen. Um beispielsweise die Kurzbeschreibungsdatei zu aktualisieren, geben Sie ein Name-Wert-Paar ähnlich dem folgenden ein: --Data „{\"short_description\": \"meine Kurzbeschreibung\" }" \ . Dieselben Eigenschaften können stattdessen als Abfrageparameter festgelegt werden.Datentyp: Zeichenfolge |
| Object.chg_model | Name eines Change-Modells, das in der Tabelle „Change-Modell“ [chg_model] aufgeführt ist. Wird als Name-Wert-Paar im folgenden Format bereitgestellt: Weitere Informationen finden Sie unter Change-Modelle . Hinweis: Das Change-Modell ( chg_model) Oder typeWert führt zu einer Standardeinstellung, die nach Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge |
| Object.Encrypted_fields | Liste der kommagetrennten Felder, die verschlüsselt werden sollen. Diese Felder werden verschlüsselt, bevor sie im zugehörigen Datensatz gespeichert werden. Wenn angegeben, ruft der Endpunkt den GlideRecord auf SetDisplayWert() Methode, anstatt aufzurufen SetWert() Methode. Aus diesem Grund können Sie diesen Parameter auch verwenden, um Anzeigewerte für nicht verschlüsselte Felder wie Referenz- oder Auswahlfelder zu übergeben, anstatt sys_IDs oder Werte zu übergeben. Datentyp: Zeichenfolge |
| Object.type | Name des Change-Anforderungstyps, der in der Auswahltabelle [sys_choice] aufgeführt ist. Wenn chg_modelIst ebenfalls ausgefüllt. Dieses Feld wird nur als Change-Kategorisierung verwendet. Wird als Name-Wert-Paar im folgenden Format bereitgestellt: Weitere Informationen finden Sie unter Fügen Sie einen neuen Change-Anforderungstyp hinzu . Hinweis: Das Change-Modell ( chg_model) Oder typeWert führt zu einer Standardeinstellung, die nach Release geändert werden kann. Es wird dringend empfohlen, mindestens einen dieser Werte festzulegen. Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | Neuer Change-Anforderungsdatensatz. Die Elemente dieses Objekts entsprechen dem Datensatzformat in der Tabelle „Change-Anforderung“ [Change_Request]. Alle Werte, die nicht in der Anforderung angegeben sind, werden auf ihre Standardwerte festgelegt oder sind leer/null. Datentyp: Objekt |
cURL-Anforderung
Das folgende Beispiel zeigt, wie ein Change-Anforderungsdatensatz 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 hinzugefügt wurde CHG0030022 .
{
"result":
"upon_reject": {
"display_value": "Cancel all future Tasks",
"value": "cancel"
},
"sys_updated_on": {
"display_value": "2022-12-08 17:18:57",
"value": "2022-12-09 01:18:57",
"display_value_internal": "2022-12-08 17:18:57"
},
"type": {
"display_value": "Standard",
"value": "standard"
}
"number": {
"display_value": "CHG0030022",
"value": "CHG0030022"
},
"is_bulk": {
"display_value": "false",
"value": false
}
"ci_class": {
"display_value": "cmdb_ci",
"value": "cmdb_ci"
},
"state": {
"display_value": "New",
"value": -5
},
"sys_created_by": {
"display_value": "admin",
"value": "admin"
},
"knowledge": {
"display_value": "false",
"value": false
},
"phase": {
"display_value": "Requested",
"value": "requested"
}
"impact": {
"display_value": "3 - Low",
"value": 3
},
"active": {
"display_value": "true",
"value": true
},
"priority": {
"display_value": "4 - Low",
"value": 4
},
"sys_domain_path": {
"display_value": "/",
"value": "/"
},
"production_system": {
"display_value": "false",
"value": false
},
"requested_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
}
"short_description": {
"display_value": "My change request",
"value": "My change request"
},
"sys_class_name": {
"display_value": "Change Request",
"value": "change_request"
},
"reassignment_count": {
"display_value": "0",
"value": 0
},
"variables": {
"display_value": "variable_pool",
"value": "variable_pool"
},
"sla_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"escalation": {
"display_value": "Normal",
"value": 0
},
"upon_approval": {
"display_value": "Proceed to Next Task",
"value": "proceed"
},
"conflict_status": {
"display_value": "Not Run",
"value": "Not Run"
},
"task_effective_number": {
"display_value": "CHG0030022",
"value": "CHG0030022"
},
"sys_updated_by": {
"display_value": "admin",
"value": "admin"
},
"opened_by": {
"display_value": "System Administrator",
"value": "6816f79cc0a8016401c5a33be04be441"
},
"sys_created_on": {
"display_value": "2022-12-08 17:18:57",
"value": "2022-12-09 01:18:57",
"display_value_internal": "2022-12-08 17:18:57"
},
"sys_domain": {
"display_value": "global",
"value": "global"
},
"chg_model": {
"display_value": "Standard",
"value": "e55d0bfec343101035ae3f52c1d3ae49"
},
"opened_at": {
"display_value": "2022-12-08 17:18:57",
"value": "2022-12-09 01:18:57",
"display_value_internal": "2022-12-08 17:18:57"
},
"description": {
"display_value": "Describes the change request.",
"value": "Describes the change request."
},
"sys_id": {
"display_value": "2ac52dd77c6b1510f877be3b096e64fe",
"value": "2ac52dd77c6b1510f877be3b096e64fe"
},
"cab_required": {
"display_value": "false",
"value": false
},
"urgency": {
"display_value": "3 - Low",
"value": 3
},
"scope": {
"display_value": "Medium",
"value": 3
},
"activity_due": {
"display_value": "UNKNOWN",
"value": "",
"display_value_internal": ""
},
"approval": {
"display_value": "Not Yet Requested",
"value": "not requested"
},
}
}
cURL-Anforderung
Das folgende Beispiel zeigt, wie verschlüsselte Felder im Anforderungstext übergeben werden.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"encrypted_fields\":\"short_description,description\",
\"short_description\":\"my short desc\",
\"description\":\"my desc\"
}" \
--user "username":"password"
cURL-Anforderung
Das folgende Beispiel zeigt, wie verschlüsselte Felder als Abfrageparameter übergeben werden.
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change?encrypted_fields=short_description%2Cdescription&short_description=my%20short%20desc&description=my%20desc" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{}" \
--user "username":"password"
Change-Management – NACH /sn_chg_Rest/Change/{sys_ID}/ci
Erstellt die Zuordnung zwischen einer Change-Anforderung und Configuration Management Database (CMDB) Konfigurationselemente (CI).
Die Erstellung der Zuordnung erfolgt asynchron, was bedeutet, dass sofort eine Antwort bereitgestellt wird und Details für den Mitarbeiter enthält. Der Mitarbeiter führt die tatsächliche 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung, die dem CMDB-CI zugeordnet werden soll. Datentyp: Zeichenfolge |
| 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 kommagetrennte Zeichenfolge |
| REFRESH_Impact_Services | Kennzeichnung verwendet, wenn association_type=affected Zum Ausfüllen betroffener Services basierend auf der Liste der betroffenen CIs.Gültige Werte:
Datentyp: Boolesch Standardwert: false |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 202 | Akzeptiert. Die Anforderung wurde zur Verarbeitung akzeptiert. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. Die Fehlerantwort enthält relevante Nachrichten, die bei der Behebung des Problems helfen. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.Fehlernachrichten | Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben Datentyp: Array |
| messages.infoMessages | Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Zum Beispiel: CMDB_CI sys_ID ist bereits angegeben. Datentyp: Array |
| Nachrichten.WarnungsNachrichten | Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben. Datentyp: Array |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. |
| status.Anzeigewert | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueElement. Mögliche Werte:
Datentyp: Zeichenfolge |
| status.Wert | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| Typ | 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 Worker, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/ci" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{cmdb_ci_sys_ids:'caf043a3b7fb23000999e4f6ee11a9c0,06f043a3b7fb23000999e4f6ee11a9c1', association_type:'affected'}" \
--user "username":"password"
{
"result": {
"worker": {
"sysId": "f490f4c6dbac330084f07ffdbf961952",
"link": "instance.service-now.com/api/sn_chg_rest/change/worker/f490f4c6dbac330084f07ffdbf961952"
},
"request": "{\"cmdb_ci_sys_ids\":[\"caf043a3b7fb23000999e4f6ee11a9c0\",\"06f043a3b7fb23000999e4f6ee11a9c1\"],\"association_type\":\"affected\",\"task\":\"c286d61347c12200e0ef563dbb9a71df\"}",
"state": {
"value": 1,
"display_value": "Waiting"
},
"type": "affected",
"messages": {
"errorMessages": [],
"warningMessages": [],
"infoMessages": []
}
}
}
Change-Management – NACH /sn_chg_Rest/Change/{sys_ID}/Konflikt
Startet einen Prozess zur Konfliktprüfung für Change-Anforderungen für die angegebene Change-Anforderung (sys_ID).
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/Konflikt
Standard-URL: /api/sn_chg_Rest/Change/{sys_ID}/Konflikt
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Management-Anforderung, für die der Konfliktprüfungsprozess gestartet werden soll. Weitere Informationen zum Konfliktprüfungsprozess finden Sie unter Konflikterkennung . Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Die Anforderung konnte aufgrund nicht auflösbarer Fehler nicht gestartet werden. Die zurückgegebene Nachricht kann zusätzliche Details enthalten. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Ergebnis | SYS_ID des Prozesses zur Konfliktprüfung für Change-Anforderungen. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/0f4ac6c4b750230096c3e4f6ee11a9fe/conflict" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: "c0b5afe4b710230096c3e4f6ee11a93f"
}
Change-Management – NACH /sn_chg_Rest/Change/Emergency
Erstellt eine Notfall-Change-Anforderung basierend auf dem Standard-Notfall-Change-Anforderungsdatensatz. Mehrere Erstellungen von Notfall-Change-Anforderungen 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. 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 ist die Informationen, die im Feld ausgefüllt werden sollen. Felder, die nicht geändert werden können und bei Übergabe ignoriert werden:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare der Felder, die in der Notfall-Change-Anforderung erstellt wurden. Datentyp: Objekt |
| Status | Status der Change-Anforderung vor dem Löschen. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Wert ist immer „Neu“. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Wert ist immer „-5“. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der neu erstellten Notfall-Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „Notfall“. Datentyp: Zeichenfolge |
| __Meta.ignoredFelder | Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/emergency?no_such_field=something&description=test&short_description=Reboot server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "emergency",
display_value: "Emergency"
},
..., // all valid fields in record, example below
short_description: {
value: "Reboot server",
display_value: "Reboot server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
Change-Management – POST /sn_chg_Rest/Change/normal
Erstellt eine normale Change-Anforderung basierend auf dem standardmäßigen normalen Change-Anforderungsdatensatz. Mehrere normale Change-Anforderungserstellungen 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. 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 der Anforderung geändert werden sollen. Der Schlüssel ist der Feldname in der Vorlage, und der Wert ist die Informationen, die im Feld ausgefüllt werden sollen. Felder, die nicht geändert werden können und bei Übergabe ignoriert werden:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Werte für alle Felder in der zugehörigen Change-Anforderung. Datentyp: Objekt |
| Status | Status der neu erstellten Change-Anforderung. Datentyp: Objekt |
| status.Anzeigewert | Status, der in einer UI angezeigt werden soll. Wert ist immer „Neu“. Datentyp: Zeichenfolge |
| status.Wert | Interner Statuswert. Wert ist immer „-5“. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der neu erstellten normalen Change-Anforderung. Datentyp: Zeichenfolge |
| Typ | Der Typ des Change Requests. Datentyp: Objekt |
| Typ.Display_value | Change-Typ, der in einer Anwenderoberfläche angezeigt werden soll. Wert ist immer „normal“. Datentyp: Zeichenfolge |
| Typ.Wert | Interner Typwert. Wert ist immer „normal“. Datentyp: Zeichenfolge |
| __Meta.ignoredFelder | Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/normal?no_such_field=something&description=test&short_description=Remove server" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: "b0dbda5347c12200e0ef563dbb9a718f",
state: {
value: "-5",
display_value: "New"
},
type: {
value: "normal",
display_value: "Normal"
},
..., // all valid fields in record, example below
short_description: {
value: "Remove server",
display_value: "Remove server"
}
__meta: {
ignoredFields: ["no_such_field"]
}
}
]
}
Change-Management – POST /sn_chg_Rest/Change/{sys_ID}/refresh_Impact_Services
Füllt die zugehörige Liste „betroffene Services/Konfigurationselemente (CIs)“ basierend auf dem primären CI aus.
Das primäre CI wird im Formular „Change-Anforderung“ und der zugehörigen Liste „Betroffene CI“ angezeigt.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{sys_ID}/refresh_Impact_Services
Standard-URL: /api/sn_chg_Rest/Change/{sys_ID}/REFRESH_Impact_Services
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| sys_id | SYS_ID der Change-Anforderung, die zum Aktualisieren der betroffenen Services verwendet werden soll. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen 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. Die Antwort enthält zusätzliche Informationen zum Fehler. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Nachrichten | Nachrichteninformationen. Datentyp: Objekt |
| Nachrichten.Fehlernachrichten | Beim Verarbeiten der Anforderung sind Fehlermeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben Datentyp: Array |
| messages.infoMessages | Bei der Verarbeitung der Anforderung sind Informationsnachrichten aufgetreten. Zum Beispiel: CMDB_CI sys_ID ist bereits angegeben. Datentyp: Array |
| Nachrichten.WarnungsNachrichten | Beim Verarbeiten der Anforderung sind Warnmeldungen aufgetreten. Zum Beispiel: Ungültige sys_ID für CMDB_CI angegeben. Datentyp: Array |
| Anforderung | Ursprüngliche Endpunktanforderung. Datentyp: Zeichenfolge |
| Status | Informationen zum aktuellen Status des Mitarbeiters. Datentyp: Objekt |
| status.Anzeigewert | Anzeigewert des Status des Mitarbeiters. Diese Werte korrelieren direkt mit state.valueElement. Mögliche Werte:
Datentyp: Zeichenfolge |
| status.Wert | Numerischer Wert des Status des Mitarbeiters. Mögliche Werte:
Datentyp: Zahl |
| Typ | 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 Worker, der der Change-Anforderung zugeordnet ist. Datentyp: Zeichenfolge |
cURL-Anforderung
curl "https://instance.servicenow.com/api/sn_chg_rest/v1/change/c286d61347c12200e0ef563dbb9a71df/refresh_impacted_services" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--user "username":"password"
{
result: {
worker: {
sysId: "aa31c308b75033000999e4f6ee11a9c2",
link: "http://instance.service-now.com/api/sn_chg_rest/change/worker/aa31c308b75033000999e4f6ee11a9c2"
},
request: "",
state: {
value: 1,
display_value: "Waiting"
},
type: "impacted",
messages: {
errorMessages: [],
warningMessages: [],
infoMessages: []
}
}
}
Change-Management – NACH /sn_chg_Rest/Change/Standard/{standard_change_template_id}
Erstellt eine Standard-Change-Anforderung basierend auf einer vorhandenen Standard-Change-Vorlage, wie durch die übergebene Vorlage „sys_ID“ angegeben Mehrere Standard-Change-Anforderungserstellungen innerhalb eines einzelnen Anrufs 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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| standard_change_template_id | SYS_ID der Standard-Change-Vorlage, auf der die neue Standard-Change-Anforderung basieren soll. Datentyp: Zeichenfolge Tabelle: Standard-Change-Vorlage [std_change_record_producer] |
| Parameter | Beschreibung |
|---|---|
| Name-Wert-Paare | Felder innerhalb der angegebenen Standard-Change-Vorlage, die beim Erstellen der Anforderung geändert werden sollen. Der Schlüssel ist der Feldname in der Vorlage, und der Wert ist die Informationen, die im Feld ausgefüllt werden sollen. Felder, die nicht geändert werden können und bei Übergabe ignoriert werden:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext
Die API gibt diese JSON- oder XML-Elemente im Antworttext zurück.
| Element | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare der Felder, die in der Standard-Change-Anforderung erstellt wurden. Datentyp: Objekt |
| sys_id | SYS_ID-Informationen der neu erstellten Standard-Change-Anforderung. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Standard-Change-Anforderung, die in einer UI angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Standard-Change-Anforderung. Datentyp: Zeichenfolge |
| __Meta.ignoredFelder | Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array |
Beispiel für 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}/Aufgabe
Erstellt eine Change-Anforderungsaufgabe basierend auf dem Standard-Change-Anforderungsaufgabendatensatz und ordnet sie der angegebenen Change-Anforderung zu. Die Erstellung mehrerer Change-Anforderungsaufgaben innerhalb eines einzelnen Anrufs wird nicht unterstützt.
URL-Format
Versionierte URL: /api/sn_chg_Rest/{api_Version}/Change/{Change_sys_ID}/Aufgabe
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. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| change_sys_id | SYS_ID der Change-Anforderung, der diese Aufgabe zugeordnet werden soll. Datentyp: Zeichenfolge Tabelle: Change Request [change_request] |
| Name | Beschreibung |
|---|---|
| Schlüssel-Wert-Paare | Felder, die beim Erstellen der Anforderung geändert werden sollen. Der Schlüssel ist der Feldname in der Vorlage, und der Wert ist die Informationen, die im Feld ausgefüllt werden sollen. Felder, die nicht geändert werden können und bei Übergabe ignoriert werden:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Header
Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Header | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Header | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter REST-API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich abgeschlossen. |
| 400 | Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Der angegebene Datensatz wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim serverseitigen Code ist ein Logikfehler aufgetreten. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name-Wert-Paare | Name-Wert-Paare der Felder, die in der Change-Anforderungsaufgabe erstellt wurden. Datentyp: Objekt |
| übergeordnet | Informationen für die Change-Anforderung, die der Aufgabe zugeordnet ist. Datentyp: Objekt |
| Parent.Display_value | Informationen, die in der Anwenderoberfläche für die Change-Anforderung angezeigt werden sollen, die der Aufgabe zugeordnet ist. Datentyp: Zeichenfolge |
| Übergeordnet.Wert | SYS_ID der Change-Anforderung, die der Aufgabe zugeordnet ist. Datentyp: Zeichenfolge |
| sys_id | SYS_ID-Informationen der neu erstellten Change-Anforderungsaufgabe. Datentyp: Objekt |
| sys_ID.Anzeigewert | SYS_ID der Change-Anforderungsaufgabe, die in einer Anwenderoberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| sys_ID.Wert | SYS_ID der Change-Anforderungsaufgabe. Datentyp: Zeichenfolge |
| __Meta.ignoredFelder | Schlüssel-Wert-Paare, die im Aufruf übergeben wurden, aber nicht auf die Change-Anforderung angewendet wurden, da sie entweder nicht im Basisdatensatz vorhanden sind oder die Felder schreibgeschützt sind. Datentyp: Array |
cURL-Anforderung
curl "https://instance.servicenow.com/api/now/change/0f4ac6c4b750230096c3e4f6ee11a9fe/task?short_description=Retire node&no_such_field=test" \
--request POST \
--header "Accept:application/json" \
--user "username":"password"
{
result: [
{
sys_id: {
value: "12629ec4b750230096c3e4f6ee11a9d5",
display_value: "12629ec4b750230096c3e4f6ee11a9d5"
},
parent: {
value: "0f4ac6c4b750230096c3e4f6ee11a9fe ",
display_value: "CHG0033046 "
},
..., // all valid fields in record, example below
short_description: {
value: "Retire node",
display_value: "Retire node"
}
__meta.ignoredFields": ["no_such_field"]
}
]
}