Ressourcenbestand offene API

Die Open-API von Resource Inventory bietet Endpunkte zum Erstellen, Abrufen und Löschen von Ressourcen.

Verwenden Sie diese API, um Ressourcen in den folgenden Tabellen zu verwalten.

• Schnittstellenkarte [cmdb_ci_interface_card]
• IP-Adresse [cmdb_ci_ip_address]
• Logische Verbindung [cmdb_ci_ni_logical_path]
• Netzwerkschnittstelle [cmdb_ci_ni_interface]
• Netzwerkstandort [cmdb_ci_ni_site]
• Physische Verbindung [cmdb_ci_ni_physical_link]
• Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern.
• Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern.

Diese API ist in der Anwendung Network Inventory Core enthalten, die im ServiceNow Storeverfügbar ist.

Diese API wird im Namespace sn_ni_core bereitgestellt.

Der aufrufende Benutzer muss die Rolle sn_ni_core.inventory_integrator haben.

Diese API kann erweitert werden, um Anpassungen für erforderliche Parameter, die Validierung des Anforderungstexts und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie im Abschnitt Resource Inventory Open API-Entwicklerleitfaden.

Die offene API „Ressourcenbestand “ ist eine ServiceNow® -Implementierung der REST-Spezifikation der TM Forum-API „Ressourcenbestand“. Diese Implementierung basiert auf TMF639 Resource Inventory API User Guide v4.0.1, Juli 2020.

Resource Inventory Open API – DELETE /sn_ni_core/resource/{id}

Löscht einen angegebenen Ressourcendatensatz.

URL-Format

Standard-URL: /api/sn_ni_core/resource/{id}

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name

Beschreibung

id

Sys_id der Ressource. Befindet sich je nach Ressourcentyp in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern. Hinweis: Ressourcen in der Tabelle „IP-Adresse“ [cmdb_ci_ip_address] können mit dieser API nicht gelöscht werden. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter (JSON)

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.

Tabelle : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 5. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.

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.

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
215	Anforderung zur Verarbeitung erfolgreich erhalten. Die Anforderung wird asynchron abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
403	Unzulässig. Fehler beim Löschen der Ressource. Die Ressource wird möglicherweise von den zugehörigen Ressourcen benötigt.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Keine

cURL-Anforderung

In diesem Beispiel wird eine Ressource gelöscht.

curl "https://instance.service-now.com/api/sn_ni_core/resource/54ada05e875c15109a9c0f65dabb3586" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

""

Resource Inventory Open API – GET /sn_ni_core/resource

Ruft eine Liste aller Ressourcendatensätze ab.

URL-Format

Standard-URL: /api/sn_ni_core/resource

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 8. Abfrageparameter

Name	Beschreibung
@type	Erforderlich. Tabellenname des Typs der abzurufenden Ressource. Sie können pro API-Aufruf nur einen Ressourcentyp abrufen. Gültige Werte: cmdb_ci_interface_card (Schnittstellenkarte) cmdb_ci_ip_address (IP-Adresse) cmdb_ci_ni_logical_path (Logische Verbindung) cmdb_ci_ni_interface (Netzwerkschnittstelle) cmdb_ci_ni_site (Netzwerk-Site) cmdb_ci_ni_physical_link (Physische Verbindung) Name einer Tabelle, die durch die sys_property sn_ni_core.equipment_tables angegeben wird, oder Name einer Tabelle, die die angegebenen Tabellen erweitert. Name einer Tabelle, die den Gerätehalter [cmdb_ci_equipment_holder] erweitert. Datentyp: Zeichenfolge
Beschreibung	Beschreibung zum Filtern von Ressourcen. In der Antwort werden nur Ressourcen mit der angegebenen Beschreibung zurückgegeben. Datentyp: Zeichenfolge
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Werte: Beschreibung href id Name Hinweis Ort relatedPartei resourceCharacteristic resourceRelationship resourceSpecification startOperatingDate Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Standard: 20 Datentyp: Zahl
Name	Name, der zum Filtern von Ressourcen verwendet werden soll. In der Antwort werden nur Ressourcen mit dem angegebenen Namen zurückgegeben. Datentyp: Zeichenfolge
Offset	Startindex, bei dem mit dem Abrufen von Datensätzen begonnen 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. Standard: 0 Datentyp: Zahl
resourceSpecification.id	sys_id der Ressourcenspezifikation, die zum Filtern von Ressourcen verwendet werden soll. Die sys_id muss aus einem Modell in einer der folgenden Tabellen stammen. Gerätehaltermodelle [sn_ni_core_equipment_holder_product_model] Anlagenmodelle [sn_ni_core_equipment_product_model] Schnittstellenkartenmodelle [sn_ni_core_interface_card_product_model] Logische Verbindungsmodelle [sn_ni_core_logical_connection_product_model] Netzwerkschnittstellenmodelle [sn_ni_core_network_interface_product_model] Physische Verbindungsmodelle [sn_ni_core_physical_connection_product_model] Nur Ressourcen mit einem Modell, das der angegebenen sys_id entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 9. Anforderungstextparameter (JSON)

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.

Tabelle : 10. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 11. Antwortkopfzeilen

Kopfzeile	Beschreibung
Inhaltsbereich	Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird. Wenn beispielsweise offset=2 und limit=3festgelegt ist, lautet der Wert der Kopfzeile Content-Rangeitems 3-5.
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter previous
X-Gesamtzahl	Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. Hinweis: Wenn die Gesamtzahl der Datensätze mehr als 100.000 beträgt, gibt dieser Header immer 100.000 zurück.

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.

