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 über die Rolle sn_devops_config.admin verfügen. Für GET-Vorgänge muss der aufrufende Benutzer über die Rolle sn_devops_config.viewer oder sn_devops_config.admin verfügen.
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
URL mit Versionsnummer: /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. 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. 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 HTTP-Antwortcodes der REST-API.
| 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 |
| Fehler.detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehlernachricht | Fehlermeldung, die den Grund für das Fehlschlagen der Anforderung enthält. 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 | Erfolgsnachricht für die Anforderung. Bei fehlgeschlagenen Anforderungen ist das Array 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 nicht berechtigt ist, auf die API zuzugreifen.
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
URL mit Versionsnummer: /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. 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. 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 HTTP-Antwortcodes der REST-API.
| 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 |
| Fehler.detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehlernachricht | Fehlermeldung, die den Grund für das Fehlschlagen der Anforderung enthält. 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. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_application] |
| result.data.appManagedByGroups | Kommagetrennte Liste der sys_ids der Gruppen, die die Anwendung verwalten. Datentyp: Zeichenfolge Tabelle: Gruppe [sys_user_group] |
| result.data.appManufacturerId | Sys_id des Herstellers. Datentyp: Zeichenfolge Tabelle: Unternehmen [core_company] |
| result.data.appManufacturerName | Name des Herstellers. Datentyp: Zeichenfolge |
| result.data.appModelId | Sys_id des Anwendungsmodells. Datentyp: Zeichenfolge Tabelle: Anwendungsmodell [cmdb_application_product_model] |
| result.data.appModelName | Name des Anwendungsmodells. Datentyp: Zeichenfolge Tabelle: Anwendungsmodell [cmdb_application_product_model] |
| result.data.appModelOwnerId | Sys_id des Besitzers des Anwendungsmodells. Datentyp: Zeichenfolge Tabelle: Benutzer [sys_user] |
| result.data.appModelOwnerName | Name des Besitzers des Anwendungsmodells. Datentyp: Zeichenfolge |
| result.data.appName | Name der Anwendung. Datentyp: Zeichenfolge |
| Ergebnis.Daten.Fehler | 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 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
URL mit Versionsnummer: /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. 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. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_application] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| appDescription | Beschreibung der Anwendung. Datentyp: Zeichenfolge |
| appManagedByGroups | Kommagetrennte Liste der sys_ids der Gruppen, die die Anwendung verwalten. Der anrufende Anwender muss zu diesen Gruppen gehö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 HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Anwendung erfolgreich aktualisiert. |
| 403 | Unzulässig. Der Anwender hat keine Berechtigung zum Zugriff auf die API. |
| 404 | Anwendung nicht aktualisiert. Die Eigenschaft message im Objekt result 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.detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehlernachricht | Fehlermeldung, die den Grund für das Fehlschlagen der Anforderung enthält. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnisobjekt, das Informationen zur Anwendung enthält. Datentyp: Objekt |
| result.data | Sys_id der Anwendung. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_application] |
| result.message | Informationen über das erfolgreiche oder nicht erfolgreiche 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
URL mit Versionsnummer: /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. 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 der sys_ids der Gruppen, die die Anwendung verwalten. Der anrufende Anwender muss zu diesen Gruppen gehö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 wird, geben Sie nicht die Parameter appName, appModelName, appServiceName, appServiceIdoder technicalServiceId an. 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 wird, geben Sie nicht die Parameter appName, appModelId, appServiceName, appServiceIdoder technicalServiceId an. 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 den Namen einer anderen vorhandenen Anwendung. Wenn dieser Parameter angegeben wird, geben Sie nicht die Parameter appModelName, appModelId, appServiceName, appServiceIdoder technicalServiceId an. Datentyp: Zeichenfolge |
| appServiceId | Sys_id eines vorhandenen Anwendungsservice, der zum Erstellen der Anwendung verwendet werden soll. Verwenden Sie diesen Parameter nur, wenn type auf Anwendung festgelegtist. Wenn dieser Parameter angegeben wird, geben Sie nicht die Parameter appName, appModelName, appModelId, appServiceNameoder technicalServiceId an. 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 type auf Anwendung festgelegtist. Wenn dieser Parameter angegeben wird, geben Sie nicht die Parameter appName, appModelName, appModelId, appServiceIdoder technicalServiceId an. Datentyp: Zeichenfolge Tabelle: Serviceinstanz [cmdb_ci_service_auto] |
| technischeServiceId | Sys_id einer vorhandenen dynamischen CI-Gruppe, die zum Erstellen der Anwendung verwendet werden soll. Verwenden Sie diesen Parameter nur, wenn typeInfrastructure (Infrastruktur)ist. Wenn dieser Parameter angegeben wird, geben Sie nicht die Parameter appName, appModelName, appModelId, appServiceNameoder appServiceId an. Datentyp: Zeichenfolge Tabelle: Dynamische CI-Gruppe [cmdb_ci_query_based_service] |
| Typ | 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-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 201 | Anwendung erfolgreich erstellt. |
| 403 | Unzulässig. Der Anwender hat keine Berechtigung zum Zugriff auf die API. |
| 404 | Anwendung nicht erstellt. Die Eigenschaft message im Objekt result 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.detail | Zusätzliche Details dazu, warum die Anforderung fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehlernachricht | Fehlermeldung, die den Grund für das Fehlschlagen der Anforderung enthält. Datentyp: Zeichenfolge |
| Ergebnis | Ergebnisobjekt, das Informationen zur Anwendung enthält. Datentyp: Objekt |
| result.data | Sys_id der Anwendung. Datentyp: Zeichenfolge Tabelle: CDM-Anwendung [sn_cdm_application] |
| result.message | Informationen über das erfolgreiche oder nicht erfolgreiche 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 gezeigt, wie Sie eine neue -Anwendung erstellen.
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"
}
}