CMDB-Instanz-API
Die CMDB-Instanz- API bietet Endpunkte zum Erstellen, Lesen, Aktualisieren und Löschen von Vorgängen für vorhandene Configuration Management Database (CMDB) -Tabellen. Sie können jeweils nur einen Datensatz einfügen, aktualisieren oder löschen.
Diese API erfordert, dass der Benutzer über die ITIL-Rolle verfügt.
CMDB Instanz – DELETE /now/cmdb/instance/{classname}/{sys_id}/relation/{rel_sys_id}
Löscht die Beziehung für das angegebene Konfigurationselement (CI).
URL-Format
Versionierte URL: /api/now/v1/cmdb/instance/{className}/{sys_id}/relation/{rel_sys_id}
Standard-URL: /api/now/cmdb/instance/{className}/{sys_id}/relation/{rel_sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| className | CMDB Klassenname. Dies ist der Name der Tabelle, die die gewünschten CI-Datensätze enthält, z. B. cmdb_ci_linux_server oder cmdb_ci_apache_web_server. Datentyp: Zeichenfolge |
| rel_sys_id | Sys_id der zu entfernenden Beziehung. Datentyp: Zeichenfolge |
| sys_id | Sys_id des CI. 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 |
|---|---|
| Keine |
| 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 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 405 | Ungültige Methode. Die Funktion ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Keine |
Beispiel für eine cURL-Anforderung
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/0f4ac6c4b750230096c3e4f6ee11a9fe/relation/b0dbda5347c12200e0ef563dbb9a718f" \
--request DELETE \
--user 'username':'password'
CMDB Instance – GET /now/cmdb/instance/{classname}
Gibt die verfügbaren Konfigurationselemente (CI) für eine angegebene Configuration Management Database (CMDB) Klasse (Tabelle) zurück.
URL-Format
Versionierte URL: /api/now/v1/cmdb/instance/{className}
Standard-URL: /api/now/cmdb/instance/{className}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| className | CMDB Klassenname. Dies ist der Name der Tabelle, die die gewünschten CI-Datensätze enthält, z. B. cmdb_ci_linux_server oder cmdb_ci_apache_web_server. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| sysparm_limit | Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren. Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden. Hinweis: Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen. Datentyp: Zahl Standard: 10.000 |
| sysparm_offset | Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie Datentyp: Zahl Standard: 0 |
| sysparm_query | Codierte Abfrage, die zum Filtern der Ergebnismenge verwendet wird. Sie können einen UI-Filter verwenden, um eine ordnungsgemäß codierte Abfrage zu erhalten. Syntax: sysparm_query=<col_name><operator><value>.
Bei allen Parametern wird zwischen Groß- und Kleinschreibung unterschieden. Abfragen können mehr als einen Eintrag enthalten, beispielsweise sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]. Beispiel:
Codierte Abfragen unterstützen auch die Funktion „Sortieren nach“. Verwenden Sie die Klauseln Syntax:
Beispiel: Diese Abfrage filtert alle aktiven Datensätze und sortiert die Ergebnisse in aufsteigender Reihenfolge nach Nummer und dann in absteigender Reihenfolge nach Kategorie. Wenn ein Teil der Abfrage ungültig ist, z. B. durch Angabe eines ungültigen Feldnamens, ignoriert die Instanz den ungültigen Teil. Es werden dann nur Zeilen unter Verwendung des gültigen Teils der Abfrage zurückgegeben. Sie können dieses Verhalten mithilfe der Eigenschaft glide.invalid_query.returns_no_rows steuern. Legen Sie diese Eigenschaft auf „true“ fest, um bei einer ungültigen Abfrage keine Zeilen zurückzugeben. Hinweis: Diese Eigenschaft glide.invalid_query.returns_no_rows steuert das Verhalten aller Abfragen in der Instanz, beispielsweise in Listen, Skripts (GlideRecord.query()) und Webservice-APIs. 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-Antwortcodesder 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 sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 405 | Ungültige Methode. Die Funktion ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| Name | Name eines CI innerhalb der angegebenen Klasse. Datentyp: Zeichenfolge |
| sys_id | Sys_id des CI. Datentyp: Zeichenfolge |
Beispiel für eine cURL-Anforderung
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
"result": [
{
"sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
"name": "PS LinuxApp01"
},
{
"sys_id": "3a5dd3dbc0a8ce0100655f1ec66ed42c",
"name": "PS LinuxApp02"
}
]
CMDB Instance – GET /now/cmdb/instance/{classname}/{sys_id}
Gibt Attribute und Beziehungsinformationen für einen angegebenen Configuration Item (CI)-Datensatz zurück.
URL-Format
Versionierte URL: /api/now/{api_version}/cmdb/instance/{className}/{sys_id}
Standard-URL: /api/now/cmdb/instance/{className}/{sys_id}
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 |
| className | CMDB Klassenname. Dies ist der Name der Tabelle, die die gewünschten CI-Datensätze enthält, z. B. cmdb_ci_linux_server oder cmdb_ci_apache_web_server. Datentyp: Zeichenfolge |
| sys_id | Sys_id des abzurufenden CI-Datensatzes. 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ü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-Antwortcodesder 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 sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 405 | Ungültige Methode. Die Funktion ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| attributes | Datenattribute, die sich derzeit im CI-Datensatz befinden. Die verfügbaren Attribute hängen von der angegebenen Klasse CMDB ab. Sie finden die verfügbaren Attribute in der zugeordneten Tabelle CMDB, die normalerweise mit „cmdb_ci“ beginnt, z. B. cmdb_ci_linux_server oder cmdb_ci_mfp_printer. Datentyp: Objekt |
| Fehler | Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| inbound_relations | Liste der Objekte, die die eingehenden Beziehungen definieren, die dem CI zugeordnet sind. Datentyp: Array |
| inbound_relations.sys_id | Sys_id der eingehenden CI-Beziehung. Befindet sich in der Tabelle „CI-Beziehung“ [cmdb_rel_ci]. Datentyp: Zeichenfolge |
| inbound_relations.target | Informationen, die die eingehende Zielbeziehung beschreiben. Datentyp: Objekt |
| inbound_relations.target.display_value | Name der eingehenden Beziehung, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| inbound_relations.target.link | CMDB REST-Endpunkt-URL, die zum Abrufen der eingehenden Beziehung aus der Tabelle „Konfigurationselement“ [cmdb_ci] verwendet werden soll. Datentyp: Zeichenfolge |
| inbound_relations.target.value | Sys_id des eingehenden CI. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| inbound_relations.type | Informationen zum Typ der eingehenden Beziehung. Datentyp: Objekt |
| inbound_relations.type.display_value | Name des eingehenden Typs, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| inbound_relations.type.link | REST-Endpunkt-URL derTabelle, die zum Abrufen des eingehenden Beziehungstyps aus der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] verwendet werden soll. Datentyp: Zeichenfolge |
| inbound_relations.type.value | Sys_id des Typs der eingehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| outbound_relations | Liste der Objekte, die die ausgehenden Beziehungen definieren, die dem CI zugeordnet sind. Datentyp: Array |
| outbound_relations.sys_id | Sys_id der ausgehenden CI-Beziehung. Befindet sich in der Tabelle „CI-Beziehung“ [cmdb_rel_ci]. Datentyp: Zeichenfolge |
| outbound_relations.target | Erforderlich. Informationen zur ausgehenden Zielbeziehung. Datentyp: Objekt |
| outbound_relations.target.display_value | Name der ausgehenden Beziehung, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| outbound_relations.target.link | CMDB REST-Endpunkt-URL, die zum Abrufen der ausgehenden Beziehung aus der Tabelle „Konfigurationselement“ [cmdb_ci] verwendet werden soll. Datentyp: Zeichenfolge |
| outbound_relations.target.value | Sys_id des ausgehenden CI. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| outbound_relations.type | Informationen zum Typ der ausgehenden Beziehung. Datentyp: Objekt |
| outbound_relations.type.display_value | Name des ausgehenden Typs, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| outbound_relations.type.link | REST-Endpunkt-URL derTabelle, die zum Abrufen der ausgehenden Beziehung aus der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] verwendet werden soll. Datentyp: Zeichenfolge |
| outbound_relations.type.value | Sys_id des Typs der ausgehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| status | Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
Beispiel für eine cURL-Anforderung
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"
{
"result": {
"outbound_relations": [
{
"sys_id": "3a62e64ac0a8ce0100aead1e3fd5439f",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
},
{
"sys_id": "3a67513fc0a8ce0100914a76cea11b02",
"type": {
"display_value": "Exchanges data with::Exchanges data with",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
"value": "607ad1b2c0a8010e01941856b365af90"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
}
],
"attributes": {
"firewall_status": "Intranet",
"os_address_width": "",
"attested_date": "",
"operational_status": "1",
"os_service_pack": "",
"cpu_core_thread": "",
"cpu_manufacturer": "",
"sys_updated_on": "2020-07-08 11:16:51",
"discovery_source": "",
"first_discovered": "",
"due_in": "",
"used_for": "Production",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "glide.maint",
"warranty_expiration": "",
"ram": "2048",
"cpu_name": "",
"cpu_speed": "2800",
"owned_by": "",
"checked_out": "",
"kernel_release": "",
"sys_domain_path": "/",
"classification": "Production",
"disk_space": "40",
"object_id": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "2020-01-04 07:00:00",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"cd_speed": "",
"floppy": "",
"managed_by": {
"display_value": "Lynda Caraway",
"link": "https://instance.service-now.com/api/now/table/sys_user/8a826bf03710200044e0bfc8bcbe5d72",
"value": "8a826bf03710200044e0bfc8bcbe5d72"
},
"os_domain": "",
"last_discovered": "",
"can_print": "false",
"sys_class_name": "cmdb_ci_linux_server",
"manufacturer": {
"display_value": "Iris",
"link": "https://instance.servicenow.com/api/now/table/core_company/c115c2f737e3100044e0bfc8bcbe5d46",
"value": "c115c2f737e3100044e0bfc8bcbe5d46"
},
"cpu_count": "1",
"vendor": {
"display_value": "Cloudward Inc",
"link": "https://instance.servicenow.com/api/now/table/core_company/3efe8c4c37423000158bbfc8bcbe5d7d",
"value": "3efe8c4c37423000158bbfc8bcbe5d7d"
},
"life_cycle_stage_status": "",
"model_number": "",
"assigned_to": "",
"start_date": "",
"os_version": "2.6.9-22.0.1.ELsmp",
"serial_number": "",
"cd_rom": "false",
"support_group": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": {
"display_value": "P1000091 - Iris 5875",
"link": "https://instance.servicenow.com/api/now/table/alm_asset/0bc1ba8837f3100044e0bfc8bcbe5dbb",
"value": "0bc1ba8837f3100044e0bfc8bcbe5dbb"
},
"form_factor": "",
"cpu_core_count": "",
"skip_sync": "false",
"attestation_score": "",
"sys_updated_by": "system",
"sys_created_on": "2008-10-26 17:17:28",
"sys_domain": {
"display_value": "global",
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"cpu_type": "Intel",
"install_date": "2019-08-18 08:00:00",
"asset_tag": "P1000091",
"dr_backup": "",
"hardware_substatus": "",
"fqdn": "",
"change_control": "",
"internet_facing": "false",
"delivery_date": "",
"hardware_status": "",
"install_status": "1",
"supported_by": "",
"name": "PS LinuxApp01",
"subcategory": "",
"default_gateway": "",
"chassis_type": "",
"virtual": "false",
"assignment_group": "",
"managed_by_group": "",
"sys_id": "3a290cc60a0a0bb400000bdb386af1cf",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!2/!(/!!/!0",
"mac_address": "",
"company": {
"display_value": "ACME Corporation",
"link": "https://instance.servicenow.com/api/now/table/core_company/e7c1f3d53790200044e0bfc8bcbe5deb",
"value": "e7c1f3d53790200044e0bfc8bcbe5deb"
},
"justification": "",
"department": "",
"cost": "45557.5",
"comments": "",
"os": "Linux Red Hat",
"sys_mod_count": "24",
"monitor": "false",
"model_id": {
"display_value": "Iris 5875",
"link": "https://instance.servicenow.com/api/now/table/cmdb_model/5f5fbcc3c0a8010e00f3b27814f3b96b",
"value": "5f5fbcc3c0a8010e00f3b27814f3b96b"
},
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": {
"display_value": "322 West 52nd Street, New York,NY",
"link": "https://instance.servicenow.com/api/now/table/cmn_location/25ab9f690a0a0bb3001c5fec1d0d7bcb",
"value": "25ab9f690a0a0bb3001c5fec1d0d7bcb"
},
"category": "Do not migrate to asset",
"fault_count": "0",
"host_name": "",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "3a5e4d8ac0a8ce010005145afb730818",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
"value": "3a27d4370a0a0bb4006316812bf45439"
}
},
{
"sys_id": "3a5e4d9cc0a8ce010097f2f5c2f65fd8",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache02",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27f1520a0a0bb400ecd6ff7afcf036",
"value": "3a27f1520a0a0bb400ecd6ff7afcf036"
}
},
{
"sys_id": "3a5e4d9fc0a8ce0100a3754fac26fe56",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache03",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a2810c20a0a0bb400268337d6e942ca",
"value": "3a2810c20a0a0bb400268337d6e942ca"
}
}
]
}
}
CMDB Instance – POST /now/cmdb/instance/{classname}
Erstellt ein einzelnes Konfigurationselement (CI) mit den angegebenen ausgehenden und eingehenden Beziehungen innerhalb der angegebenen Tabelle Configuration Management Database (CMDB).
"depends_on": {
"outbound_relations":
{
"target": "b4fd7c8437201000deeabfc8bcbe5dc1",
"type": "60bc4e22c0a8010e01f074cbe6bd73c3"
}
}URL-Format
Versionierte URL: /api/now/v1/cmdb/instance/{className}
Standard-URL: /api/now/cmdb/instance/{className}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| className | CMDB Klassenname. Dies ist der Name der Tabelle, die die gewünschten CI-Datensätze enthält, z. B. cmdb_ci_linux_server oder cmdb_ci_apache_web_server. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| attributes | Datenattribute, die im CI-Datensatz definiert werden sollen. Die verfügbaren Attribute hängen von der angegebenen Klasse CMDB ab. Sie finden die verfügbaren Attribute in der zugeordneten Tabelle CMDB, die normalerweise mit „cmdb_ci“ beginnt, z. B. cmdb_ci_linux_server oder cmdb_ci_mfp_printer. Datentyp: Objekt |
| inbound_relations | Liste der Objekte, die die eingehenden Beziehungen definieren, die dem CI zugeordnet werden sollen. Datentyp: Array |
| inbound_relations.target | Erforderlich, wenn inbound_relations angegeben ist. Sys_id der eingehenden Zielbeziehung, die dem angegebenen CI zugeordnet werden soll. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| inbound_relations.type | Erforderlich, wenn inbound_relations angegeben ist. Sys_id des Typs der eingehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge Datentyp: Zeichenfolge |
| outbound_relations | Liste der Objekte, die die ausgehenden Beziehungen definieren, die dem CI zugeordnet werden sollen. Datentyp: Array |
| outbound_relations.target | Erforderlich, wenn outbound_relations angegeben ist. Sys_id der ausgehenden Zielbeziehung. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| outbound_relations.type | Erforderlich, wenn outbound_relations angegeben ist. Sys_id des Typs der ausgehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| Quelle | Erforderlich. Entität, die die Informationen aktualisiert hat. Dies muss einer der Auswahlwerte sein, die im Feld discovery_source in der Tabelle „Konfigurationselement“ [cmdb_ci] angegeben sind. 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ü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 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 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 405 | Ungültige Methode. Die Funktion ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| attributes | Datenattribute, die sich derzeit im CI-Datensatz befinden. Die verfügbaren Attribute hängen von der angegebenen Klasse CMDB ab. Sie finden die verfügbaren Attribute in der zugeordneten Tabelle CMDB, die normalerweise mit „cmdb_ci“ beginnt, z. B. cmdb_ci_linux_server oder cmdb_ci_mfp_printer. Datentyp: Objekt |
| Fehler | Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| inbound_relations | Liste der Objekte, die die eingehenden Beziehungen definieren, die dem CI zugeordnet sind. Datentyp: Array |
| inbound_relations.sys_id | Sys_id der eingehenden CI-Beziehung. Befindet sich in der Tabelle „CI-Beziehung“ [cmdb_rel_ci]. Datentyp: Zeichenfolge |
| inbound_relations.target | Informationen, die die eingehende Zielbeziehung beschreiben. Datentyp: Objekt |
| inbound_relations.target.display_value | Name der eingehenden Beziehung, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| inbound_relations.target.link | CMDB REST-Endpunkt-URL, die zum Abrufen der eingehenden Beziehung aus der Tabelle „Konfigurationselement“ [cmdb_ci] verwendet werden soll. Datentyp: Zeichenfolge |
| inbound_relations.target.value | Sys_id des eingehenden CI. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| inbound_relations.type | Informationen zum Typ der eingehenden Beziehung. Datentyp: Objekt |
| inbound_relations.type.display_value | Name des eingehenden Typs, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| inbound_relations.type.link | REST-Endpunkt-URL derTabelle, die zum Abrufen des eingehenden Beziehungstyps aus der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] verwendet werden soll. Datentyp: Zeichenfolge |
| inbound_relations.type.value | Sys_id des Typs der eingehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| outbound_relations | Liste der Objekte, die die ausgehenden Beziehungen definieren, die dem CI zugeordnet sind. Datentyp: Array |
| outbound_relations.sys_id | Sys_id der ausgehenden CI-Beziehung. Befindet sich in der Tabelle „CI-Beziehung“ [cmdb_rel_ci]. Datentyp: Zeichenfolge |
| outbound_relations.target | Erforderlich. Informationen zur ausgehenden Zielbeziehung. Datentyp: Objekt |
| outbound_relations.target.display_value | Name der ausgehenden Beziehung, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| outbound_relations.target.link | CMDB REST-Endpunkt-URL, die zum Abrufen der ausgehenden Beziehung aus der Tabelle „Konfigurationselement“ [cmdb_ci] verwendet werden soll. Datentyp: Zeichenfolge |
| outbound_relations.target.value | Sys_id des ausgehenden CI. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| outbound_relations.type | Informationen zum Typ der ausgehenden Beziehung. Datentyp: Objekt |
| outbound_relations.type.display_value | Name des ausgehenden Typs, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| outbound_relations.type.link | REST-Endpunkt-URL derTabelle, die zum Abrufen der ausgehenden Beziehung aus der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] verwendet werden soll. Datentyp: Zeichenfolge |
| outbound_relations.type.value | Sys_id des Typs der ausgehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| status | Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
"outbound_relations": [
{
"type" : "1a9cb166f1571100a92eb60da2bce5c5",
"target" : "3a307c930a0a0bb400353965d0b8861f"
},
{
"type" : "607ad1b2c0a8010e01941856b365af90",
"target" : "3a307c930a0a0bb400353965d0b8861f"
}
],
"attributes": {
"name" : "lnux999",
"firewall_status": "Intranet"
},
"source": "ServiceNow",
"inbound_relations": [
{
"type" : "1a9cb166f1571100a92eb60da2bce5c5",
"target" : "3a27d4370a0a0bb4006316812bf45439"
}
]
}
{
"result": {
"outbound_relations": [
{
"sys_id": "403ff2641b425010593876a61a4bcb4b",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
},
{
"sys_id": "443ff2641b425010593876a61a4bcb4c",
"type": {
"display_value": "Exchanges data with::Exchanges data with",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
"value": "607ad1b2c0a8010e01941856b365af90"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
}
],
"attributes": {
"firewall_status": "Intranet",
"os_address_width": "",
"attested_date": "",
"operational_status": "1",
"os_service_pack": "",
"cpu_core_thread": "",
"cpu_manufacturer": "",
"sys_updated_on": "2020-07-13 20:27:28",
"discovery_source": "ServiceNow",
"first_discovered": "2020-07-13 20:27:28",
"due_in": "",
"used_for": "Production",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "dora.gray",
"warranty_expiration": "",
"ram": "",
"cpu_name": "",
"cpu_speed": "",
"owned_by": "",
"checked_out": "",
"kernel_release": "",
"sys_domain_path": "/",
"classification": "Production",
"disk_space": "",
"object_id": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"cd_speed": "",
"floppy": "",
"managed_by": "",
"os_domain": "",
"last_discovered": "2020-07-13 20:27:28",
"can_print": "false",
"sys_class_name": "cmdb_ci_linux_server",
"manufacturer": "",
"cpu_count": "",
"vendor": "",
"life_cycle_stage_status": "",
"model_number": "",
"assigned_to": "",
"start_date": "",
"os_version": "",
"serial_number": "",
"cd_rom": "false",
"support_group": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": "",
"form_factor": "",
"cpu_core_count": "",
"skip_sync": "false",
"attestation_score": "",
"sys_updated_by": "dora.gray",
"sys_created_on": "2020-07-13 20:27:28",
"sys_domain": {
"display_value": "global",
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"cpu_type": "",
"install_date": "",
"asset_tag": "",
"dr_backup": "",
"hardware_substatus": "",
"fqdn": "",
"change_control": "",
"internet_facing": "true",
"delivery_date": "",
"hardware_status": "installed",
"install_status": "1",
"supported_by": "",
"name": "lnux299",
"subcategory": "Computer",
"default_gateway": "",
"chassis_type": "",
"virtual": "false",
"assignment_group": "",
"managed_by_group": "",
"sys_id": "0c3ff2641b425010593876a61a4bcb39",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!2/!(/!!/!0",
"mac_address": "",
"company": "",
"justification": "",
"department": "",
"cost": "",
"comments": "",
"os": "",
"sys_mod_count": "0",
"monitor": "false",
"model_id": "",
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": "",
"category": "Hardware",
"fault_count": "0",
"host_name": "",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "c03ff2641b425010593876a61a4bcb49",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
"value": "3a27d4370a0a0bb4006316812bf45439"
}
}
]
}
}
cURL-Anforderung
Das folgende Codebeispiel zeigt, wie dieser Endpunkt für eine Klasse aufgerufen wird, für die eine abhängige Identifizierungsregel definiert ist. outbound_relations.target muss in der Nutzlast enthalten sein und die sys_id eines vorhandenen CI enthalten.
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
"attributes": {
"name": "test",
"sys_class_name":"cmdb_ci_db_mssql_instance",
"instance_name":"Iname"
},
"source": "ServiceNow",
"depends_on": {
"outbound_relations":
{
"target": "b4fd7c8437201000deeabfc8bcbe5dc1",
"type": "60bc4e22c0a8010e01f074cbe6bd73c3"
}
}
}
}
{
"result": {
"outbound_relations": [
{
"sys_id": "505cfa3a53662110af64ddeeff7b1217",
"type": {
"display_value": "Runs on::Runs",
"link": http://instance.servicenow.com/api/now/table/cmdb_rel_type/60bc4e22c0a8010e01f074cbe6bd73c3,
"value": "60bc4e22c0a8010e01f074cbe6bd73c3"
},
"target": {
"display_value": "*ANNIE-IBM",
"link": http://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/b4fd7c8437201000deeabfc8bcbe5dc1,
"value": "b4fd7c8437201000deeabfc8bcbe5dc1"
}
}
],
"attributes": {
"attested_date": "",
"operational_status": "1",
"running_process_command": "",
"sys_updated_on": "2023-05-05 21:28:24",
"type": "",
"running_process_key_parameters": "",
"rp_command_hash": "",
"discovery_source": "ServiceNow",
"first_discovered": "2023-05-05 21:28:24",
"due_in": "",
"service_pack": "",
"used_for": "Production",
"is_clustered": "false",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "admin",
"warranty_expiration": "",
"owned_by": "",
"checked_out": "",
"rp_key_parameters_hash": "",
"sys_domain_path": "/",
"business_unit": "",
"version": "",
"cpu_sockets": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"managed_by": "",
"port_dynamic": "false",
"last_discovered": "2023-05-05 21:28:24",
"can_print": "false",
"sys_class_name": "cmdb_ci_db_mssql_instance",
"manufacturer": "",
"cl_port": "",
"vendor": "",
"life_cycle_stage_status": "",
"model_number": "",
"config_file": "",
"assigned_to": "",
"start_date": "",
"instance_name": "Iname",
"serial_number": "",
"engine_edition": "",
"support_group": "",
"version_name": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": "",
"config_directory": "",
"tcp_port": "",
"listener_name": "",
"skip_sync": "false",
"pid": "",
"attestation_score": "",
"sys_updated_by": "admin",
"install_directory": "",
"sys_created_on": "2023-05-05 21:28:24",
"sys_domain": {
"display_value": "global",
"link": http://instance.servicenow.com/api/now/table/sys_user_group/global,
"value": "global"
},
"install_date": "",
"asset_tag": "",
"fqdn": "",
"change_control": "",
"delivery_date": "",
"install_status": "1",
"supported_by": "",
"name": "test",
"subcategory": "Database",
"assignment_group": "",
"edition": "",
"managed_by_group": "",
"sys_id": "185cba3a53662110af64ddeeff7b12af",
"po_number": "",
"database": "",
"checked_in": "",
"sys_class_path": "/!!/!(/!2/!,",
"mac_address": "",
"company": "",
"justification": "",
"department": "",
"cost": "",
"comments": "",
"attestation_status": "Not Yet Reviewed",
"sys_mod_count": "0",
"monitor": "false",
"model_id": "",
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": "",
"category": "Resource",
"fault_count": "0",
"lease_id": ""
},
"inbound_relations": []
}
}
cURL-Anforderung
Das folgende Codebeispiel zeigt, was zurückgegeben wird, wenn eine sys_id nicht für eine Klasse übergeben wird, für die eine abhängige Identifizierungsregel definiert ist. Dasselbe Ergebnis tritt auf, wenn die sys_id ungültig ist.
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data "{
"attributes": {
"name": "test",
"sys_class_name":"cmdb_ci_db_mssql_instance",
"instance_name":"Iname"
},
"source": "ServiceNow",
"depends_on": {
"outbound_relations": {
"type": "60bc4e22c0a8010e01f074cbe6bd73c3"
}
}
}
{
"error": {
"detail": "Exception while executing request: null Check logs for error trace or enable glide.rest.debug property to verify REST request processing",
"message": "Exception while executing request: null"
},
"status": "failure"
}
CMDB Instance – PUT /now/cmdb/instance/{classname}/{sys_id}
Aktualisiert den angegebenen Configuration Item (CI)-Datensatz mit den angegebenen Attributname-Wert-Paaren. Dieser Endpunkt erstellt, aktualisiert oder löscht die zugeordneten Beziehungen nicht.
URL-Format
Versionierte URL: /api/now/v1/cmdb/instance/{className}/{sys_id}
Standard-URL: /api/now/cmdb/instance/{className}/{sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| className | CMDB Klassenname. Dies ist der Name der Tabelle, die die gewünschten CI-Datensätze enthält, z. B. cmdb_ci_linux_server oder cmdb_ci_apache_web_server. Datentyp: Zeichenfolge |
| sys_id | Sys_id des zu aktualisierenden CI-Datensatzes. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| attributes | Datenattribute, die im CI-Datensatz ersetzt werden sollen. Die verfügbaren Attribute hängen von der angegebenen Klasse CMDB ab. Sie finden die verfügbaren Attribute in der zugeordneten Tabelle CMDB, die normalerweise mit „cmdb_ci“ beginnt, z. B. cmdb_ci_linux_server oder cmdb_ci_mfp_printer. Datentyp: Objekt |
| Quelle | Erforderlich. Entität, die die Informationen aktualisiert hat. Dies muss einer der Auswahlwerte sein, die im Feld discovery_source in der Tabelle „Konfigurationselement“ [cmdb_ci] angegeben sind. 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ü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 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 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 405 | Ungültige Methode. Die Funktion ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| attributes | Datenattribute, die sich derzeit im CI-Datensatz befinden. Die verfügbaren Attribute hängen von der angegebenen Klasse CMDB ab. Sie finden die verfügbaren Attribute in der zugeordneten Tabelle CMDB, die normalerweise mit „cmdb_ci“ beginnt, z. B. cmdb_ci_linux_server oder cmdb_ci_mfp_printer. Datentyp: Objekt |
| Fehler | Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| inbound_relations | Liste der Objekte, die die eingehenden Beziehungen definieren, die dem CI zugeordnet sind. Datentyp: Array |
| inbound_relations.sys_id | Sys_id der eingehenden CI-Beziehung. Befindet sich in der Tabelle „CI-Beziehung“ [cmdb_rel_ci]. Datentyp: Zeichenfolge |
| inbound_relations.target | Informationen, die die eingehende Zielbeziehung beschreiben. Datentyp: Objekt |
| inbound_relations.target.display_value | Name der eingehenden Beziehung, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| inbound_relations.target.link | CMDB REST-Endpunkt-URL, die zum Abrufen der eingehenden Beziehung aus der Tabelle „Konfigurationselement“ [cmdb_ci] verwendet werden soll. Datentyp: Zeichenfolge |
| inbound_relations.target.value | Sys_id des eingehenden CI. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| inbound_relations.type | Informationen zum Typ der eingehenden Beziehung. Datentyp: Objekt |
| inbound_relations.type.display_value | Name des eingehenden Typs, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| inbound_relations.type.link | REST-Endpunkt-URL derTabelle, die zum Abrufen des eingehenden Beziehungstyps aus der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] verwendet werden soll. Datentyp: Zeichenfolge |
| inbound_relations.type.value | Sys_id des Typs der eingehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| outbound_relations | Liste der Objekte, die die ausgehenden Beziehungen definieren, die dem CI zugeordnet sind. Datentyp: Array |
| outbound_relations.sys_id | Sys_id der ausgehenden CI-Beziehung. Befindet sich in der Tabelle „CI-Beziehung“ [cmdb_rel_ci]. Datentyp: Zeichenfolge |
| outbound_relations.target | Erforderlich. Informationen zur ausgehenden Zielbeziehung. Datentyp: Objekt |
| outbound_relations.target.display_value | Name der ausgehenden Beziehung, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| outbound_relations.target.link | CMDB REST-Endpunkt-URL, die zum Abrufen der ausgehenden Beziehung aus der Tabelle „Konfigurationselement“ [cmdb_ci] verwendet werden soll. Datentyp: Zeichenfolge |
| outbound_relations.target.value | Sys_id des ausgehenden CI. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| outbound_relations.type | Informationen zum Typ der ausgehenden Beziehung. Datentyp: Objekt |
| outbound_relations.type.display_value | Name des ausgehenden Typs, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| outbound_relations.type.link | REST-Endpunkt-URL derTabelle, die zum Abrufen der ausgehenden Beziehung aus der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] verwendet werden soll. Datentyp: Zeichenfolge |
| outbound_relations.type.value | Sys_id des Typs der ausgehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| status | Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
Beispiel für eine cURL-Anforderung
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request PUT \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
"attributes": {
"firewall_status": "Extranet",
"discovery_source": "ServiceNows",
"name": "Linux299",
"used_for": "Pre-production",
"container": "Box"
},
"source": "ServiceNow"
}
{
"result": {
"outbound_relations": [
{
"sys_id": "403ff2641b425010593876a61a4bcb4b",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
},
{
"sys_id": "443ff2641b425010593876a61a4bcb4c",
"type": {
"display_value": "Exchanges data with::Exchanges data with",
"link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
"value": "607ad1b2c0a8010e01941856b365af90"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
}
],
"attributes": {
"firewall_status": "Extranet",
"os_address_width": "",
"attested_date": "",
"operational_status": "1",
"os_service_pack": "",
"cpu_core_thread": "",
"cpu_manufacturer": "",
"sys_updated_on": "2020-07-13 20:59:40",
"discovery_source": "ServiceNow",
"first_discovered": "2020-07-13 20:27:28",
"due_in": "",
"used_for": "Pre-production",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "dora.gray",
"warranty_expiration": "",
"ram": "",
"cpu_name": "",
"cpu_speed": "",
"owned_by": "",
"checked_out": "",
"kernel_release": "",
"sys_domain_path": "/",
"classification": "Production",
"disk_space": "",
"object_id": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"cd_speed": "",
"floppy": "",
"managed_by": "",
"os_domain": "",
"last_discovered": "2020-07-13 20:59:40",
"can_print": "false",
"sys_class_name": "cmdb_ci_linux_server",
"manufacturer": "",
"cpu_count": "",
"vendor": "",
"life_cycle_stage_status": "",
"model_number": "",
"assigned_to": "",
"start_date": "",
"os_version": "",
"serial_number": "",
"cd_rom": "false",
"support_group": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": {
"display_value": "Unknown",
"link": "https://instance.service-now.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
"value": "21cfba641b425010593876a61a4bcb52"
},
"form_factor": "",
"cpu_core_count": "",
"skip_sync": "false",
"attestation_score": "",
"sys_updated_by": "dora.gray",
"sys_created_on": "2020-07-13 20:27:28",
"sys_domain": {
"display_value": "global",
"link": "https://instance.service-now.com/api/now/table/sys_user_group/global",
"value": "global"
},
"cpu_type": "",
"install_date": "",
"asset_tag": "",
"dr_backup": "",
"hardware_substatus": "",
"fqdn": "",
"change_control": "",
"internet_facing": "true",
"delivery_date": "",
"hardware_status": "installed",
"install_status": "1",
"supported_by": "",
"name": "Linux299",
"subcategory": "Computer",
"default_gateway": "",
"chassis_type": "",
"virtual": "false",
"assignment_group": "",
"managed_by_group": "",
"sys_id": "0c3ff2641b425010593876a61a4bcb39",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!2/!(/!!/!0",
"mac_address": "",
"company": "",
"justification": "",
"department": "",
"cost": "",
"comments": "",
"os": "",
"sys_mod_count": "3",
"monitor": "false",
"model_id": {
"display_value": "Unknown",
"link": "https://instance.service-now.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
"value": "0ce0a2681b4e1010593876a61a4bcba6"
},
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": "",
"category": "Hardware",
"fault_count": "0",
"host_name": "",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "c03ff2641b425010593876a61a4bcb49",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.service-now.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache01",
"link": "https://instance.service-now.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
"value": "3a27d4370a0a0bb4006316812bf45439"
}
}
]
}
}
CMDB Instanz – POST /now/cmdb/instance/{classname}/{sys_id}/relation
Fügt dem angegebenen Konfigurationselement (CI) eine eingehende und/oder ausgehende Beziehung hinzu. Das angegebene CI ist das übergeordnete Element.
URL-Format
Versionierte URL: /api/now/v1/cmdb/instance/{className}/{sys_id}/relation
Standard-URL: /api/now/cmdb/instance/{className}/{sys_id}/relation
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| className | CMDB Klassenname. Dies ist der Name der Tabelle, die die gewünschten CI-Datensätze enthält, z. B. cmdb_ci_linux_server oder cmdb_ci_apache_web_server. Datentyp: Zeichenfolge |
| sys_id | Sys_id des zu aktualisierenden CI-Datensatzes. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| inbound_relations | Liste der Objekte, die die eingehenden Beziehungen definieren, die dem CI zugeordnet werden sollen. Datentyp: Array |
| inbound_relations.target | Erforderlich, wenn inbound_relations angegeben ist. Sys_id der eingehenden Zielbeziehung, die dem angegebenen CI zugeordnet werden soll. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| inbound_relations.type | Erforderlich, wenn inbound_relations angegeben ist. Sys_id des Typs der eingehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge Datentyp: Zeichenfolge |
| outbound_relations | Liste der Objekte, die die ausgehenden Beziehungen definieren, die dem CI zugeordnet werden sollen. Datentyp: Array |
| outbound_relations.target | Erforderlich, wenn outbound_relations angegeben ist. Sys_id der ausgehenden Zielbeziehung. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| outbound_relations.type | Erforderlich, wenn outbound_relations angegeben ist. Sys_id des Typs der ausgehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| Quelle | Erforderlich. Entität, die die Informationen aktualisiert hat. Dies muss einer der Auswahlwerte sein, die im Feld discovery_source in der Tabelle „Konfigurationselement“ [cmdb_ci] angegeben sind. 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ü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 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 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 405 | Ungültige Methode. Die Funktion ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| attributes | Datenattribute, die sich derzeit im CI-Datensatz befinden. Die verfügbaren Attribute hängen von der angegebenen Klasse CMDB ab. Sie finden die verfügbaren Attribute in der zugeordneten Tabelle CMDB, die normalerweise mit „cmdb_ci“ beginnt, z. B. cmdb_ci_linux_server oder cmdb_ci_mfp_printer. Datentyp: Objekt |
| Fehler | Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| inbound_relations | Liste der Objekte, die die eingehenden Beziehungen definieren, die dem CI zugeordnet sind. Datentyp: Array |
| inbound_relations.sys_id | Sys_id der eingehenden CI-Beziehung. Befindet sich in der Tabelle „CI-Beziehung“ [cmdb_rel_ci]. Datentyp: Zeichenfolge |
| inbound_relations.target | Informationen, die die eingehende Zielbeziehung beschreiben. Datentyp: Objekt |
| inbound_relations.target.display_value | Name der eingehenden Beziehung, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| inbound_relations.target.link | CMDB REST-Endpunkt-URL, die zum Abrufen der eingehenden Beziehung aus der Tabelle „Konfigurationselement“ [cmdb_ci] verwendet werden soll. Datentyp: Zeichenfolge |
| inbound_relations.target.value | Sys_id des eingehenden CI. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| inbound_relations.type | Informationen zum Typ der eingehenden Beziehung. Datentyp: Objekt |
| inbound_relations.type.display_value | Name des eingehenden Typs, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| inbound_relations.type.link | REST-Endpunkt-URL derTabelle, die zum Abrufen des eingehenden Beziehungstyps aus der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] verwendet werden soll. Datentyp: Zeichenfolge |
| inbound_relations.type.value | Sys_id des Typs der eingehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| outbound_relations | Liste der Objekte, die die ausgehenden Beziehungen definieren, die dem CI zugeordnet sind. Datentyp: Array |
| outbound_relations.sys_id | Sys_id der ausgehenden CI-Beziehung. Befindet sich in der Tabelle „CI-Beziehung“ [cmdb_rel_ci]. Datentyp: Zeichenfolge |
| outbound_relations.target | Erforderlich. Informationen zur ausgehenden Zielbeziehung. Datentyp: Objekt |
| outbound_relations.target.display_value | Name der ausgehenden Beziehung, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| outbound_relations.target.link | CMDB REST-Endpunkt-URL, die zum Abrufen der ausgehenden Beziehung aus der Tabelle „Konfigurationselement“ [cmdb_ci] verwendet werden soll. Datentyp: Zeichenfolge |
| outbound_relations.target.value | Sys_id des ausgehenden CI. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| outbound_relations.type | Informationen zum Typ der ausgehenden Beziehung. Datentyp: Objekt |
| outbound_relations.type.display_value | Name des ausgehenden Typs, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| outbound_relations.type.link | REST-Endpunkt-URL derTabelle, die zum Abrufen der ausgehenden Beziehung aus der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] verwendet werden soll. Datentyp: Zeichenfolge |
| outbound_relations.type.value | Sys_id des Typs der ausgehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| status | Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
Beispiel für eine cURL-Anforderung
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci_linux_server/3a290cc60a0a0bb400000bdb386af1cf/relation" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password" \
--data {
"outbound_relations": [
{
"type" : "1a9cb166f1571100a92eb60da2bce5c5",
"target" : "3a307c930a0a0bb400353965d0b8861f"
},
{
"type" : "607ad1b2c0a8010e01941856b365af90",
"target" : "3a307c930a0a0bb400353965d0b8861f"
}
],
"source": "ServiceNow",
"inbound_relations": [
{
"type" : "1a9cb166f1571100a92eb60da2bce5c5",
"target" : "3a27d4370a0a0bb4006316812bf45439"
}
]
}
{
"result": {
"outbound_relations": [
{
"sys_id": "403ff2641b425010593876a61a4bcb4b",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
},
{
"sys_id": "443ff2641b425010593876a61a4bcb4c",
"type": {
"display_value": "Exchanges data with::Exchanges data with",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
"value": "607ad1b2c0a8010e01941856b365af90"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
}
],
"attributes": {
"firewall_status": "Active",
"os_address_width": "",
"attested_date": "",
"operational_status": "1",
"os_service_pack": "",
"cpu_core_thread": "",
"cpu_manufacturer": "",
"sys_updated_on": "2020-07-13 21:24:05",
"discovery_source": "ServiceNow",
"first_discovered": "2020-07-13 20:27:28",
"due_in": "",
"used_for": "Production",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "dora.gray",
"warranty_expiration": "",
"ram": "",
"cpu_name": "",
"cpu_speed": "",
"owned_by": "",
"checked_out": "",
"kernel_release": "",
"sys_domain_path": "/",
"classification": "Production",
"disk_space": "",
"object_id": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"cd_speed": "",
"floppy": "",
"managed_by": "",
"os_domain": "",
"last_discovered": "2020-07-13 21:24:05",
"can_print": "false",
"sys_class_name": "cmdb_ci_linux_server",
"manufacturer": "",
"cpu_count": "",
"vendor": "",
"life_cycle_stage_status": "",
"model_number": "",
"assigned_to": "",
"start_date": "",
"os_version": "",
"serial_number": "",
"cd_rom": "false",
"support_group": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": {
"display_value": "Unknown",
"link": "https://instance.servicenow.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
"value": "21cfba641b425010593876a61a4bcb52"
},
"form_factor": "",
"cpu_core_count": "",
"skip_sync": "false",
"attestation_score": "",
"sys_updated_by": "dora.gray",
"sys_created_on": "2020-07-13 20:27:28",
"sys_domain": {
"display_value": "global",
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"cpu_type": "",
"install_date": "",
"asset_tag": "",
"dr_backup": "",
"hardware_substatus": "",
"fqdn": "",
"change_control": "",
"internet_facing": "true",
"delivery_date": "",
"hardware_status": "installed",
"install_status": "1",
"supported_by": "",
"name": "Linux299",
"subcategory": "Computer",
"default_gateway": "",
"chassis_type": "",
"virtual": "false",
"assignment_group": "",
"managed_by_group": "",
"sys_id": "0c3ff2641b425010593876a61a4bcb39",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!2/!(/!!/!0",
"mac_address": "",
"company": "",
"justification": "",
"department": "",
"cost": "",
"comments": "",
"os": "",
"sys_mod_count": "4",
"monitor": "false",
"model_id": {
"display_value": "Unknown",
"link": "https://instance.servicenow.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
"value": "0ce0a2681b4e1010593876a61a4bcba6"
},
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": "",
"category": "Hardware",
"fault_count": "0",
"host_name": "",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "c03ff2641b425010593876a61a4bcb49",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
"value": "3a27d4370a0a0bb4006316812bf45439"
}
}
]
}
}
CMDB Instance – PATCH /now/cmdb/instance/{classname}/{sys_id}
Ersetzt die Attribute im angegebenen Configuration Item (CI)-Datensatz durch die angegebenen Name-Wert-Paare. Dieser Endpunkt erstellt, aktualisiert oder löscht die zugeordneten Beziehungen nicht.
URL-Format
Versionierte URL: /api/now/v1/cmdb/instance/{className}/{sys_id}
Standard-URL: /api/now/cmdb/instance/{className}/{sys_id}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| className | CMDB Klassenname. Dies ist der Name der Tabelle, die die gewünschten CI-Datensätze enthält, z. B. cmdb_ci_linux_server oder cmdb_ci_apache_web_server. Datentyp: Zeichenfolge |
| sys_id | Sys_id des zu aktualisierenden CI-Datensatzes. Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| attributes | Datenattribute, die im CI-Datensatz ersetzt werden sollen. Die verfügbaren Attribute hängen von der angegebenen Klasse CMDB ab. Sie finden die verfügbaren Attribute in der zugeordneten Tabelle CMDB, die normalerweise mit „cmdb_ci“ beginnt, z. B. cmdb_ci_linux_server oder cmdb_ci_mfp_printer. Datentyp: Objekt |
| Quelle | Erforderlich. Entität, die die Informationen aktualisiert hat. Dies muss einer der Auswahlwerte sein, die im Feld discovery_source in der Tabelle „Konfigurationselement“ [cmdb_ci] angegeben sind. 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ü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 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 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
| 401 | Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 405 | Ungültige Methode. Die Funktion ist deaktiviert. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler. |
Antworttextparameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| attributes | Datenattribute, die sich derzeit im CI-Datensatz befinden. Die verfügbaren Attribute hängen von der angegebenen Klasse CMDB ab. Sie finden die verfügbaren Attribute in der zugeordneten Tabelle CMDB, die normalerweise mit „cmdb_ci“ beginnt, z. B. cmdb_ci_linux_server oder cmdb_ci_mfp_printer. Datentyp: Objekt |
| Fehler | Informationen zu Fehlern, die bei der Verarbeitung der Endpunktanforderung aufgetreten sind. Datentyp: Objekt |
| Fehler.Detail | Zusätzliche Informationen zum Fehler. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler identifiziert. Datentyp: Zeichenfolge |
| inbound_relations | Liste der Objekte, die die eingehenden Beziehungen definieren, die dem CI zugeordnet sind. Datentyp: Array |
| inbound_relations.sys_id | Sys_id der eingehenden CI-Beziehung. Befindet sich in der Tabelle „CI-Beziehung“ [cmdb_rel_ci]. Datentyp: Zeichenfolge |
| inbound_relations.target | Informationen, die die eingehende Zielbeziehung beschreiben. Datentyp: Objekt |
| inbound_relations.target.display_value | Name der eingehenden Beziehung, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| inbound_relations.target.link | CMDB REST-Endpunkt-URL, die zum Abrufen der eingehenden Beziehung aus der Tabelle „Konfigurationselement“ [cmdb_ci] verwendet werden soll. Datentyp: Zeichenfolge |
| inbound_relations.target.value | Sys_id des eingehenden CI. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| inbound_relations.type | Informationen zum Typ der eingehenden Beziehung. Datentyp: Objekt |
| inbound_relations.type.display_value | Name des eingehenden Typs, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| inbound_relations.type.link | REST-Endpunkt-URL derTabelle, die zum Abrufen des eingehenden Beziehungstyps aus der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] verwendet werden soll. Datentyp: Zeichenfolge |
| inbound_relations.type.value | Sys_id des Typs der eingehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| outbound_relations | Liste der Objekte, die die ausgehenden Beziehungen definieren, die dem CI zugeordnet sind. Datentyp: Array |
| outbound_relations.sys_id | Sys_id der ausgehenden CI-Beziehung. Befindet sich in der Tabelle „CI-Beziehung“ [cmdb_rel_ci]. Datentyp: Zeichenfolge |
| outbound_relations.target | Erforderlich. Informationen zur ausgehenden Zielbeziehung. Datentyp: Objekt |
| outbound_relations.target.display_value | Name der ausgehenden Beziehung, die in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| outbound_relations.target.link | CMDB REST-Endpunkt-URL, die zum Abrufen der ausgehenden Beziehung aus der Tabelle „Konfigurationselement“ [cmdb_ci] verwendet werden soll. Datentyp: Zeichenfolge |
| outbound_relations.target.value | Sys_id des ausgehenden CI. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci]. Datentyp: Zeichenfolge |
| outbound_relations.type | Informationen zum Typ der ausgehenden Beziehung. Datentyp: Objekt |
| outbound_relations.type.display_value | Name des ausgehenden Typs, der in einer Benutzeroberfläche angezeigt werden soll. Datentyp: Zeichenfolge |
| outbound_relations.type.link | REST-Endpunkt-URL derTabelle, die zum Abrufen der ausgehenden Beziehung aus der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] verwendet werden soll. Datentyp: Zeichenfolge |
| outbound_relations.type.value | Sys_id des Typs der ausgehenden Beziehung. Befindet sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type]. Datentyp: Zeichenfolge |
| status | Wird nur angezeigt, wenn ein Fehler aufgetreten ist. Status der Endpunktverarbeitung. Möglicher Wert: Fehler Datentyp: Zeichenfolge |
Beispiel für eine cURL-Anforderung
curl "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_class_sw/70bc4e11c0a8210d01f074cbe6bd73b4" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json"\
--user "username":"password"\
--data {
"attributes": {
"firewall_status": "Active",
"name": "Linux299",
"used_for": "Production"
},
"source": "ServiceNow"
}
{
"result": {
"outbound_relations": [
{
"sys_id": "403ff2641b425010593876a61a4bcb4b",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
},
{
"sys_id": "443ff2641b425010593876a61a4bcb4c",
"type": {
"display_value": "Exchanges data with::Exchanges data with",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/607ad1b2c0a8010e01941856b365af90",
"value": "607ad1b2c0a8010e01941856b365af90"
},
"target": {
"display_value": "PS ORA01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a307c930a0a0bb400353965d0b8861f",
"value": "3a307c930a0a0bb400353965d0b8861f"
}
}
],
"attributes": {
"firewall_status": "Active",
"os_address_width": "",
"attested_date": "",
"operational_status": "1",
"os_service_pack": "",
"cpu_core_thread": "",
"cpu_manufacturer": "",
"sys_updated_on": "2020-07-13 21:24:05",
"discovery_source": "ServiceNow",
"first_discovered": "2020-07-13 20:27:28",
"due_in": "",
"used_for": "Production",
"invoice_number": "",
"gl_account": "",
"sys_created_by": "dora.gray",
"warranty_expiration": "",
"ram": "",
"cpu_name": "",
"cpu_speed": "",
"owned_by": "",
"checked_out": "",
"kernel_release": "",
"sys_domain_path": "/",
"classification": "Production",
"disk_space": "",
"object_id": "",
"maintenance_schedule": "",
"cost_center": "",
"attested_by": "",
"dns_domain": "",
"assigned": "",
"purchase_date": "",
"life_cycle_stage": "",
"short_description": "",
"cd_speed": "",
"floppy": "",
"managed_by": "",
"os_domain": "",
"last_discovered": "2020-07-13 21:24:05",
"can_print": "false",
"sys_class_name": "cmdb_ci_linux_server",
"manufacturer": "",
"cpu_count": "",
"vendor": "",
"life_cycle_stage_status": "",
"model_number": "",
"assigned_to": "",
"start_date": "",
"os_version": "",
"serial_number": "",
"cd_rom": "false",
"support_group": "",
"unverified": "false",
"correlation_id": "",
"attributes": "",
"asset": {
"display_value": "Unknown",
"link": "https://instance.servicenow.com/api/now/table/alm_asset/21cfba641b425010593876a61a4bcb52",
"value": "21cfba641b425010593876a61a4bcb52"
},
"form_factor": "",
"cpu_core_count": "",
"skip_sync": "false",
"attestation_score": "",
"sys_updated_by": "dora.gray",
"sys_created_on": "2020-07-13 20:27:28",
"sys_domain": {
"display_value": "global",
"link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
"value": "global"
},
"cpu_type": "",
"install_date": "",
"asset_tag": "",
"dr_backup": "",
"hardware_substatus": "",
"fqdn": "",
"change_control": "",
"internet_facing": "true",
"delivery_date": "",
"hardware_status": "installed",
"install_status": "1",
"supported_by": "",
"name": "Linux299",
"subcategory": "Computer",
"default_gateway": "",
"chassis_type": "",
"virtual": "false",
"assignment_group": "",
"managed_by_group": "",
"sys_id": "0c3ff2641b425010593876a61a4bcb39",
"po_number": "",
"checked_in": "",
"sys_class_path": "/!!/!2/!(/!!/!0",
"mac_address": "",
"company": "",
"justification": "",
"department": "",
"cost": "",
"comments": "",
"os": "",
"sys_mod_count": "4",
"monitor": "false",
"model_id": {
"display_value": "Unknown",
"link": "https://instance.servicenow.com/api/now/table/cmdb_model/0ce0a2681b4e1010593876a61a4bcba6",
"value": "0ce0a2681b4e1010593876a61a4bcba6"
},
"ip_address": "",
"duplicate_of": "",
"sys_tags": "",
"cost_cc": "USD",
"order_date": "",
"schedule": "",
"environment": "",
"due": "",
"attested": "false",
"location": "",
"category": "Hardware",
"fault_count": "0",
"host_name": "",
"lease_id": ""
},
"inbound_relations": [
{
"sys_id": "c03ff2641b425010593876a61a4bcb49",
"type": {
"display_value": "Depends on::Used by",
"link": "https://instance.servicenow.com/api/now/table/cmdb_rel_type/1a9cb166f1571100a92eb60da2bce5c5",
"value": "1a9cb166f1571100a92eb60da2bce5c5"
},
"target": {
"display_value": "PS Apache01",
"link": "https://instance.servicenow.com/api/now/cmdb/instance/cmdb_ci/3a27d4370a0a0bb4006316812bf45439",
"value": "3a27d4370a0a0bb4006316812bf45439"
}
}
]
}
}