Tabelle : 12. Statuscodes

Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
206	Teilinhalt. Die Anforderung wurde erfolgreich verarbeitet und hat einen Teilbereich des Inhalts zurückgegeben, der durch einen paginierten Aufruf angegeben wurde.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
@type	Der Typ der Ressource. Gültige Werte: cmdb_ci_interface_card (Schnittstellenkarte) cmdb_ci_ip_address (IP-Adresse) cmdb_ci_ni_logical_path (Logische Verbindung) cmdb_ci_ni_interface (Netzwerkschnittstelle) cmdb_ci_ni_site (Netzwerk-Site) cmdb_ci_ni_physical_link (Physische Verbindung) Name einer Tabelle, die durch die sys_property sn_ni_core.equipment_tables angegeben wird, oder Name einer Tabelle, die die angegebenen Tabellen erweitert. Name einer Tabelle, die den Gerätehalter [cmdb_ci_equipment_holder] erweitert. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Ressource. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge
id	Sys_id der Ressource. Befindet sich je nach Ressourcentyp in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] IP-Adresse [cmdb_ci_ip_address] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern. Datentyp: Zeichenfolge
Name	Name der Ressource Datentyp: Zeichenfolge
Hinweis	Liste der Notizen zur Ressource. Datentyp: Array "note": [ { "text": "String" } ]
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
Ort	Netzwerkstandort für die Ressource. Dieser Parameter wird für Ressourcen vom Typ „Netzwerkstandort“, „Physische Verbindung“ oder „Logische Verbindung“ nicht unterstützt. Datentyp: Objekt "place": { "@referredType": "String", "href": "String", "id": "String" }
ort.@referredType	Der Typ des Orts. Dieser Wert ist immer GeographicAddress. Datentyp: Zeichenfolge
Ort.href	Relativer Link zum Ortsdatensatz. Datentyp: Zeichenfolge
place.id	Sys_id des Ortsdatensatzes in der Tabelle „Netzwerkstandort“ [cmdb_ci_ni_site]. Datentyp: Zeichenfolge
relatedPartei	Details zu Kontakten für die Ressource. Datentyp: Array "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Befindet sich in der Gruppentabelle [sys_user_group] im Feld Typ. Datentyp: Zeichenfolge
relatedPartei.href	Relativer Link zum Datensatz der zugehörigen Partei. Datentyp: Zeichenfolge
relatedPartei.id	Sys_id des Datensatzes der zugehörigen Partei in der Gruppentabelle [sys_user_group]. Datentyp: Zeichenfolge
relatedPartei.rolle	Die Rolle der zugehörigen Partei. Befindet sich in der Teams-Tabelle [cmdb_rel_team] im Feld Gruppentyp. Datentyp: Zeichenfolge
resourceCharacteristic	Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale. Für physische und logische Verbindungsressourcen ist ein Port A- oder Port Z- Merkmal erforderlich. Wenn der Lebenszyklusphasenstatus der Ressource „In Gebrauch“ lautet, sind sowohl Port A als auch Port Z erforderlich. Für Gerätehalter-Ressourcen ist ein Containertyp- Merkmal erforderlich. Datentyp: Array "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Feldname aus der Ressourcentabelle, die durch den Parameter @type angegeben wird. Sie können die Felder model_id, name, network_site, operation_notes, operational_status, short_description, start_date oder beliebige sys_-Präfixfelder wie sys_id nicht verwenden. Datentyp: Zeichenfolge
resourceCharacteristic.value	Der Wert des Merkmals. Datentyp: Zeichenfolge
resourceCharacteristic.valueType	Der Typ des Werts. Gültige Werte: boolean Datum/Uhrzeit schweben integer ph_number Referenz Zeichenfolge Datentyp: Zeichenfolge
resourceRelationship	Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen. Für Schnittstellenkarten-Ressourcen ist eine Beziehung zu einer Gerätehalter-Ressource erforderlich, bei der der Containertyp „Slot“ oder „Sub-Slot“ ist. Für Netzwerkschnittstellenressourcen ist eine Beziehung zu einer Ausrüstungs- oder Schnittstellenkartenressource erforderlich. Für Gerätehalter-Ressourcen, bei denen der Containertyp Slot oder Sub-Slot ist, ist eine Beziehung zu einer Geräte- oder Schnittstellenkartenressource erforderlich. Datentyp: Array "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Typ der Beziehung zwischen den beiden Ressourcen im Format [dieser Ressourcendeskriptor]::[zugehöriger Ressourcendeskriptor]. Beispiel: Enthält::Enthalten in gibt an, dass die zugehörige Ressource das untergeordnete Element dieser Ressource ist. Gültige Werte für die Deskriptoren befinden sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] in den Spalten Übergeordneter Deskriptor und Untergeordneter Deskriptor. Datentyp: Zeichenfolge
resourceRelationship.resource	Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein. Schnittstellenkarte Logische Verbindung Netzwerkschnittstelle Netzwerkstandort Physische Verbindung Ausrüstung Gerätehalter Datentyp: Objekt "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id der zugehörigen Ressource. Befindet sich je nach Typ der zugehörigen Ressource in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern Datentyp: Zeichenfolge
resourceRelationship.resource.href	Relativer Link zum zugehörigen Ressourcendatensatz. Datentyp: Zeichenfolge
resourceSpecification	Ressourcenspezifikation. Datentyp: Objekt "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id des zugeordneten Modells für die Ressource. Befindet sich je nach Modelltyp in einer der folgenden Tabellen. Gerätehaltermodelle [sn_ni_core_equipment_holder_product_model] Anlagenmodelle [sn_ni_core_equipment_product_model] Schnittstellenkartenmodelle [sn_ni_core_interface_card_product_model] Logische Verbindungsmodelle [sn_ni_core_logical_connection_product_model] Netzwerkschnittstellenmodelle [sn_ni_core_network_interface_product_model] Physische Verbindungsmodelle [sn_ni_core_physical_connection_product_model] Datentyp: Zeichenfolge
startOperatingDate	Datum und Uhrzeit, zu der die Ressource erstmals in Betrieb genommen wurde. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden die Felder name, idund href für die ersten fünf Netzwerkstandort-Ressourcendatensätze abgerufen.

curl "https://instance.service-now.com/api/sn_ni_core/resource?@type=cmdb_ci_ni_site&fields=name%2Cid%2Chref&limit=5" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

[
   {
      "name": "DALLAS TX CO/HUB",
      "id": "c23683c54051c910f8772175cacd725c",
      "href": "/api/sn_ni_core/resource/c23683c54051c910f8772175cacd725c"
   },
   {
      "name": "PFP LOC F-800",
      "id": "0ac19bc54051c910f8772175cacd724b",
      "href": "/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b"
   },
   {
      "name": "FIBER SERVICE TERMINAL 003",
      "id": "d0541fcd4051c910f8772175cacd72c8",
      "href": "/api/sn_ni_core/resource/d0541fcd4051c910f8772175cacd72c8"
   },
   {
      "name": "270 RUMWOOD MAIN",
      "id": "e6f6df8d4051c910f8772175cacd72b2",
      "href": "/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2"
   },
   {
      "name": "3620 CHESTER ROMI48073",
      "id": "917dd8f6870e851079c40f2d0ebb353d",
      "href": "/api/sn_ni_core/resource/917dd8f6870e851079c40f2d0ebb353d"
   }
]

Resource Inventory Open API – GET /sn_ni_core/resource/{id}

Ruft einen angegebenen Ressourcendatensatz ab.

URL-Format

Standard-URL: /api/sn_ni_core/resource/{id}

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

Name

Beschreibung

id

Sys_id der Ressource. Befindet sich je nach Ressourcentyp in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] IP-Adresse [cmdb_ci_ip_address] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern. Datentyp: Zeichenfolge

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Werte: Beschreibung href id Name Hinweis Ort relatedPartei resourceCharacteristic resourceRelationship resourceSpecification startOperatingDate Standard: Gibt alle Felder zurück. Datentyp: Zeichenfolge

Tabelle : 15. Anforderungstextparameter (JSON)

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.

Tabelle : 16. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 17. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.

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.

Tabelle : 18. Statuscodes

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.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
@type	Der Typ der Ressource. Gültige Werte: cmdb_ci_interface_card (Schnittstellenkarte) cmdb_ci_ip_address (IP-Adresse) cmdb_ci_ni_logical_path (Logische Verbindung) cmdb_ci_ni_interface (Netzwerkschnittstelle) cmdb_ci_ni_site (Netzwerk-Site) cmdb_ci_ni_physical_link (Physische Verbindung) Name einer Tabelle, die durch die sys_property sn_ni_core.equipment_tables angegeben wird, oder Name einer Tabelle, die die angegebenen Tabellen erweitert. Name einer Tabelle, die den Gerätehalter [cmdb_ci_equipment_holder] erweitert. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Ressource. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge
id	Sys_id der Ressource. Befindet sich je nach Ressourcentyp in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] IP-Adresse [cmdb_ci_ip_address] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern. Datentyp: Zeichenfolge
Name	Name der Ressource Datentyp: Zeichenfolge
Hinweis	Liste der Notizen zur Ressource. Datentyp: Array "note": [ { "text": "String" } ]
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
Ort	Netzwerkstandort für die Ressource. Dieser Parameter wird für Ressourcen vom Typ „Netzwerkstandort“, „Physische Verbindung“ oder „Logische Verbindung“ nicht unterstützt. Datentyp: Objekt "place": { "@referredType": "String", "href": "String", "id": "String" }
ort.@referredType	Der Typ des Orts. Dieser Wert ist immer GeographicAddress. Datentyp: Zeichenfolge
Ort.href	Relativer Link zum Ortsdatensatz. Datentyp: Zeichenfolge
place.id	Sys_id des Ortsdatensatzes in der Tabelle „Netzwerkstandort“ [cmdb_ci_ni_site]. Datentyp: Zeichenfolge
relatedPartei	Details zu Kontakten für die Ressource. Datentyp: Array "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Befindet sich in der Gruppentabelle [sys_user_group] im Feld Typ. Datentyp: Zeichenfolge
relatedPartei.href	Relativer Link zum Datensatz der zugehörigen Partei. Datentyp: Zeichenfolge
relatedPartei.id	Sys_id des Datensatzes der zugehörigen Partei in der Gruppentabelle [sys_user_group]. Datentyp: Zeichenfolge
resourceCharacteristic	Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale. Für physische und logische Verbindungsressourcen ist ein Port A- oder Port Z- Merkmal erforderlich. Wenn der Lebenszyklusphasenstatus der Ressource „In Gebrauch“ lautet, sind sowohl Port A als auch Port Z erforderlich. Für Gerätehalter-Ressourcen ist ein Containertyp- Merkmal erforderlich. Datentyp: Array "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Feldname aus der Ressourcentabelle, die durch den Parameter @type angegeben wird. Sie können die Felder model_id, name, network_site, operation_notes, operational_status, short_description, start_date oder beliebige sys_-Präfixfelder wie sys_id nicht verwenden. Datentyp: Zeichenfolge
resourceCharacteristic.value	Der Wert des Merkmals. Datentyp: Zeichenfolge
resourceCharacteristic.valueType	Der Typ des Werts. Gültige Werte: boolean Datum/Uhrzeit schweben integer ph_number Referenz Zeichenfolge Datentyp: Zeichenfolge
resourceRelationship	Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen. Für Schnittstellenkarten-Ressourcen ist eine Beziehung zu einer Gerätehalter-Ressource erforderlich, bei der der Containertyp „Slot“ oder „Sub-Slot“ ist. Für Netzwerkschnittstellenressourcen ist eine Beziehung zu einer Ausrüstungs- oder Schnittstellenkartenressource erforderlich. Für Gerätehalter-Ressourcen, bei denen der Containertyp Slot oder Sub-Slot ist, ist eine Beziehung zu einer Geräte- oder Schnittstellenkartenressource erforderlich. Datentyp: Array "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Typ der Beziehung zwischen den beiden Ressourcen im Format [dieser Ressourcendeskriptor]::[zugehöriger Ressourcendeskriptor]. Beispiel: Enthält::Enthalten in gibt an, dass die zugehörige Ressource das untergeordnete Element dieser Ressource ist. Gültige Werte für die Deskriptoren befinden sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] in den Spalten Übergeordneter Deskriptor und Untergeordneter Deskriptor. Datentyp: Zeichenfolge
resourceRelationship.resource	Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein. Schnittstellenkarte Logische Verbindung Netzwerkschnittstelle Netzwerkstandort Physische Verbindung Ausrüstung Gerätehalter Datentyp: Objekt "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id der zugehörigen Ressource. Befindet sich je nach Typ der zugehörigen Ressource in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern Datentyp: Zeichenfolge
resourceRelationship.resource.href	Relativer Link zum zugehörigen Ressourcendatensatz. Datentyp: Zeichenfolge
resourceSpecification	Ressourcenspezifikation. Datentyp: Objekt "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id des zugeordneten Modells für die Ressource. Befindet sich je nach Modelltyp in einer der folgenden Tabellen. Gerätehaltermodelle [sn_ni_core_equipment_holder_product_model] Anlagenmodelle [sn_ni_core_equipment_product_model] Schnittstellenkartenmodelle [sn_ni_core_interface_card_product_model] Logische Verbindungsmodelle [sn_ni_core_logical_connection_product_model] Netzwerkschnittstellenmodelle [sn_ni_core_network_interface_product_model] Physische Verbindungsmodelle [sn_ni_core_physical_connection_product_model] Datentyp: Zeichenfolge
startOperatingDate	Datum und Uhrzeit, zu der die Ressource erstmals in Betrieb genommen wurde. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein angegebener Ressourcendatensatz abgerufen.

