DevOps Config-API
Die DevOps-Konfiguration Die API stellt Endpunkte zur Verwaltung Ihrer Anwendungen bereit.
Diese API erfordert DevOps Config Anwendung und wird in bereitgestellt sn_devops_config Namespace.
Für LÖSCHVORGÄNGE, PATCH- und POST-Vorgänge muss der aufrufende Anwender über die Rolle sn_devops_config.admin verfügen. Für GET-Vorgänge muss der aufrufende Anwender über die Rolle sn_devops_config.Viewer oder sn_devops_config.admin verfügen.
Verwenden Sie DevOps-Konfiguration API für das Management des Anwendungslebenszyklus. Weitere Informationen zum Verwalten von Anwendungen mit finden Sie DevOps Config, Siehe DevOps Config wird konfiguriert .
DevOps Config: LÖSCHEN SIE /devops_config/Application/{appid}
Löscht eine Anwendung.
URL-Format
Versionierte URL: /api/sn_devops_config/{api_Version}/devops_config/Application/{appid}
Standard-URL: /api/sn_devops_config/devops_config/Application/{appid}
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 |
| appid | SYS_ID der zu löschenden Anwendung. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ungültige Anwendungs-ID |
| 403 | Unzulässig. Der Anwender hat keine Berechtigung zum Zugriff auf die API. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Fehler | Fehlerinformationen. Dieser Parameter wird nur zurückgegeben, wenn die Anforderung fehlgeschlagen ist. Datentyp: Objekt |
| error.detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung mit dem Grund, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnisobjekt mit Informationen zur Anforderung. Datentyp: Objekt |
| Ergebnis.Fehler | Array von Fehlern aus der Anforderung. Das Array ist für erfolgreiche Anforderungen leer. Datentyp: Array |
| Ergebnis.Erfolg | Erfolgsmeldung für die Anforderung. Das Array ist für fehlgeschlagene Anforderungen leer. Datentyp: Array |
| status | Status der Anforderung. Dieser Parameter wird nur zurückgegeben, wenn die Anforderung fehlgeschlagen ist. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel wird eine Anwendung gelöscht.
curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'
Antworttext.
{
"result": {
"errors": [],
"success": [
"CDM Application Demo Application 1234 has been deleted successfully."
]
}
}
cURL-Anforderung
Dieses Beispiel zeigt eine Fehlerantwort, wenn ein Anwender keine Berechtigung zum Zugriff auf die API hat.
curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'
Fehlerantwort.
{
"error": {
"message": "User Not Authorized",
"detail": "Failed API level ACL Validation"
},
"status": "failure"
}
DevOps Config – GET /devops_config/Application/{appid}
Ruft eine Anwendung ab.
URL-Format
Versionierte URL: /api/sn_devops_config/{api_Version}/devops_config/Application/{appid}
Standard-URL: /api/sn_devops_config/devops_config/Application/{appid}
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 |
| appid | SYS_ID der abzurufenden Anwendung. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ungültige Anwendungs-ID |
| 403 | Unzulässig. Der Anwender hat keine Berechtigung zum Zugriff auf die API. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Fehler | Fehlerinformationen. Dieser Parameter wird nur zurückgegeben, wenn die Anforderung fehlgeschlagen ist. Datentyp: Objekt |
| error.detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung mit dem Grund, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnisobjekt mit Informationen zur Anforderung. Datentyp: Objekt |
| Ergebnis.Daten | Daten für die Anwendung. Datentyp: Objekt |
| Ergebnis.Daten.appBeschreibung | Beschreibung der Anwendung. Datentyp: Zeichenfolge |
| Ergebnis.Daten.appId | SYS_ID der Anwendung. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| Ergebnis.Daten.appManagedByGroups | Kommagetrennte Liste der sys_IDs der Gruppen, die die Anwendung verwalten. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group] |
| Ergebnis.Daten.appManufacturerId | SYS_ID des Herstellers. Datentyp: Zeichenfolge Tabelle: Unternehmen [Core_Company] |
| Ergebnis.Daten.appHerstellername | Name des Herstellers. Datentyp: Zeichenfolge |
| Ergebnis.Daten.appModelId | SYS_ID des Anwendungsmodells. Datentyp: Zeichenfolge Tabelle: Anwendungsmodell [cmdb_Application_Product_model] |
| Ergebnis.Daten.appModelName | Name des Anwendungsmodells. Datentyp: Zeichenfolge Tabelle: Anwendungsmodell [cmdb_Application_Product_model] |
| Ergebnis.Daten.appModelOwnerId | SYS_ID des Besitzers des Anwendungsmodells. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| Ergebnis.Daten.appModelOwnerName | Name des Besitzers des Anwendungsmodells. Datentyp: Zeichenfolge |
| Ergebnis.Daten.appName | Name der Anwendung. Datentyp: Zeichenfolge |
| Ergebnis.Daten.Fehler | Fehlerinformationen. Dieser Parameter wird nur zurückgegeben, wenn die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Ergebnis.Daten.sdlcType | Typ der Anwendung. Mögliche Werte:
Datentyp: Zeichenfolge |
| Ergebnis.Nachricht | Informationen zum erfolgreichen oder nicht erfolgreichen Ergebnis der Anforderung. Datentyp: Zeichenfolge |
| Ergebnis.Status | Statuscode für die Anforderung. Mögliche Werte:
Datentyp: Zahl |
| status | Status der Anforderung. Dieser Parameter wird nur zurückgegeben, wenn die Anforderung fehlgeschlagen ist. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel wird eine Anwendung abgerufen.
curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Antworttext.
{
"result": {
"status": 200,
"message": "Success",
"data": {
"appName": "Demo Application 1234",
"appId": "38e17dc3473d111072566862736d43c7",
"appDescription": "Updated description of Demo Application created from REST API",
"sdlcType": "application",
"appModelId": "a4e13dc3473d111072566862736d4307",
"appModelName": "Demo Application 1234",
"appManufacturerId": "262702654725d950a34a3085d36d435e",
"appManufacturerName": "",
"appModelOwnerId": "6816f79cc0a8016401c5a33be04be441",
"appModelOwnerName": "System Administrator",
"appManagedByGroups": []
}
}
}
cURL-Anforderung
Dieses Beispiel zeigt eine Fehlerantwort, wenn ein Anwender eine ungültige Anwendungs-ID angibt
curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/18a17de3283d15107256686277777777" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
Fehlerantwort.
{
"result": {
"status": 400,
"message": "No valid Application",
"data": {
"error": "No valid Application"
}
}
}
DevOps Config: PATCH /devops_config/Application/{appid}
Aktualisiert eine Anwendung.
URL-Format
Versionierte URL: /api/sn_devops_config/{api_Version}/devops_config/Application/{appid}
Standard-URL: /api/sn_devops_config/devops_config/Application/{appid}
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 |
| appid | SYS_ID der zu aktualisierenden Anwendung. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| AppBeschreibung | Beschreibung der Anwendung. Datentyp: Zeichenfolge |
| AppManagedByGroups | Kommagetrennte Liste der sys_IDs der Gruppen, die die Anwendung verwalten. Der aufrufende Anwender muss diesen Gruppen angehören.Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group] |
| AppManufacturerId | SYS_ID des Herstellers. Datentyp: Zeichenfolge Tabelle: Unternehmen [Core_Company] |
| AppModelOwnerId | SYS_ID des Besitzers des Anwendungsmodells. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anwendung erfolgreich aktualisiert. |
| 403 | Unzulässig. Der Anwender hat keine Berechtigung zum Zugriff auf die API. |
| 404 | Anwendung nicht aktualisiert. Die messageEigenschaft in resultObjekt enthält zusätzliche Informationen zum Fehler. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Fehler | Fehlerinformationen. Dieser Parameter wird nur zurückgegeben, wenn die Anforderung fehlgeschlagen ist. Datentyp: Objekt |
| error.detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung mit dem Grund, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnisobjekt mit Informationen zur Anwendung. Datentyp: Objekt |
| Ergebnis.Daten | SYS_ID der Anwendung. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| Ergebnis.Nachricht | Informationen zum erfolgreichen oder nicht erfolgreichen Ergebnis der Anforderung. Datentyp: Zeichenfolge |
| status | Status der Anforderung. Dieser Parameter wird nur zurückgegeben, wenn die Anforderung fehlgeschlagen ist. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel wird eine vorhandene Anwendung aktualisiert.
curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application/38e17dc3473d111072566862736d43c7" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"appDescription\": \"Updated description of Demo Application created from REST API\",
\"appManufacturerId\": \"262702654725d950a34a3085d36d435e\",
\"appModelOwnerId\": \"6816f79cc0a8016401c5a33be04be441\"
}" \
--user 'username':'password'
Antworttext.
{
"result": {
"message": "Application with name Demo Application 1234 updated successfully.",
"data": "38e17dc3473d111072566862736d43c7"
}
}
DevOps Config: POST /devops_config/Application
Erstellt eine Anwendung.
URL-Format
Versionierte URL: /api/sn_devops_config/{api_Version}/devops_config/Application
Standard-URL: /api/sn_devops_config/devops_config/Application
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 |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| AppBeschreibung | Beschreibung der Anwendung. Datentyp: Zeichenfolge |
| AppManagedByGroups | Kommagetrennte Liste der sys_IDs der Gruppen, die die Anwendung verwalten. Der aufrufende Anwender muss diesen Gruppen angehören.Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group] |
| AppManufacturerId | SYS_ID des Herstellers. Datentyp: Zeichenfolge Tabelle: Unternehmen [Core_Company] |
| AppModelId | SYS_ID eines vorhandenen Anwendungsmodells, das zum Erstellen der Anwendung verwendet werden soll. Wenn dieser Parameter angegeben ist, geben Sie nicht an appName, appModelName, appServiceName, appServiceId, Oder technicalServiceIdParameter. Datentyp: Zeichenfolge Tabelle:Anwendungsmodell [cmdb_Application_Product_model] |
| AppModelName | Name eines vorhandenen Anwendungsmodells, das zum Erstellen der Anwendung verwendet werden soll. Wenn dieser Parameter angegeben ist, geben Sie nicht an appName, appModelId, appServiceName, appServiceId, Oder technicalServiceIdParameter. Datentyp: Zeichenfolge Tabelle:Anwendungsmodell [cmdb_Application_Product_model] |
| AppModelOwnerId | SYS_ID des Besitzers des Anwendungsmodells. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| appName | Name der Anwendung. Verwenden Sie nicht denselben Namen wie eine vorhandene Anwendung. Wenn dieser Parameter angegeben ist, geben Sie nicht an appModelName, appModelId, appServiceName, appServiceId, Oder technicalServiceIdParameter. Datentyp: Zeichenfolge |
| appServiceId | SYS_ID eines vorhandenen Anwendungsservice, der zum Erstellen der Anwendung verwendet werden soll. Verwenden Sie diesen Parameter nur, wenn typeIst Anwendung . Wenn dieser Parameter angegeben ist, geben Sie nicht an appName, appModelName, appModelId, appServiceName, Oder technicalServiceIdParameter. Datentyp: Zeichenfolge Tabelle: Serviceinstanz [cmdb_ci_Service_Auto] |
| AppServiceName | Name eines vorhandenen Anwendungsservice, der zum Erstellen der Anwendung verwendet werden soll. Verwenden Sie diesen Parameter nur, wenn typeIst Anwendung . Wenn dieser Parameter angegeben ist, geben Sie nicht an appName, appModelName, appModelId, appServiceId, Oder technicalServiceIdParameter. Datentyp: Zeichenfolge Tabelle: Serviceinstanz [cmdb_ci_Service_Auto] |
| TechnikalServiceId | SYS_ID einer vorhandenen dynamischen CI-Gruppe, die zum Erstellen der Anwendung verwendet werden soll. Verwenden Sie diesen Parameter nur, wenn typeIst Infrastruktur . Wenn dieser Parameter angegeben ist, geben Sie nicht an appName, appModelName, appModelId, appServiceName, Oder appServiceIdParameter. Datentyp: Zeichenfolge Tabelle: Dynamische CI-Gruppe [cmdb_ci_query_based_Service] |
| type | Erforderlich. Der Typ der zu erstellenden Anwendung. Gültige Werte:
Datentyp: Zeichenfolge |
Header
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 201 | Anwendung erfolgreich erstellt. |
| 403 | Unzulässig. Der Anwender hat keine Berechtigung zum Zugriff auf die API. |
| 404 | Anwendung nicht erstellt. Die messageEigenschaft in resultObjekt enthält zusätzliche Informationen zum Fehler. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Fehler | Fehlerinformationen. Dieser Parameter wird nur zurückgegeben, wenn die Anforderung fehlgeschlagen ist. Datentyp: Objekt |
| error.detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung mit dem Grund, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnisobjekt mit Informationen zur Anwendung. Datentyp: Objekt |
| Ergebnis.Daten | SYS_ID der Anwendung. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_Application] |
| Ergebnis.Nachricht | Informationen zum erfolgreichen oder nicht erfolgreichen Ergebnis der Anforderung. Datentyp: Zeichenfolge |
| status | Status der Anforderung. Dieser Parameter wird nur zurückgegeben, wenn die Anforderung fehlgeschlagen ist. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
cURL-Anforderung
Dieses Beispiel zeigt, wie eine neue Anwendung erstellt wird.
curl "https://instance.service-now.com/api/sn_devops_config/devops_config/application" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"type\": \"application\",
\"appName\": \"Demo Application 1234\",
\"appDescription\": \"Description of Demo Application created from REST API\",
\"appManufacturerId\": \"262702654725d950a34a3085d36d435e\",
\"appModelOwnerId\": \"6816f79cc0a8016401c5a33be04be441\"
}" \
--user 'username':'password'
Antworttext.
{
"result": {
"message": "Application with name Demo Application 1234 created successfully.",
"data": "38e17dc3473d111072566862736d43c7"
}
}