Anwendungsservice-API
Die Anwendungsservice- API stellt Endpunkte bereit, mit denen Sie Anwendungsservices erstellen, ändern und aktualisieren können.
Diese API erfordert, dass der Benutzer die Rolle „Anwendungsservice-Administrator“ [app_service_admin] besitzt.
Anwendungsservice: GET /now/cmdb/app_service/{sys_id}/getContent
Ruft eine Liste von Configuration Items (CI) in einem zugeordneten Anwendungsservice und die Beziehungen zwischen ihnen ab. Ruft nur Inhalte für Services ab, die manuell erstellt wurden.
URL-Format
Standard-URL: /api/now/cmdb/app_service/{sys_id}/getContent
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| sys_id | Sys_id des zugeordneten Anwendungsservice. Datentyp: Zeichenfolge Tabelle: Zugeordneter Anwendungsservice [cmdb_ci_service_discovered] |
| Name | Beschreibung |
|---|---|
| Modus | Menge der zurückzugebenden Beziehungsdaten. Gültige Werte: Bei den Werten wird zwischen Groß- und Kleinschreibung unterschieden.
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter HTTP-Antwortcodes der REST-API.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anmeldeinformationen des Anwenders sind falsch oder er verfügt nicht über die Rolle „app_service_admin“. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| cmdb | Liste von Objekten, die die CIs beschreiben, die dem angegebenen Anwendungsservice zugeordnet sind. Datentyp: Objekt |
| cmdb.items | CIs innerhalb des Anwendungsservice. Wenn der vollständige Abfrageparameter in der Anforderung übergeben wurde, enthält dieser Abschnitt Attribute und Suchinformationen für jedes CI. Datentyp: Array |
| cmdb.items.className | Name der Klasse, die das CI enthält. Datentyp: Zeichenfolge |
| cmdb.items.values | Informationen, die zum Auffinden eines zugeordneten CI verwendet werden. Datentyp: Objekt |
| cmdb.items.values.name | Name des CI. Datentyp: Zeichenfolge |
| cmdb.items.values.sys_id | Sys_id des CI. Datentyp: Zeichenfolge |
| CMDB-Beziehungen | Beziehungsdaten für zugeordnete CIs, z. B. Hosts und deren untergeordnete Elemente. Datentyp: Array |
| service | Liste der Services, die sich auf den identifizierten Service beziehen. Datentyp: Array von Objekten |
| service.name | Name des Anwendungsservice. Datentyp: Zeichenfolge |
| service.service_beziehungen | Hierarchiedaten für die CIs innerhalb des Anwendungsservice. Alle CIs bilden Paare mit einem übergeordneten und einem untergeordneten CI. Das oberste CI, als Einstiegspunkt eines Anwendungsservice bezeichnet, verfügt nicht über ein übergeordnetes CI. Datentyp: Array von Objekten |
| service.service_beziehungen.untergeordnetes Element | Name eines dem CI zugehörigen untergeordneten CI. Datentyp: Zeichenfolge |
| service.service_beziehungen.parent | Name des übergeordneten CI, das sich auf das CI bezieht. Datentyp: Zeichenfolge |
| service.url | Relativer Pfad zum Anwendungsservice. Datentyp: Zeichenfolge |
Beispiel für eine cURL-Anforderung
curl "https://instance.servicenow.com/api/now/cmdb/app_service/2fce42d80a0a0bb4004af34d7e3984c8/getContent?mode=shallow" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'{
"service": {
"name": "PeopleSoft Portals",
"url": "/api/now/table/cmdb_ci_service_discovered/2fce42d80a0a0bb4004af34d7e3984c8",
"service_relations": [
{
"parent": "",
"child": "3a2810c20a0a0bb400268337d6e942ca"
},
{
"parent": "3a27f1520a0a0bb400ecd6ff7afcf036",
"child": "3a5dd3dbc0a8ce0100655f1ec66ed42c"
},
{
"parent": "3a290cc60a0a0bb400000bdb386af1cf",
"child": "3a307c930a0a0bb400353965d0b8861f"
},
{
"parent": "3a172e820a0a0bb40034228e9f65f1be",
"child": "3a27d4370a0a0bb4006316812bf45439"
},
{
"parent": "",
"child": "3a172e820a0a0bb40034228e9f65f1be"
},
{
"parent": "",
"child": "3a27f1520a0a0bb400ecd6ff7afcf036"
},
{
"parent": "3a2810c20a0a0bb400268337d6e942ca",
"child": "3a290cc60a0a0bb400000bdb386af1cf"
}
]
},
"cmdb": {
"relations": [],
"items": [
{
"values": {
"sys_id": "3a172e820a0a0bb40034228e9f65f1be",
"name": "PS LoadBal01"
},
"className": "cmdb_ci_win_server"
},
{
"values": {
"sys_id": "3a2810c20a0a0bb400268337d6e942ca",
"name": "PS Apache03"
},
"className": "cmdb_ci_web_server"
},
{
"values": {
"sys_id": "55b35562c0a8010e01cff22378e0aea9",
"name": "ny8500-nbxs08"
},
"className": "cmdb_ci_netgear"
},
{
"values": {
"sys_id": "3a27f1520a0a0bb400ecd6ff7afcf036",
"name": "PS Apache02"
},
"className": "cmdb_ci_web_server"
},
{
"values": {
"sys_id": "3a307c930a0a0bb400353965d0b8861f",
"name": "PS ORA01"
},
"className": "cmdb_ci_database"
}
]
}
}Anwendungsservice: GET /now/cmdb/csdm/app_service/find_service
Gibt grundlegende Informationen zu einem angegebenen Anwendungsservice und dem zugehörigen Geschäftskontext zurück.
URL-Format
Standard-URL: /api/now/cmdb/csdm/app_service/find_service
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| name | Erforderlich, wenn number nicht übergeben wird. Name des Services, für den Informationen zurückgegeben werden sollen. Datentyp: Zeichenfolge Tabelle: Serviceinstanz [cmdb_ci_service_auto] |
| Nummer | Erforderlich, wenn name nicht übergeben wird. Eindeutige Nummer, die den Anwendungsservice identifiziert, für den Informationen zurückgegeben werden sollen. Datentyp: Zeichenfolge Tabelle: Serviceinstanz [cmdb_ci_service_auto] |
| 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 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anmeldeinformationen des Anwenders sind falsch oder er verfügt nicht über die Rolle „app_service_admin“. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Fehler | Beschreibt einen aufgetretenen Fehler. Datentyp: Objekt |
| Fehler.Details | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehlernachricht | Meldung, in der der Fehler beschrieben wird. Datentyp: Zeichenfolge |
| -Services | Array von Objekten, wobei jedes Objekt Details zu Services enthält, die dem angegebenen Anwendungsservice zugeordnet sind. Datentyp: Array |
| Services.Environment | Umgebung, in der der Anwendungsservice bereitgestellt wird, z. B. „Produktion“ oder „Testlabor 2“. Dies kann ein beliebiger Wert sein, der für den Implementierer sinnvoll ist. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: null |
| services.name | Erforderlich. Name des Anwendungsservice. Muss ein eindeutiger Name aus allen anderen Anwendungsservices sein. Datentyp: Zeichenfolge Maximale Länge: 255 |
| service.number | Eindeutige Nummer, die den Anwendungsservice identifiziert. Dieser Wert wird anfänglich vom Endpunkt generiert. Datentyp: Zeichenfolge |
| Services.Beziehungen | Servicetypen, die dem Anwendungsservice zugeordnet sind. Datentyp: Objekt |
| „services.relationships.business_app“ | Liste der sys_ids der Geschäftsanwendungen, die sich auf den Anwendungsservice beziehen. Datentyp: Array |
| services.relationships.technical_service_offering | Liste der sys_ids der Technologiemanagementangebote (früher technische Serviceangebote) im Zusammenhang mit dem Anwendungsservice. Datentyp: Array |
| „services.relationships.business_service_offering“ | Liste der sys_ids der Business-Service-Angebote im Zusammenhang mit dem Anwendungsservice. Datentyp: Array |
| service.sys_id | Sys_id des Anwendungsservice. Datentyp: Zeichenfolge |
| services.version | Versionsnummer des Anwendungsservice. Datentyp: Zeichenfolge Maximale Länge: 40 Format: anwenderdefinierbar Standard: null |
Beispiel für eine cURL-Anforderung
curl -X GET \
https://instance.servicenow.com/api/now/cmdb/csdm/app_service/find_service?name=Email_East&number=SNSVC0001018 \
-H 'Accept: application/json' \
-u 'username':'password'
{
"result": {
"services": [
{
"name": "Email_East",
"number": "SNSVC0001018",
"sys_id": "f809cb60db94101037740f95ca96190f",
"environment": "Production",
"version": "1.1.1",
"relationships": {
"business_app": [
"658c7620db54101037740f95ca9619f2"
],
"technical_service_offering": [],
"business_service_offering": [
"069c7e20db54101037740f95ca9619bf"
]
}
}
]
}
}Anwendungsservice – POST /now/cmdb/app_service/create
Erstellt einen Anwendungsservice oder aktualisiert einen vorhandenen Anwendungsservice.
URL-Format
Standard-URL: /api/now/cmdb/app_service/create
Unterstützte Anforderungsparameter
| Parameter | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Content-Type | Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
Statuscodes
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST API-Header.
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
Anforderungstext
Die API akzeptiert diese JSON-Elemente im Anforderungstext. Darüber hinaus können Sie ein beliebiges Feld aus der Tabelle „Zugeordneter Anwendungsservice“ [cmdb_ci_service_discovered] hinzufügen, um Daten an den Anwendungsservice-Datensatz zu übergeben. Um beispielsweise dem Feld „Kommentare“ Inhalt hinzuzufügen, fügen Sie "comments": "Passing data to the Comments field" zur JSON-Anforderung hinzu.
| Elemente | Beschreibung |
|---|---|
| Name | Name des Anwendungsservice, den Sie erstellen oder aktualisieren möchten. |
| service_relations | Informationen über CIs und die Hierarchie, die sie bilden. Alle CIs bilden Paare aus einem übergeordneten CI und einem untergeordneten CI. Das oberste CI, als Einstiegspunkt eines Anwendungsservice bezeichnet, verfügt nicht über ein übergeordnetes CI. |
| übergeordnet | Sys_id des CI, dessen ausgehende Verbindung dieses CI mit dem CI auf der niedrigeren Ebene in der Kartenhierarchie verbindet. |
| child | Sys_id des CI, dessen eingehende Verbindung dieses CI mit dem CI auf einer höheren Ebene in der Kartenhierarchie verbindet. |
Antworttext
Die API gibt diese JSON-Elemente im Antworttext zurück.
| Elemente | Beschreibung |
|---|---|
| URL | URL der REST-API der Standardtabelle zum Anzeigen der sys_id eines Anwendungsservice-Datensatzes. Dieses Element wird nur angezeigt, wenn der Endpunkt erfolgreich ist. Datentyp: Zeichenfolge |
| getContentUrl | REST-API-Pfad zum Abrufen des Anwendungsservice-Inhalts. Dieses Element wird nur angezeigt, wenn der Endpunkt erfolgreich ist. Datentyp: Zeichenfolge |
| Info | Anzahl der CIs, die dem Anwendungsservice hinzugefügt wurden. Dieses Element wird nur angezeigt, wenn der Endpunkt erfolgreich ist. Datentyp: Zeichenfolge |
| Fehler | Fehlermeldungsdetails. Dieses Element wird nur angezeigt, wenn der Endpunkt fehlschlägt. Datentyp: Objekt |
| Nachricht | Fehlermeldung, die die Art des Fehlers beschreibt. Dieses Element wird nur angezeigt, wenn der Endpunkt fehlschlägt. Datentyp: Zeichenfolge |
| status | Gibt „Fehler“ an, wenn die REST-API fehlschlägt. Dieses Element wird nur angezeigt, wenn der Endpunkt fehlschlägt. Datentyp: Zeichenfolge |
Beispiel für eine cURL-Anforderung
curl "http://<instance.servicenow.com>/api/now/cmdb/app_service/create" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"name\": \"myTestAppService\",
\"comments\": \"Passing data to the Comments field\",
\"service_relations\": [
{ \"parent\": \"\",
\"child\": \"3a70f789c0a8ce010091b0ea635b982a\"
},{ \"parent\": \"3a70f789c0a8ce010091b0ea635b982a\",
\"child\": \"b4fd7c8437201000deeabfc8bcbe5dc1\"
},{ \"parent\": \"b4fd7c8437201000deeabfc8bcbe5dc1\",
\"child\": \"53fdbc8437201000deeabfc8bcbe5d10\"
}
]
}" \
--user 'admin':'admin'{
"result": {
"url": "/api/now/table/cmdb_ci_service_discovered/b1cff89fc9e19300964fcbb1ac3059a5",
"getContentUrl": "/api/now/cmdb/app_service/b1cff89fc9e19300964fcbb1ac3059a5/getContent",
"info": "3 CIs added to service"
}
}Anwendungsservice – POST /now/cmdb/csdm/app_service/register_service
Erstellt einen Anwendungsservice-Datensatz-Stub in der Tabelle „Serviceinstanz“ [cmdb_ci_service_auto] und füllt sie mit den übergebenen Informationen.
URL-Format
Standard-URL: /api/now/cmdb/csdm/app_service/register_service
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| grundlegende_details | Erforderlich. Details des Services, der dem angegebenen Anwendungsservice zugeordnet ist. Datentyp: Objekt |
| grundlegende_details.umgebung | Umgebung, in der der Anwendungsservice bereitgestellt wird, z. B. „Produktion“ oder „Testlabor 2“. Dies kann ein beliebiger Wert sein, der für den Implementierer sinnvoll ist. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: null |
| grundlegende_details.name | Erforderlich. Name des Anwendungsservice. Muss ein eindeutiger Name aus allen anderen Anwendungsservices sein. Datentyp: Zeichenfolge Maximale Länge: 255 |
| grundlegende_details.version | Versionsnummer des Anwendungsservice. Datentyp: Zeichenfolge Maximale Länge: 40 Format: anwenderdefinierbar Standard: null |
| Beziehungen | Vorgelagerte (übergeordnete) Servicetypen, die dem Anwendungsservice zugeordnet werden sollen. Datentyp: Objekt Tabelle: CI-Beziehungen [cmdb_rel_ci] |
| beziehungen.business_app | Liste der sys_ids der Geschäftsanwendungen, die sich auf den Anwendungsservice beziehen sollen. Datentyp: Array |
| beziehungen.business_service_offering | Liste der sys_ids der Business-Service-Angebote, die sich auf den Anwendungsservice beziehen sollen. Datentyp: Array |
| beziehungen.technical_service_offering | Liste der sys_ids der technischen Serviceangebote, die sich auf den Anwendungsservice beziehen sollen. Datentyp: Array |
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 | Erfolgreich. Der Anwendungsservice wurde erfolgreich registriert. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert Die Anmeldeinformationen des Anwenders sind falsch oder er verfügt nicht über die Rolle „app_service_admin“. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Fehler | Beschreibt einen aufgetretenen Fehler. Datentyp: Objekt |
| Fehler.Details | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehlernachricht | Meldung, in der der Fehler beschrieben wird. Datentyp: Zeichenfolge |
| Nummer | Eindeutige Nummer, die den Anwendungsservice identifiziert. Diese Zahl wird vom Endpunkt generiert. Datentyp: Zeichenfolge |
| service_sys_id | Sys_id des registrierten Anwendungsservice. Datentyp: Zeichenfolge |
Beispiel für eine cURL-Anforderung
curl -X POST \
https://instance.servicenow.com/api/now/cmdb/csdm/app_service/register_service \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password'
-d '{
"basic_details": {
"environment": "Test Lab 2",
"name": "Test Lab 2",
"version": "1.1.1"
},
"relationships": {
"business_app":["f07c7620db54101037740f95ca96199a"],
"business_service_offering":["069c7e20db54101037740f95ca9619bf"]
}
}'{
"result": {
"service_sys_id": "80f21bbadbd410103d3a93c3e296199a",
"number": "SNSVC0001018"
}
}Anwendungsservice: PUT /now/cmdb/csdm/app_service/{service_sys_id}/populate_service
Füllt den angegebenen Anwendungsservice mit einem angegebenen Satz nachgelagerter Konfigurationselemente (Configuration Items, CI) auf.
URL-Format
Standard-URL: /api/now/cmdb/csdm/app_service/{service_sys_id}/populate_service
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| service_sys_id | Sys_id des Anwendungsservice, der mit den angegebenen CIs gefüllt werden soll. Datentyp: Zeichenfolge Tabelle: Serviceinstanz [cmdb_ci_service_auto] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| „population_method“ | Dem angegebenen Anwendungsservice zuzuordnende CIs. Die Elemente im Objekt population_method hängen von der Art der ausgefüllten Informationen ab, die durch den Parameter type definiert werden. Datentyp: Objekt Für type = cmdb_group_based Für type = Discovery Hinweis: Um diesen Typ zu verwenden, müssen Sie das Plugin „Service Mapping“ (com.snc.service-mapping) aktivieren. Für type = tag_list Hinweis: Um diesen Typ zu verwenden, müssen Sie das Plugin „Service Mapping“ (com.snc.service-mapping) aktivieren. |
| „population_method.attributes“ | Liste der Attribute, die dem CI zugeordnet werden sollen, z. B. Host, Port, Name und URL. Hinweis: Sie müssen alle erforderlichen Attribute übergeben. Datentyp: Array |
| population_method.attributes.name | Name des Attributs, z. B. Host, Port, Name und URL. Datentyp: Zeichenfolge |
| „population_method.attributes.value“ | Attributwert. Datentyp: Zeichenfolge |
| „population_method.entry_point“ | Erforderlich, wenn population_method.type = Discovery. Einstiegspunkt in den Anwendungsservice. Weitere Informationen zu Einstiegspunkten finden Sie unter Einstiegspunktattribute und Einstiegspunkttypen für Service-Mapping erstellen. Datentyp: Zeichenfolge |
| „population_method.group_id“ | Erforderlich, wenn population_method.type = cmdb_group_based. Sys_id der Gruppe, die dem CI zugeordnet werden soll. Datentyp: Zeichenfolge Titel: CMDB-Gruppe [cmdb_group] |
| „population_method.tags“ | Liste der Tags, die dem CI zugeordnet werden sollen. Datentyp: Array von Objekten Titel: Schlüsselwerte [cmdb_key_value] |
| „population_method.tags.tag“ | Name des Tags. Datentyp: Zeichenfolge |
| „population_method.tags.value“ | Tag-Wert. Datentyp: Zeichenfolge |
| „population_method.type“ | Erforderlich. Auszufüllender CI-Typ. 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 |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anmeldeinformationen des Anwenders sind falsch oder er verfügt nicht über die Rolle „app_service_admin“. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Fehler | Beschreibt einen aufgetretenen Fehler. Datentyp: Objekt |
| Fehler.Details | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehlernachricht | Meldung, in der der Fehler beschrieben wird. Datentyp: Zeichenfolge |
Beispiel für eine cURL-Anforderung
Das folgende Codebeispiel zeigt, wie ein Anwendungsservice gefüllt wird, wenn der CI-Typ cmdb_group_based lautet.
curl -X PUT \
https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"population_method": {
"type":"cmdb_group_based",
"group_id": "e809cf60db94101037640f95ca961932"
}
}'{
"result": {}
}Das folgende Codebeispiel zeigt, wie ein Discovery-Anwendungsservice gefüllt wird.
curl -X PUT \
https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/populate_service \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"population_method": {
"type":"discovery",
"entry_point_id":"cmdb_ci_endpoint_ad_forest",
"attributes": [
{
"name":"host",
"value":"test1.com"
},
{
"name":"port",
"value":"500"
},
{
"name":"protocol",
"value":"ssh"
}
]
}
}'{
"result": {}
}Anwendungsservice: PUT /now/cmdb/csdm/app_service/{service_sys_id}/service_details
Aktualisiert den angegebenen Anwendungsservice mit den übergebenen Basisinformationen.
URL-Format
Standard-URL: /api/now/cmdb/csdm/app_service/{service_sys_id}/service_details
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| service_sys_id | Sys_id des zu aktualisierenden Anwendungsservice. Datentyp: Zeichenfolge Tabelle: Serviceinstanz [cmdb_ci_service_auto] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| grundlegende_details | Details des Services, der dem angegebenen Anwendungsservice zugeordnet ist. Datentyp: Objekt |
| grundlegende_details.umgebung | Umgebung, in der der Anwendungsservice bereitgestellt wird, z. B. „Produktion“ oder „Testlabor 2“. Dies kann ein beliebiger Wert sein, der für den Implementierer sinnvoll ist. Datentyp: Zeichenfolge Maximale Länge: 40 Standard: null |
| grundlegende_details.name | Erforderlich. Name des Anwendungsservice. Muss ein eindeutiger Name aus allen anderen Anwendungsservices sein. Datentyp: Zeichenfolge Maximale Länge: 255 |
| Beziehungen | Servicetypen, die dem Anwendungsservice zugeordnet werden sollen. In der Tabelle „CI-Beziehungen“ [cmdb_rel_ci]. Datentyp: Objekt |
| beziehungen.business_app | Liste der sys_ids der Geschäftsanwendungen, die sich auf den Anwendungsservice beziehen sollen. Datentyp: Array |
| beziehungen.business_service_offering | Liste der sys_ids der Business-Service-Angebote, die sich auf den Anwendungsservice beziehen sollen. Datentyp: Array |
| beziehungen.technical_service_offering | Liste der sys_ids der technischen Serviceangebote, die sich auf den Anwendungsservice beziehen sollen. Datentyp: Array |
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 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anmeldeinformationen des Anwenders sind falsch oder er verfügt nicht über die Rolle „app_service_admin“. |
Parameter des Antworttexts (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Fehler | Beschreibt einen aufgetretenen Fehler. Datentyp: Objekt |
| Fehler.Details | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehlernachricht | Meldung, in der der Fehler beschrieben wird. Datentyp: Zeichenfolge |
Beispiel für eine cURL-Anforderung
curl -X PUT \
https://instance.servicenow.com/api/now/cmdb/csdm/app_service/f809cb60db94101037740f95ca96190f/service_details \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-u 'username':'password' \
-d '{
"basic_details": {
"environment": "Test Lab 2"
}, "relationships": {
"business_app" :["f07c7620db54101037740f95ca96199a"]
}
}'{
"result": {}
}