curl "https://instance.service-now.com/api/sn_ni_core/resource/915da8e140ddc910f8772175cacd72de" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

Antworttext.

{
   "href": "/api/sn_ni_core/resource/915da8e140ddc910f8772175cacd72de",
   "id": "915da8e140ddc910f8772175cacd72de",
   "name": "DLLSTXMR/ESS7450/IOM-01/MDA-01/NI-01",
   "place": {
      "id": "c23683c54051c910f8772175cacd725c",
      "href": "/api/now/table/cmdb_ci_ni_site/c23683c54051c910f8772175cacd725c",
      "@referredType": "GeographicAddress"
   },
   "resourceCharacteristic": [
      {
         "name": "attested",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "availability",
         "valueType": "string",
         "value": "used"
      },
      {
         "name": "cabled",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "can_print",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "connector_type",
         "valueType": "string",
         "value": "sc"
      },
      {
         "name": "cost_cc",
         "valueType": "string",
         "value": "USD"
      },
      {
         "name": "equipment_clli",
         "valueType": "string",
         "value": "DLLSTXESS01"
      },
      {
         "name": "fault_count",
         "valueType": "integer",
         "value": "0"
      },
      {
         "name": "install_status",
         "valueType": "integer",
         "value": "1"
      },
      {
         "name": "life_cycle_stage",
         "valueType": "reference",
         "value": "Operational"
      },
      {
         "name": "life_cycle_stage_status",
         "valueType": "reference",
         "value": "In Use"
      },
      {
         "name": "manufacturer",
         "valueType": "reference",
         "value": "a2f6a4914055c910f8772175cacd723a"
      },
      {
         "name": "monitor",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "network_domain",
         "valueType": "string",
         "value": "core"
      },
      {
         "name": "ni_type",
         "valueType": "reference",
         "value": "646cf25fe42e0510f877e70ec9bcaca8"
      },
      {
         "name": "port_bandwidth",
         "valueType": "reference",
         "value": "ff39ae92eb900110700ca73bc152286d"
      },
      {
         "name": "replaceable",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "skip_sync",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "telco_equipment",
         "valueType": "reference",
         "value": "583e7b95405dc910f8772175cacd7292"
      },
      {
         "name": "unverified",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "virtual",
         "valueType": "boolean",
         "value": "false"
      }
   ],
   "resourceRelationship": [
      {
         "relationshipType": "Contained by::Contains",
         "resource": {
            "id": "81baac6140ddc910f8772175cacd728e",
            "href": "/api/sn_ni_core/resource/81baac6140ddc910f8772175cacd728e"
         }
      },
      {
         "relationshipType": "Contained by::Contains",
         "resource": {
            "id": "bf624bc640194d10f8772175cacd7225",
            "href": "/api/sn_ni_core/resource/bf624bc640194d10f8772175cacd7225"
         }
      }
   ],
   "resourceSpecification": {
      "id": "980416b0874e8110d28eb259dabb356b",
      "href": "/api/now/table/sn_ni_core_network_inventory_product_model/980416b0874e8110d28eb259dabb356b",
      "@referredType": "NetworkInterfaceModel"
   },
   "@type": "cmdb_ci_ni_interface"
}

Resource Inventory Open API – PATCH /sn_ni_core/resource/{id}

Aktualisiert einen angegebenen Ressourcendatensatz.

URL-Format

Standard-URL: /api/sn_ni_core/resource/{id}

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

Name

Beschreibung

id

