DevOps Config-API
Die DevOps Config- API bietet Endpunkte zum Verwalten Ihrer Anwendungen.
Diese API erfordert die Anwendung DevOps Config und wird im Namespace sn_devops_config bereitgestellt.
Für DELETE-, PATCH- und POST-Vorgänge muss der aufrufende Benutzer die Rolle sn_devops_config.admin haben. Für GET-Vorgänge muss der aufrufende Benutzer die Rolle sn_devops_config.viewer oder sn_devops_config.admin haben.
Verwenden Sie die DevOps Config -API für die Lebenszyklusverwaltung von Anwendungen. Weitere Informationen zum Verwalten von Anwendungen mit DevOps Configfinden Sie unter DevOps Config konfigurieren.
DevOps Config – DELETE /devops_config/application/{appid}
Löscht eine Anwendung.
URL-Format
Versionierte URL: /api/sn_devops_config/v1/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. Zum 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. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstü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 HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ungültige Anwendungs-ID. |
| 403 | Unzulässig. Der Benutzer hat keine Berechtigung für den 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 |
| Fehler.Detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung mit dem Grund für die fehlgeschlagene Anforderung. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnisobjekt, das Informationen zur Anforderung enthält. Datentyp: Objekt |
| result.errors | Array von Fehlern aus der Anforderung. Bei erfolgreichen Anforderungen ist das Array 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 Benutzer keine Berechtigung für den 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/v1/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. Zum 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. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstü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 HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ungültige Anwendungs-ID. |
| 403 | Unzulässig. Der Benutzer hat keine Berechtigung für den 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 |
| Fehler.Detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Fehlermeldung mit dem Grund für die fehlgeschlagene Anforderung. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnisobjekt, das Informationen zur Anforderung enthält. Datentyp: Objekt |
| result.data | Daten für die Anwendung. Datentyp: Objekt |
| result.data.appDescription | Beschreibung der Anwendung. Datentyp: Zeichenfolge |
| result.data.appId | Sys_id der Anwendung. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. Datentyp: Zeichenfolge |
| result.data.appManagedByGroups | Kommagetrennte Liste von sys_ids der Gruppen, die die Anwendung verwalten. Befindet sich in der Gruppentabelle [sys_user_group]. Datentyp: Zeichenfolge |
| result.data.appManufacturerId | Sys_id des Herstellers. Befindet sich in der Tabelle „Unternehmen“ [core_company]. Datentyp: Zeichenfolge |
| result.data.appManufacturerName | Name des Herstellers. Datentyp: Zeichenfolge |
| result.data.appModelId | Sys_id des Anwendungsmodells. Befindet sich in der Tabelle „Anwendungsmodell“ [cmdb_application_product_model]. Datentyp: Zeichenfolge |
| result.data.appModelName | Name des Anwendungsmodells. Befindet sich in der Tabelle „Anwendungsmodell“ [cmdb_application_product_model]. Datentyp: Zeichenfolge |
| result.data.appModelOwnerId | Sys_id des Anwendungsmodellbesitzers. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| result.data.appModelOwnerName | Name des Besitzers des Anwendungsmodells. Datentyp: Zeichenfolge |
| result.data.appName | Der Name der Anwendung. Datentyp: Zeichenfolge |
| result.data.error | Fehlerinformationen. Dieser Parameter wird nur zurückgegeben, wenn die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| result.data.sdlcType | Typ der Anwendung. Mögliche Werte:
Datentyp: Zeichenfolge |
| result.message | Informationen über das erfolgreiche oder nicht erfolgreiche Ergebnis der Anforderung. Datentyp: Zeichenfolge |
| result.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 Benutzer 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/v1/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. Zum 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. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| appDescription | Beschreibung der Anwendung. Datentyp: Zeichenfolge |
| appManagedByGroups | Kommagetrennte Liste von sys_ids der Gruppen, die die Anwendung verwalten. Der anrufende Benutzer muss zu diesen Gruppen gehören. Befindet sich in der Gruppentabelle [sys_user_group]. Datentyp: Zeichenfolge |
| appManufacturerId | Sys_id des Herstellers. Befindet sich in der Tabelle „Unternehmen“ [core_company]. Datentyp: Zeichenfolge |
| appModelOwnerId | Sys_id des Anwendungsmodellbesitzers. Befindet sich in der Benutzertabelle [sys_user]. 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 HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Anwendung erfolgreich aktualisiert. |
| 403 | Unzulässig. Der Benutzer hat keine Berechtigung für den Zugriff auf die API. |
| 404 | Anwendung nicht aktualisiert. Die Eigenschaft messageresult im Objekt [] 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 |
| Fehler.Nachricht | Fehlermeldung mit dem Grund für die fehlgeschlagene Anforderung. Datentyp: Zeichenfolge |
| Fehler.Detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnisobjekt, das Informationen zur Anwendung enthält. Datentyp: Objekt |
| result.message | Informationen über das erfolgreiche oder nicht erfolgreiche Ergebnis der Anforderung. Datentyp: Zeichenfolge |
| result.data | Sys_id der Anwendung. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. 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/v1/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. Zum 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 |
|---|---|
| appDescription | Beschreibung der Anwendung. Datentyp: Zeichenfolge |
| appManagedByGroups | Kommagetrennte Liste von sys_ids der Gruppen, die die Anwendung verwalten. Der anrufende Benutzer muss zu diesen Gruppen gehören. Befindet sich in der Gruppentabelle [sys_user_group]. Datentyp: Zeichenfolge |
| appManufacturerId | Sys_id des Herstellers. Befindet sich in der Tabelle „Unternehmen“ [core_company]. Datentyp: Zeichenfolge |
| appModelId | Sys_id eines vorhandenen Anwendungsmodells, das zum Erstellen der Anwendung verwendet werden soll. Befindet sich in der Tabelle „Anwendungsmodell“ [cmdb_application_product_model]. Wenn dieser Parameter angegeben wird, geben Sie die Parameter appName, appModelName, appServiceName, appServiceIdoder technicalServiceId nicht an. Datentyp: Zeichenfolge |
| appModelName | Name eines vorhandenen Anwendungsmodells, das zum Erstellen der Anwendung verwendet werden soll. Befindet sich in der Tabelle „Anwendungsmodell“ [cmdb_application_product_model]. Wenn dieser Parameter angegeben wird, geben Sie die Parameter appName, appModelId, appServiceName, appServiceIdoder technicalServiceId nicht an. Datentyp: Zeichenfolge |
| appModelOwnerId | Sys_id des Anwendungsmodellbesitzers. Befindet sich in der Benutzertabelle [sys_user]. Datentyp: Zeichenfolge |
| appName | Der Name der Anwendung. Verwenden Sie nicht denselben Namen wie eine vorhandene Anwendung. Wenn dieser Parameter angegeben wird, geben Sie die Parameter appModelName, appModelId, appServiceName, appServiceIdoder technicalServiceId nicht an. Datentyp: Zeichenfolge |
| appServiceId | Sys_id eines vorhandenen Anwendungsservice, der zum Erstellen der Anwendung verwendet werden soll. Befindet sich in der Anwendungsservice-Tabelle [cmdb_ci_service_auto]. Verwenden Sie diesen Parameter nur, wenn typeapplicationist. Wenn dieser Parameter angegeben wird, geben Sie die Parameter appName, appModelName, appModelId, appServiceNameoder technicalServiceId nicht an. Datentyp: Zeichenfolge |
| appServiceName | Name eines vorhandenen Anwendungsservice, der zum Erstellen der Anwendung verwendet werden soll. Befindet sich in der Anwendungsservice-Tabelle [cmdb_ci_service_auto]. Verwenden Sie diesen Parameter nur, wenn typeapplicationist. Wenn dieser Parameter angegeben wird, geben Sie die Parameter appName, appModelName, appModelId, appServiceIdoder technicalServiceId nicht an. Datentyp: Zeichenfolge |
| technischeServiceId | Sys_id einer vorhandenen dynamischen CI-Gruppe, die zum Erstellen der Anwendung verwendet werden soll. Befindet sich in der Tabelle „Dynamische CI-Gruppe“ [cmdb_ci_query_based_service]. Verwenden Sie diesen Parameter nur, wenn type eine Infrastrukturist. Wenn dieser Parameter angegeben wird, geben Sie die Parameter appName, appModelName, appModelId, appServiceNameoder appServiceId nicht an. Datentyp: Zeichenfolge |
| 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 HTTP-Antwortcodesder REST-API.
| Statuscode | Beschreibung |
|---|---|
| 201 | Anwendung erfolgreich erstellt. |
| 403 | Unzulässig. Der Benutzer hat keine Berechtigung für den Zugriff auf die API. |
| 404 | Anwendung nicht erstellt. Die Eigenschaft messageresult im Objekt [] 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 |
| Fehler.Nachricht | Fehlermeldung mit dem Grund für die fehlgeschlagene Anforderung. Datentyp: Zeichenfolge |
| Fehler.Detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnisobjekt, das Informationen zur Anwendung enthält. Datentyp: Objekt |
| result.message | Informationen über das erfolgreiche oder nicht erfolgreiche Ergebnis der Anforderung. Datentyp: Zeichenfolge |
| result.data | Sys_id der Anwendung. Befindet sich in der CDM-Anwendungstabelle [sn_cdm_application]. 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 neue Anwendung erstellt.
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"
}
}