Sys_id der Ressource. Befindet sich je nach Ressourcentyp in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] IP-Adresse [cmdb_ci_ip_address] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern. Datentyp: Zeichenfolge

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 21. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
@type	Der Typ der Ressource. Gültige Werte: cmdb_ci_interface_card (Schnittstellenkarte) cmdb_ci_ip_address (IP-Adresse) cmdb_ci_ni_logical_path (Logische Verbindung) cmdb_ci_ni_interface (Netzwerkschnittstelle) cmdb_ci_ni_site (Netzwerk-Site) cmdb_ci_ni_physical_link (Physische Verbindung) Name einer Tabelle, die durch die sys_property sn_ni_core.equipment_tables angegeben wird, oder Name einer Tabelle, die die angegebenen Tabellen erweitert. Name einer Tabelle, die den Gerätehalter [cmdb_ci_equipment_holder] erweitert. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Ressource. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge
Name	Name der Ressource Datentyp: Zeichenfolge
Hinweis	Liste der Notizen zur Ressource. Datentyp: Array "note": [ { "text": "String" } ]
Hinweis.Text	Erforderlich, wenn der Parameter note verwendet wird. Der Hinweistext. Datentyp: Zeichenfolge
Ort	Netzwerkstandort für die Ressource. Dieser Parameter wird für Ressourcen vom Typ „Netzwerkstandort“, „Physische Verbindung“ oder „Logische Verbindung“ nicht unterstützt. Datentyp: Objekt "place": { "@referredType": "String", "href": "String", "id": "String" }
ort.@referredType	Der Typ des Orts. Dieser Wert ist immer GeographicAddress. Datentyp: Zeichenfolge
Ort.href	Relativer Link zum Ortsdatensatz. Datentyp: Zeichenfolge
place.id	Erforderlich, wenn der Parameter place verwendet wird. Sys_id des Ortsdatensatzes in der Tabelle „Netzwerkstandort“ [cmdb_ci_ni_site]. Datentyp: Zeichenfolge
relatedPartei	Details zu Kontakten für die Ressource. Datentyp: Array "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ] Hinweis: Das Entfernen von relatedPartei-Datensätzen aus einer Ressource wird von diesem Endpunkt nicht unterstützt. Datensätze können manuell aus der Teams-Tabelle [cmdb_rel_team] gelöscht werden.
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Befindet sich in der Gruppentabelle [sys_user_group] im Feld Typ. Datentyp: Zeichenfolge
relatedPartei.href	Relativer Link zum Datensatz der zugehörigen Partei. Datentyp: Zeichenfolge
relatedPartei.id	Erforderlich, wenn der Parameter relatedParty verwendet wird. Sys_id des Datensatzes der zugehörigen Partei in der Gruppentabelle [sys_user_group]. Datentyp: Zeichenfolge
relatedPartei.rolle	Die Rolle der zugehörigen Partei. Befindet sich in der Teams-Tabelle [cmdb_rel_team] im Feld Gruppentyp. Datentyp: Zeichenfolge
resourceCharacteristic	Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale. Für physische und logische Verbindungsressourcen ist ein Port A- oder Port Z- Merkmal erforderlich. Wenn der Lebenszyklusphasenstatus der Ressource „In Gebrauch“ lautet, sind sowohl Port A als auch Port Z erforderlich. Für Gerätehalter-Ressourcen ist ein Containertyp- Merkmal erforderlich. Datentyp: Array "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Erforderlich, wenn der Parameter resourceCharacteristic verwendet wird. Feldname aus der Ressourcentabelle, die durch den Parameter @type angegeben wird. Sie können die Felder model_id, name, network_site, operation_notes, operational_status, short_description, start_date oder beliebige sys_-Präfixfelder wie sys_id nicht verwenden. Datentyp: Zeichenfolge
resourceCharacteristic.value	Erforderlich, wenn der Parameter resourceCharacteristic verwendet wird. Der Wert des Merkmals. Datentyp: Zeichenfolge
resourceCharacteristic.valueType	Der Typ des Werts. Gültige Werte: boolean Datum/Uhrzeit schweben integer ph_number Referenz Zeichenfolge Datentyp: Zeichenfolge
resourceRelationship	Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen. Für Schnittstellenkarten-Ressourcen ist eine Beziehung zu einer Gerätehalter-Ressource erforderlich, bei der der Containertyp „Slot“ oder „Sub-Slot“ ist. Für Netzwerkschnittstellenressourcen ist eine Beziehung zu einer Ausrüstungs- oder Schnittstellenkartenressource erforderlich. Für Gerätehalter-Ressourcen, bei denen der Containertyp Slot oder Sub-Slot ist, ist eine Beziehung zu einer Geräte- oder Schnittstellenkartenressource erforderlich. Datentyp: Array "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Erforderlich, wenn der Parameter resourceRelationship verwendet wird. Typ der Beziehung zwischen den beiden Ressourcen im Format [dieser Ressourcendeskriptor]::[zugehöriger Ressourcendeskriptor]. Beispiel: Enthält::Enthalten in gibt an, dass die zugehörige Ressource das untergeordnete Element dieser Ressource ist. Gültige Werte für die Deskriptoren befinden sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] in den Spalten Übergeordneter Deskriptor und Untergeordneter Deskriptor. Datentyp: Zeichenfolge
resourceRelationship.resource	Erforderlich, wenn der Parameter resourceRelationship verwendet wird. Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein. Schnittstellenkarte Logische Verbindung Netzwerkschnittstelle Netzwerkstandort Physische Verbindung Ausrüstung Gerätehalter Datentyp: Objekt "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Erforderlich, wenn der Parameter resourceRelationship verwendet wird. Sys_id der zugehörigen Ressource. Befindet sich je nach Typ der zugehörigen Ressource in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern Datentyp: Zeichenfolge
resourceRelationship.resource.href	Relativer Link zum zugehörigen Ressourcendatensatz. Datentyp: Zeichenfolge
resourceSpecification	Ressourcenspezifikation. Datentyp: Objekt "resourceSpecification": { "id": "String" }
resourceSpecification.id	Erforderlich, wenn der Parameter resourceSpecification verwendet wird. Sys_id des zugeordneten Modells für die Ressource. Befindet sich je nach Modelltyp in einer der folgenden Tabellen. Gerätehaltermodelle [sn_ni_core_equipment_holder_product_model] Anlagenmodelle [sn_ni_core_equipment_product_model] Schnittstellenkartenmodelle [sn_ni_core_interface_card_product_model] Logische Verbindungsmodelle [sn_ni_core_logical_connection_product_model] Netzwerkschnittstellenmodelle [sn_ni_core_network_interface_product_model] Physische Verbindungsmodelle [sn_ni_core_physical_connection_product_model] Datentyp: Zeichenfolge
startOperatingDate	Datum und Uhrzeit, zu der die Ressource erstmals in Betrieb genommen wurde. 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.

Tabelle : 22. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/merge-patch+json.

Tabelle : 23. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.

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.

Tabelle : 24. Statuscodes

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.
415	Der Anforderungstext weist ein nicht unterstütztes Format auf, oder der Content-Type-Anforderungsheader ist falsch festgelegt.

Antworttextparameter (JSON oder XML)

Name	Beschreibung
@type	Der Typ der Ressource. Gültige Werte: cmdb_ci_interface_card (Schnittstellenkarte) cmdb_ci_ip_address (IP-Adresse) cmdb_ci_ni_logical_path (Logische Verbindung) cmdb_ci_ni_interface (Netzwerkschnittstelle) cmdb_ci_ni_site (Netzwerk-Site) cmdb_ci_ni_physical_link (Physische Verbindung) Name einer Tabelle, die durch die sys_property sn_ni_core.equipment_tables angegeben wird, oder Name einer Tabelle, die die angegebenen Tabellen erweitert. Name einer Tabelle, die den Gerätehalter [cmdb_ci_equipment_holder] erweitert. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Ressource. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge
id	Sys_id der Ressource. Befindet sich je nach Ressourcentyp in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] IP-Adresse [cmdb_ci_ip_address] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern. Datentyp: Zeichenfolge
Name	Name der Ressource Datentyp: Zeichenfolge
Hinweis	Liste der Notizen zur Ressource. Datentyp: Array "note": [ { "text": "String" } ]
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
Ort	Netzwerkstandort für die Ressource. Dieser Parameter wird für Ressourcen vom Typ „Netzwerkstandort“, „Physische Verbindung“ oder „Logische Verbindung“ nicht unterstützt. Datentyp: Objekt "place": { "@referredType": "String", "href": "String", "id": "String" }
ort.@referredType	Der Typ des Orts. Dieser Wert ist immer GeographicAddress. Datentyp: Zeichenfolge
Ort.href	Relativer Link zum Ortsdatensatz. Datentyp: Zeichenfolge
place.id	Sys_id des Ortsdatensatzes in der Tabelle „Netzwerkstandort“ [cmdb_ci_ni_site]. Datentyp: Zeichenfolge
relatedPartei	Details zu Kontakten für die Ressource. Datentyp: Array "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Befindet sich in der Gruppentabelle [sys_user_group] im Feld Typ. Datentyp: Zeichenfolge
relatedPartei.href	Relativer Link zum Datensatz der zugehörigen Partei. Datentyp: Zeichenfolge
relatedPartei.id	Sys_id des Datensatzes der zugehörigen Partei in der Gruppentabelle [sys_user_group]. Datentyp: Zeichenfolge
relatedPartei.rolle	Die Rolle der zugehörigen Partei. Befindet sich in der Teams-Tabelle [cmdb_rel_team] im Feld Gruppentyp. Datentyp: Zeichenfolge
resourceCharacteristic	Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale. Für physische und logische Verbindungsressourcen ist ein Port A- oder Port Z- Merkmal erforderlich. Wenn der Lebenszyklusphasenstatus der Ressource „In Gebrauch“ lautet, sind sowohl Port A als auch Port Z erforderlich. Für Gerätehalter-Ressourcen ist ein Containertyp- Merkmal erforderlich. Datentyp: Array "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Feldname aus der Ressourcentabelle, die durch den Parameter @type angegeben wird. Sie können die Felder model_id, name, network_site, operation_notes, operational_status, short_description, start_date oder beliebige sys_-Präfixfelder wie sys_id nicht verwenden. Datentyp: Zeichenfolge
resourceCharacteristic.value	Der Wert des Merkmals. Datentyp: Zeichenfolge
resourceCharacteristic.valueType	Der Typ des Werts. Gültige Werte: boolean Datum/Uhrzeit schweben integer ph_number Referenz Zeichenfolge Datentyp: Zeichenfolge
resourceRelationship	Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen. Für Schnittstellenkarten-Ressourcen ist eine Beziehung zu einer Gerätehalter-Ressource erforderlich, bei der der Containertyp „Slot“ oder „Sub-Slot“ ist. Für Netzwerkschnittstellenressourcen ist eine Beziehung zu einer Ausrüstungs- oder Schnittstellenkartenressource erforderlich. Für Gerätehalter-Ressourcen, bei denen der Containertyp Slot oder Sub-Slot ist, ist eine Beziehung zu einer Geräte- oder Schnittstellenkartenressource erforderlich. Datentyp: Array "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Typ der Beziehung zwischen den beiden Ressourcen im Format [dieser Ressourcendeskriptor]::[zugehöriger Ressourcendeskriptor]. Beispiel: Enthält::Enthalten in gibt an, dass die zugehörige Ressource das untergeordnete Element dieser Ressource ist. Gültige Werte für die Deskriptoren befinden sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] in den Spalten Übergeordneter Deskriptor und Untergeordneter Deskriptor. Datentyp: Zeichenfolge
resourceRelationship.resource	Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein. Schnittstellenkarte Logische Verbindung Netzwerkschnittstelle Netzwerkstandort Physische Verbindung Ausrüstung Gerätehalter Datentyp: Objekt "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id der zugehörigen Ressource. Befindet sich je nach Typ der zugehörigen Ressource in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern Datentyp: Zeichenfolge
resourceRelationship.resource.href	Relativer Link zum zugehörigen Ressourcendatensatz. Datentyp: Zeichenfolge
resourceSpecification	Ressourcenspezifikation. Datentyp: Objekt "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id des zugeordneten Modells für die Ressource. Befindet sich je nach Modelltyp in einer der folgenden Tabellen. Gerätehaltermodelle [sn_ni_core_equipment_holder_product_model] Anlagenmodelle [sn_ni_core_equipment_product_model] Schnittstellenkartenmodelle [sn_ni_core_interface_card_product_model] Logische Verbindungsmodelle [sn_ni_core_logical_connection_product_model] Netzwerkschnittstellenmodelle [sn_ni_core_network_interface_product_model] Physische Verbindungsmodelle [sn_ni_core_physical_connection_product_model] Datentyp: Zeichenfolge
startOperatingDate	Datum und Uhrzeit, zu der die Ressource erstmals in Betrieb genommen wurde. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird der Name einer Ressource aktualisiert.

curl "http://instance.servicenow.com/api/sn_ni_core/resource/583e7b95405dc910f8772175cacd7292" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type: application/merge-patch+json" \
--user 'username':'password' \
--data '{"name": "new name"}'

Antworttext.

{
  "href": "/api/sn_ni_core/resource/583e7b95405dc910f8772175cacd7292",
  "id": "583e7b95405dc910f8772175cacd7292",
  "name": "new name",
  "note": [
    {
      "text": "TECHNICIAN SCHECULED TO BE ONSITE THE WEEK OF APRIL 4, 2022."
    }
  ],
  "place": {
    "id": "c23683c54051c910f8772175cacd725c",
    "href": "/api/now/table/cmdb_ci_ni_site/c23683c54051c910f8772175cacd725c",
    "@referredType": "GeographicAddress"
  },
  "resourceCharacteristic": [
    {
      "name": "alarmable",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "attested",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_hub",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_partitionvlans",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_print",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_route",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "can_switch",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "comments",
      "valueType": "string",
      "value": "ETHERNET SWITCH"
    },
    {
      "name": "cost_cc",
      "valueType": "string",
      "value": "USD"
    },
    {
      "name": "cpu_count",
      "valueType": "integer",
      "value": "1"
    },
    {
      "name": "equipment_clli",
      "valueType": "string",
      "value": "DLLSTXESS01"
    },
    {
      "name": "fault_count",
      "valueType": "integer",
      "value": "0"
    },
    {
      "name": "firmware_manufacturer",
      "valueType": "reference",
      "value": "0c441abbc6112275000025157c651c89"
    },
    {
      "name": "firmware_version",
      "valueType": "string",
      "value": "A09DX887"
    },
    {
      "name": "hardware_status",
      "valueType": "string",
      "value": "installed"
    },
    {
      "name": "install_status",
      "valueType": "integer",
      "value": "1"
    },
    {
      "name": "internet_facing",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "inventory_category",
      "valueType": "string",
      "value": "equipment"
    },
    {
      "name": "last_service_date",
      "valueType": "datetime",
      "value": "2022-02-18T16:36:54.000Z"
    },
    {
      "name": "life_cycle_stage",
      "valueType": "reference",
      "value": "Deploy"
    },
    {
      "name": "life_cycle_stage_status",
      "valueType": "reference",
      "value": "Reserved"
    },
    {
      "name": "managed_by",
      "valueType": "reference",
      "value": "46c9e158a9fe198101d44d0d22cb640d"
    },
    {
      "name": "manufacturer",
      "valueType": "reference",
      "value": "b7e831bdc0a80169015ae101f3c4d6cd"
    },
    {
      "name": "model_number",
      "valueType": "string",
      "value": "7450ESS-1"
    },
    {
      "name": "monitor",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "network_domain",
      "valueType": "string",
      "value": "core"
    },
    {
      "name": "ni_function",
      "valueType": "reference",
      "value": "2d22153940990d10f8772175cacd728b"
    },
    {
      "name": "ni_role",
      "valueType": "reference",
      "value": "c68e3f15405dc910f8772175cacd72f1"
    },
    {
      "name": "ni_type",
      "valueType": "reference",
      "value": "3772e8d54015c910f8772175cacd721c"
    },
    {
      "name": "ram",
      "valueType": "integer",
      "value": "3000"
    },
    {
      "name": "replaceable",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "serial_number",
      "valueType": "string",
      "value": "7894564568225"
    },
    {
      "name": "skip_sync",
      "valueType": "boolean",
      "value": "false"
    },
    {
      "name": "spare",
      "valueType": "boolean",
      "value": "true"
    },
    {
      "name": "template_id",
      "valueType": "reference",
      "value": "49433535e5d28110f877657a33339131"
    },
    {
      "name": "unit_position",
      "valueType": "integer",
      "value": "2"
    },
    {
      "name": "unverified",
      "valueType": "boolean",
      "value": "false"
    }
  ],
  "resourceRelationship": [
    {
      "relationshipType": "Contains::Contained by",
      "resource": {
        "id": "f5d1c429405dc910f8772175cacd723f",
        "href": "/api/sn_ni_core/resource/f5d1c429405dc910f8772175cacd723f"
      }
    },
    {
      "relationshipType": "Contains::Contained by",
      "resource": {
        "id": "d6e100e5405dc910f8772175cacd72e9",
        "href": "/api/sn_ni_core/resource/d6e100e5405dc910f8772175cacd72e9"
      }
    },
    {
      "relationshipType": "Contained by::Contains",
      "resource": {
        "id": "5b10e8154015c910f8772175cacd724d",
        "href": "/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d"
      }
    }
  ],
  "resourceSpecification": {
    "id": "0ae34df1e5528110f877657a33339119",
    "href": "/api/now/table/cmdb_model/0ae34df1e5528110f877657a33339119",
    "@referredType": "EquipmentModel"
  },
  "@type": "cmdb_ci_ni_telco_equipment"
}

Resource Inventory Open API – POST /sn_ni_core/resource

Erstellt einen Ressourcendatensatz.

URL-Format

Standard-URL: /api/sn_ni_core/resource

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 26. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 27. Anforderungstextparameter (JSON)

Name	Beschreibung
@type	Der Typ der Ressource. Gültige Werte: cmdb_ci_interface_card (Schnittstellenkarte) cmdb_ci_ip_address (IP-Adresse) cmdb_ci_ni_logical_path (Logische Verbindung) cmdb_ci_ni_interface (Netzwerkschnittstelle) cmdb_ci_ni_site (Netzwerk-Site) cmdb_ci_ni_physical_link (Physische Verbindung) Name einer Tabelle, die durch die sys_property sn_ni_core.equipment_tables angegeben wird, oder Name einer Tabelle, die die angegebenen Tabellen erweitert. Name einer Tabelle, die den Gerätehalter [cmdb_ci_equipment_holder] erweitert. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Ressource. Datentyp: Zeichenfolge
Name	Erforderlich. Name der Ressource Datentyp: Zeichenfolge
Hinweis	Liste der Notizen zur Ressource. Datentyp: Array "note": [ { "text": "String" } ]
Hinweis.Text	Erforderlich, wenn der Parameter note verwendet wird. Der Hinweistext. Datentyp: Zeichenfolge
Ort	Erforderlich für Ressourcen mit Gerätehalter, bei denen der Containertyp „Käfig“, „Feld“, „Schrank“, „Rack“, „Aufstellung“ oder „Bestandsmodell-Bundle“ ist. Erforderlich für alle Ausrüstungsressourcen. Netzwerkstandort für die Ressource. Dieser Parameter wird für Ressourcen vom Typ „Netzwerkstandort“, „Physische Verbindung“ oder „Logische Verbindung“ nicht unterstützt. Datentyp: Objekt "place": { "@referredType": "String", "href": "String", "id": "String" }
ort.@referredType	Der Typ des Orts. Dieser Wert ist immer GeographicAddress. Datentyp: Zeichenfolge
Ort.href	Relativer Link zum Ortsdatensatz. Datentyp: Zeichenfolge
place.id	Erforderlich, wenn der Parameter place verwendet wird. Sys_id des Ortsdatensatzes in der Tabelle „Netzwerkstandort“ [cmdb_ci_ni_site]. Datentyp: Zeichenfolge
relatedPartei	Details zu Kontakten für die Ressource. Datentyp: Array "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Befindet sich in der Gruppentabelle [sys_user_group] im Feld Typ. Datentyp: Zeichenfolge
relatedPartei.href	Relativer Link zum Datensatz der zugehörigen Partei. Datentyp: Zeichenfolge
relatedPartei.id	Erforderlich, wenn der Parameter relatedParty verwendet wird. Sys_id des Datensatzes der zugehörigen Partei in der Gruppentabelle [sys_user_group]. Datentyp: Zeichenfolge
resourceCharacteristic	Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale. Für physische und logische Verbindungsressourcen ist ein Port A- oder Port Z- Merkmal erforderlich. Wenn der Lebenszyklusphasenstatus der Ressource „In Gebrauch“ lautet, sind sowohl Port A als auch Port Z erforderlich. Für Gerätehalter-Ressourcen ist ein Containertyp- Merkmal erforderlich. Datentyp: Array "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Erforderlich, wenn der Parameter resourceCharacteristic verwendet wird. Feldname aus der Ressourcentabelle, die durch den Parameter @type angegeben wird. Sie können die Felder model_id, name, network_site, operation_notes, operational_status, short_description, start_date oder beliebige sys_-Präfixfelder wie sys_id nicht verwenden. Datentyp: Zeichenfolge
resourceCharacteristic.value	Erforderlich, wenn der Parameter resourceCharacteristic verwendet wird. Der Wert des Merkmals. Datentyp: Zeichenfolge
resourceCharacteristic.valueType	Der Typ des Werts. Gültige Werte: boolean Datum/Uhrzeit schweben integer ph_number Referenz Zeichenfolge Datentyp: Zeichenfolge
resourceRelationship	Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen. Für Schnittstellenkarten-Ressourcen ist eine Beziehung zu einer Gerätehalter-Ressource erforderlich, bei der der Containertyp „Slot“ oder „Sub-Slot“ ist. Für Netzwerkschnittstellenressourcen ist eine Beziehung zu einer Ausrüstungs- oder Schnittstellenkartenressource erforderlich. Für Gerätehalter-Ressourcen, bei denen der Containertyp Slot oder Sub-Slot ist, ist eine Beziehung zu einer Geräte- oder Schnittstellenkartenressource erforderlich. Datentyp: Array "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Erforderlich, wenn der Parameter resourceRelationship verwendet wird. Typ der Beziehung zwischen den beiden Ressourcen im Format [dieser Ressourcendeskriptor]::[zugehöriger Ressourcendeskriptor]. Beispiel: Enthält::Enthalten in gibt an, dass die zugehörige Ressource das untergeordnete Element dieser Ressource ist. Gültige Werte für die Deskriptoren befinden sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] in den Spalten Übergeordneter Deskriptor und Untergeordneter Deskriptor. Datentyp: Zeichenfolge
resourceRelationship.resource	Erforderlich, wenn der Parameter resourceRelationship verwendet wird. Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein. Schnittstellenkarte Logische Verbindung Netzwerkschnittstelle Netzwerkstandort Physische Verbindung Ausrüstung Gerätehalter Datentyp: Objekt "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Erforderlich, wenn der Parameter resourceRelationship verwendet wird. Sys_id der zugehörigen Ressource. Befindet sich je nach Typ der zugehörigen Ressource in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern Datentyp: Zeichenfolge
resourceRelationship.resource.href	Relativer Link zum zugehörigen Ressourcendatensatz. Datentyp: Zeichenfolge
resourceSpecification	Ressourcenspezifikation. Datentyp: Objekt "resourceSpecification": { "id": "String" }
resourceSpecification.id	Erforderlich, wenn der Parameter resourceSpecification verwendet wird. Sys_id des zugeordneten Modells für die Ressource. Befindet sich je nach Modelltyp in einer der folgenden Tabellen. Gerätehaltermodelle [sn_ni_core_equipment_holder_product_model] Anlagenmodelle [sn_ni_core_equipment_product_model] Schnittstellenkartenmodelle [sn_ni_core_interface_card_product_model] Logische Verbindungsmodelle [sn_ni_core_logical_connection_product_model] Netzwerkschnittstellenmodelle [sn_ni_core_network_interface_product_model] Physische Verbindungsmodelle [sn_ni_core_physical_connection_product_model] Datentyp: Zeichenfolge
startOperatingDate	Datum und Uhrzeit, zu der die Ressource erstmals in Betrieb genommen wurde. 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.

Tabelle : 28. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 29. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.
Standort	URL der erstellten Ressource.

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.

Tabelle : 30. Statuscodes

Statuscode	Beschreibung
215	Anforderung zur Verarbeitung erfolgreich erhalten. Die Anforderung wird asynchron abgeschlossen.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
@type	Der Typ der Ressource. Gültige Werte: cmdb_ci_interface_card (Schnittstellenkarte) cmdb_ci_ip_address (IP-Adresse) cmdb_ci_ni_logical_path (Logische Verbindung) cmdb_ci_ni_interface (Netzwerkschnittstelle) cmdb_ci_ni_site (Netzwerk-Site) cmdb_ci_ni_physical_link (Physische Verbindung) Name einer Tabelle, die durch die sys_property sn_ni_core.equipment_tables angegeben wird, oder Name einer Tabelle, die die angegebenen Tabellen erweitert. Name einer Tabelle, die den Gerätehalter [cmdb_ci_equipment_holder] erweitert. Datentyp: Zeichenfolge
Beschreibung	Beschreibung der Ressource. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge
id	Sys_id der Ressource. Befindet sich je nach Ressourcentyp in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] IP-Adresse [cmdb_ci_ip_address] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern. Datentyp: Zeichenfolge
Name	Name der Ressource Datentyp: Zeichenfolge
Hinweis	Liste der Notizen zur Ressource. Datentyp: Array "note": [ { "text": "String" } ]
Hinweis.Text	Der Hinweistext. Datentyp: Zeichenfolge
Ort	Netzwerkstandort für die Ressource. Dieser Parameter wird für Ressourcen vom Typ „Netzwerkstandort“, „Physische Verbindung“ oder „Logische Verbindung“ nicht unterstützt. Datentyp: Objekt "place": { "@referredType": "String", "href": "String", "id": "String" }
ort.@referredType	Der Typ des Orts. Dieser Wert ist immer GeographicAddress. Datentyp: Zeichenfolge
Ort.href	Relativer Link zum Ortsdatensatz. Datentyp: Zeichenfolge
place.id	Sys_id des Ortsdatensatzes in der Tabelle „Netzwerkstandort“ [cmdb_ci_ni_site]. Datentyp: Zeichenfolge
relatedPartei	Details zu Kontakten für die Ressource. Datentyp: Array "relatedParty": [ { "@referredType": "String", "href": "String", "id": "String", "role": "String" } ]
relatedPartei.@referenziertTyp	Der Typ der zugehörigen Partei. Befindet sich in der Gruppentabelle [sys_user_group] im Feld Typ. Datentyp: Zeichenfolge
relatedPartei.href	Relativer Link zum Datensatz der zugehörigen Partei. Datentyp: Zeichenfolge
relatedPartei.id	Sys_id des Datensatzes der zugehörigen Partei in der Gruppentabelle [sys_user_group]. Datentyp: Zeichenfolge
resourceCharacteristic	Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale. Für physische und logische Verbindungsressourcen ist ein Port A- oder Port Z- Merkmal erforderlich. Wenn der Lebenszyklusphasenstatus der Ressource „In Gebrauch“ lautet, sind sowohl Port A als auch Port Z erforderlich. Für Gerätehalter-Ressourcen ist ein Containertyp- Merkmal erforderlich. Datentyp: Array "resourceCharacteristic": [ { "name": "String", "value": "String", "valueType": "String" } ]
resourceCharacteristic.name	Feldname aus der Ressourcentabelle, die durch den Parameter @type angegeben wird. Sie können die Felder model_id, name, network_site, operation_notes, operational_status, short_description, start_date oder beliebige sys_-Präfixfelder wie sys_id nicht verwenden. Datentyp: Zeichenfolge
resourceCharacteristic.value	Der Wert des Merkmals. Datentyp: Zeichenfolge
resourceCharacteristic.valueType	Der Typ des Werts. Gültige Werte: boolean Datum/Uhrzeit schweben integer ph_number Referenz Zeichenfolge Datentyp: Zeichenfolge
resourceRelationship	Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen. Für Schnittstellenkarten-Ressourcen ist eine Beziehung zu einer Gerätehalter-Ressource erforderlich, bei der der Containertyp „Slot“ oder „Sub-Slot“ ist. Für Netzwerkschnittstellenressourcen ist eine Beziehung zu einer Ausrüstungs- oder Schnittstellenkartenressource erforderlich. Für Gerätehalter-Ressourcen, bei denen der Containertyp Slot oder Sub-Slot ist, ist eine Beziehung zu einer Geräte- oder Schnittstellenkartenressource erforderlich. Datentyp: Array "resourceRelationship": [ { "relationshipType": "String", "resource": {Object} } ]
resourceRelationship.relationshipType	Typ der Beziehung zwischen den beiden Ressourcen im Format [dieser Ressourcendeskriptor]::[zugehöriger Ressourcendeskriptor]. Beispiel: Enthält::Enthalten in gibt an, dass die zugehörige Ressource das untergeordnete Element dieser Ressource ist. Gültige Werte für die Deskriptoren befinden sich in der Tabelle „CI-Beziehungstyp“ [cmdb_rel_type] in den Spalten Übergeordneter Deskriptor und Untergeordneter Deskriptor. Datentyp: Zeichenfolge
resourceRelationship.resource	Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein. Schnittstellenkarte Logische Verbindung Netzwerkschnittstelle Netzwerkstandort Physische Verbindung Ausrüstung Gerätehalter Datentyp: Objekt "resource": { "id": "String", "href": "String" }
resourceRelationship.resource.id	Sys_id der zugehörigen Ressource. Befindet sich je nach Typ der zugehörigen Ressource in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern Datentyp: Zeichenfolge
resourceRelationship.resource.href	Relativer Link zum zugehörigen Ressourcendatensatz. Datentyp: Zeichenfolge
resourceSpecification	Ressourcenspezifikation. Datentyp: Objekt "resourceSpecification": { "id": "String" }
resourceSpecification.id	Sys_id des zugeordneten Modells für die Ressource. Befindet sich je nach Modelltyp in einer der folgenden Tabellen. Gerätehaltermodelle [sn_ni_core_equipment_holder_product_model] Anlagenmodelle [sn_ni_core_equipment_product_model] Schnittstellenkartenmodelle [sn_ni_core_interface_card_product_model] Logische Verbindungsmodelle [sn_ni_core_logical_connection_product_model] Netzwerkschnittstellenmodelle [sn_ni_core_network_interface_product_model] Physische Verbindungsmodelle [sn_ni_core_physical_connection_product_model] Datentyp: Zeichenfolge
startOperatingDate	Datum und Uhrzeit, zu der die Ressource erstmals in Betrieb genommen wurde. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Netzwerkstandort in Denver, CO, erstellt.

curl "https://instance.service-now.com/api/sn_ni_core/resource" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"DENVER CO CO/HUB\",
  \"note\": [
    {
      \"text\": \"Cisco maintenance team onsite June 22, 2022.\"
    }
  ],
  \"resourceCharacteristic\": [
    {
      \"name\": \"attested\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"can_print\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"clli_code\",
      \"valueType\": \"string\",
      \"value\": \"DNVRCOMR02T\"
    },
    {
      \"name\": \"comments\",
      \"valueType\": \"string\",
      \"value\": \"Site is scheduled for diesel generator test July 13, 2022 at 9am CST.\"
    },
    {
      \"name\": \"cost_cc\",
      \"valueType\": \"string\",
      \"value\": \"USD\"
    },
    {
      \"name\": \"county\",
      \"valueType\": \"string\",
      \"value\": \"DENVER\"
    },
    {
      \"name\": \"data_center_code\",
      \"valueType\": \"string\",
      \"value\": \"DNVR00564\"
    },
    {
      \"name\": \"fault_count\",
      \"valueType\": \"integer\",
      \"value\": \"0\"
    },
    {
      \"name\": \"install_status\",
      \"valueType\": \"integer\",
      \"value\": \"1\"
    },
    {
      \"name\": \"life_cycle_stage\",
      \"valueType\": \"reference\",
      \"value\": \"Operational\"
    },
    {
      \"name\": \"life_cycle_stage_status\",
      \"valueType\": \"reference\",
      \"value\": \"In Use\"
    },
    {
      \"name\": \"location\",
      \"valueType\": \"reference\",
      \"value\": \"25ab8f300a0a0bb300d99f69c3ac24cd\"
    },
    {
      \"name\": \"managed_by\",
      \"valueType\": \"reference\",
      \"value\": \"b0f31e5673500010c2e7660c4cf6a711\"
    },
    {
      \"name\": \"monitor\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"network_domain\",
      \"valueType\": \"string\",
      \"value\": \"core\"
    },
    {
      \"name\": \"ni_type\",
      \"valueType\": \"reference\",
      \"value\": \"8e8f3770404d0110f8772175cacd7204\"
    },
    {
      \"name\": \"pots_number\",
      \"valueType\": \"ph_number\",
      \"value\": \"[phone]\"
    },
    {
      \"name\": \"skip_sync\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"third_party_ownership\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    },
    {
      \"name\": \"unverified\",
      \"valueType\": \"boolean\",
      \"value\": \"false\"
    }
  ],
  \"resourceRelationship\": [
    {
      \"relationshipType\": \"Connects to::Connected by\",
      \"resource\": {
        \"id\": \"e6f6df8d4051c910f8772175cacd72b2\",
        \"href\": \"/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2\"
      }
    },
    {
      \"relationshipType\": \"Connects to::Connected by\",
      \"resource\": {
        \"id\": \"0ac19bc54051c910f8772175cacd724b\",
        \"href\": \"/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b\"
      }
    },
    {
      \"relationshipType\": \"Connects to::Connected by\",
      \"resource\": {
        \"id\": \"997e5c11875851109a9c0f65dabb35ac\",
        \"href\": \"/api/sn_ni_core/resource/997e5c11875851109a9c0f65dabb35ac\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"5b10e8154015c910f8772175cacd724d\",
        \"href\": \"/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"57e73b51405dc910f8772175cacd726e\",
        \"href\": \"/api/sn_ni_core/resource/57e73b51405dc910f8772175cacd726e\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"bf58f751405dc910f8772175cacd72e8\",
        \"href\": \"/api/sn_ni_core/resource/bf58f751405dc910f8772175cacd72e8\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"b5711e31405d0d10f8772175cacd7232\",
        \"href\": \"/api/sn_ni_core/resource/b5711e31405d0d10f8772175cacd7232\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"ed811e31405d0d10f8772175cacd72d3\",
        \"href\": \"/api/sn_ni_core/resource/ed811e31405d0d10f8772175cacd72d3\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"d74937d1405dc910f8772175cacd7288\",
        \"href\": \"/api/sn_ni_core/resource/d74937d1405dc910f8772175cacd7288\"
      }
    },
    {
      \"relationshipType\": \"Contains::Contained by\",
      \"resource\": {
        \"id\": \"da0df2e3e4e64510f877e70ec9bcacc6\",
        \"href\": \"/api/sn_ni_core/resource/da0df2e3e4e64510f877e70ec9bcacc6\"
      }
    }
  ],
  \"@type\": \"cmdb_ci_ni_site\"
}" \
--user 'username':'password'

Antworttext.

{
   "href": "/api/sn_ni_core/resource/00399f0aed349150f877305f29f832b2",
   "id": "00399f0aed349150f877305f29f832b2",
   "name": "DENVER CO CO/HUB",
   "note": [
      {
         "text": "Cisco maintenance team onsite June 22, 2022."
      }
   ],
   "resourceCharacteristic": [
      {
         "name": "altitude_units",
         "valueType": "string",
         "value": "feet"
      },
      {
         "name": "attestation_status",
         "valueType": "string",
         "value": "Not Yet Reviewed"
      },
      {
         "name": "attested",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "can_print",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "clli_code",
         "valueType": "string",
         "value": "DNVRCOMR02T"
      },
      {
         "name": "comments",
         "valueType": "string",
         "value": "Site is scheduled for diesel generator test July 13, 2022 at 9am CST."
      },
      {
         "name": "cost_cc",
         "valueType": "string",
         "value": "USD"
      },
      {
         "name": "county",
         "valueType": "string",
         "value": "DENVER"
      },
      {
         "name": "data_center_code",
         "valueType": "string",
         "value": "DNVR00564"
      },
      {
         "name": "discovery_source",
         "valueType": "string",
         "value": "Resource Inventory Open API"
      },
      {
         "name": "fault_count",
         "valueType": "integer",
         "value": "0"
      },
      {
         "name": "first_discovered",
         "valueType": "datetime",
         "value": "2022-07-21T19:38:04.000Z"
      },
      {
         "name": "install_status",
         "valueType": "integer",
         "value": "1"
      },
      {
         "name": "last_discovered",
         "valueType": "datetime",
         "value": "2022-07-21T19:38:04.000Z"
      },
      {
         "name": "life_cycle_stage",
         "valueType": "reference",
         "value": "Operational"
      },
      {
         "name": "life_cycle_stage_status",
         "valueType": "reference",
         "value": "In Use"
      },
      {
         "name": "location",
         "valueType": "reference",
         "value": "25ab8f300a0a0bb300d99f69c3ac24cd"
      },
      {
         "name": "managed_by",
         "valueType": "reference",
         "value": "b0f31e5673500010c2e7660c4cf6a711"
      },
      {
         "name": "monitor",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "network_domain",
         "valueType": "string",
         "value": "core"
      },
      {
         "name": "ni_type",
         "valueType": "reference",
         "value": "8e8f3770404d0110f8772175cacd7204"
      },
      {
         "name": "pots_number",
         "valueType": "ph_number",
         "value": "[phone]"
      },
      {
         "name": "skip_sync",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "third_party_ownership",
         "valueType": "boolean",
         "value": "false"
      },
      {
         "name": "unverified",
         "valueType": "boolean",
         "value": "false"
      }
   ],
   "resourceRelationship": [
      {
         "relationshipType": "Connects to::Connected by",
         "resource": {
            "id": "e6f6df8d4051c910f8772175cacd72b2",
            "href": "/api/sn_ni_core/resource/e6f6df8d4051c910f8772175cacd72b2"
         }
      },
      {
         "relationshipType": "Connects to::Connected by",
         "resource": {
            "id": "0ac19bc54051c910f8772175cacd724b",
            "href": "/api/sn_ni_core/resource/0ac19bc54051c910f8772175cacd724b"
         }
      },
      {
         "relationshipType": "Connects to::Connected by",
         "resource": {
            "id": "997e5c11875851109a9c0f65dabb35ac",
            "href": "/api/sn_ni_core/resource/997e5c11875851109a9c0f65dabb35ac"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "5b10e8154015c910f8772175cacd724d",
            "href": "/api/sn_ni_core/resource/5b10e8154015c910f8772175cacd724d"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "57e73b51405dc910f8772175cacd726e",
            "href": "/api/sn_ni_core/resource/57e73b51405dc910f8772175cacd726e"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "bf58f751405dc910f8772175cacd72e8",
            "href": "/api/sn_ni_core/resource/bf58f751405dc910f8772175cacd72e8"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "b5711e31405d0d10f8772175cacd7232",
            "href": "/api/sn_ni_core/resource/b5711e31405d0d10f8772175cacd7232"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "ed811e31405d0d10f8772175cacd72d3",
            "href": "/api/sn_ni_core/resource/ed811e31405d0d10f8772175cacd72d3"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "d74937d1405dc910f8772175cacd7288",
            "href": "/api/sn_ni_core/resource/d74937d1405dc910f8772175cacd7288"
         }
      },
      {
         "relationshipType": "Contains::Contained by",
         "resource": {
            "id": "da0df2e3e4e64510f877e70ec9bcacc6",
            "href": "/api/sn_ni_core/resource/da0df2e3e4e64510f877e70ec9bcacc6"
         }
      }
   ],
   "@type": "cmdb_ci_ni_site"
}

Resource Inventory Open API – POST /sn_ni_core/resourceinventoryviatemplate

Erstellt ein Ressourcenkonfigurationselement (CI) und die zugehörige CI-Hierarchie basierend auf einer Vorlage.

Bevor Sie diesen Endpunkt aufrufen, müssen Sie eine Bestandsvorlage in der Tabelle „Bestandsvorlage“ [sn_ni_core_inventory_template] erstellen. Sie können die gesamte Hierarchie zugehöriger CIs in einer Bestandsvorlage definieren. Sie können dann alle CIs und Beziehungen über eine einzige API-Anforderung erstellen.

URL-Format

Standard-URL: /api/sn_ni_core/resourceinventoryviatemplate

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 32. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 33. Anforderungstextparameter (JSON)

Name	Beschreibung
overrides	Liste der zu überschreibenden Spalten und der zu verwendenden Werte. Datentyp: Objekt "overrides": { "column_name": "String" }
overrides.column_name	Erforderlich, wenn der Parameter overrides verwendet wird. Name und Wert der Spalte. Datentyp: Zeichenfolge
parentId	Erforderlich. Sys_id des übergeordneten CI. Befindet sich je nach Typ des übergeordneten CI in einer der folgenden Tabellen. Schnittstellenkarte [cmdb_ci_interface_card] IP-Adresse [cmdb_ci_ip_address] Logische Verbindung [cmdb_ci_ni_logical_path] Netzwerkschnittstelle [cmdb_ci_ni_interface] Netzwerkstandort [cmdb_ci_ni_site] Physische Verbindung [cmdb_ci_ni_physical_link] Tabellen, die durch die sys_property sn_ni_core.equipment_tables angegeben werden, und alle Tabellen, die die angegebenen Tabellen erweitern. Tabellen, die den Gerätehalter [cmdb_ci_equipment_holder] erweitern. Datentyp: Zeichenfolge
templateId	Erforderlich. Sys_id der Vorlage. Befindet sich in der Tabelle „Bestandsvorlage“ [sn_ni_core_inventory_template]. Datentyp: Zeichenfolge
templateOverrides	Liste der Vorlagenüberschreibungen. Datentyp: Array "templateOverrides": [ { "overrideTemplateId": "String", "templateId": "String" } ]
templateOverrides.overrideTemplateId	Erforderlich, wenn der Parameter templateOverrides verwendet wird. Verfügbare Vorlagen-sys_id. Datentyp: Zeichenfolge
templateOverrides.templateId	Erforderlich, wenn der Parameter templateOverrides verwendet wird. sys_id der zugehörigen Vorlage. 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.

Tabelle : 34. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 35. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.
Standort	URL des erstellten CI oben in der Hierarchie.

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.

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
201	Ressource erstellt.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
401	Nicht autorisiert. Die Anmeldeinformationen sind falsch oder wurden nicht übergeben.
500	Fehler. Bei der Anforderung ist ein Fehler aufgetreten. Beispiel: Die Anforderung hat die Validierungsprüfungen nicht bestanden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Ergebnis	Ergebnisobjekt mit Informationen zu den erstellten CIs. Datentyp: Objekt "result": { "sys_id": "String" }
result.sys_id	Sys_id des erstellten CI an der Spitze der Hierarchie. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird mithilfe einer Vorlage eine CI-Hierarchie erstellt.

curl "https://instance.service-now.com/api/sn_ni_core/resourceinventoryviatemplate" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "templateId": "90475711ed6ec110f877d2f57b8accda",
   "parentId": "917dd8f6870e851079c40f2d0ebb353d",
   "overrides": {
      "equipment_clli": "test"
   },
   "templateOverrides": [
      {
         "templateId": "ac3b679ded6ec110f877d2f57b8acc29",
         "overrideTemplateId": "f9604efb54e18110f87749bbc4ad38d8"
      },
      {
         "templateId": "171c23dded6ec110f877d2f57b8acc33",
         "overrideTemplateId": "0f38e59187424110e14f64e73cbb35b4"
      }
   ]
}" \
--user 'username':'password'

Antworttext.

"result": {
   "sys_id": "00598f0aed346259f388105f29f892c4"
}