Ressourcenbestand – API öffnen

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 37 Minuten Lesedauer
  • Die Ressourcenbestand Offen Die API stellt Endpunkte zum Erstellen, Abrufen und Löschen von Ressourcen bereit.

    Verwenden Sie diese API, um Ressourcen in den folgenden Tabellen zu verwalten.
    • Kabel [cmdb_ci_cable]
    • Gerätehalter [cmdb_ci_Equipment_Holder]
    • 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]
    • Litze [cmdb_ci_Strand]
    • Topologie [cmdb_ci_Topology]
    • Tabellen, die von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_holder].
    • Untergeordnete Tabellen, die eine der folgenden Tabellen erweitern:
      • Kabel [cmdb_ci_cable]
      • Gerätehalter [cmdb_ci_Equipment_Holder]
      • Litze [cmdb_ci_Strand]

    Diese API ist in der Anwendung „Network Inventory Core“ enthalten, die auf verfügbar ist ServiceNow Store.

    Diese API wird in bereitgestellt sn_ni_Core Namespace.

    Der aufrufende Anwender muss über die Rolle sn_ni_core.inventory_integrator verfügen.

    Diese API kann erweitert werden, um Anpassungen an erforderlichen Parametern, die Validierung des Anforderungstexts und Feldzuordnungen vorzunehmen. Weitere Informationen finden Sie im Abschnitt Ressourcenbestand – Entwicklerleitfaden für offene API.

    Die Ressourcenbestand Offen API ist ein ServiceNow® Implementierung der REST-Spezifikation der TM-Forum-Ressourcenbestand-API. Diese Implementierung basiert auf TMF639 – API-Anwenderhandbuch für Ressourcenbestand v4.0.1 , Juli 2020.

    Ressourcenbestand – API öffnen – /sn_ni_Core/resource/{ID} LÖSCHEN

    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 Typ der 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 von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_holder].
    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. Anforderungstext-Parameter (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
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt 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 REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    215 Anforderung zur Verarbeitung erfolgreich empfangen. 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.

    ""

    Ressourcenbestand – API öffnen – 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 Typ von Ressource abrufen.
    Gültige Werte:
    • cmdb_ci_cable (Kabel)
    • 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 (Netzwerkstandort)
    • cmdb_ci_ni_physischer_Link (Physische Verbindung)
    • cmdb_ci_Strand (Litze)
    • cmdb_ci_Topology (Topologie)
    • Name einer Tabelle, die von angegeben wird sn_ni_core.equipment_tablessys_property oder Name einer Tabelle, die die angegebenen Tabellen erweitert.
    • Name einer Tabelle, die den Gerätehalter erweitert [cmdb_ci_Equipment_holder].

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung, die zum Filtern von Ressourcen verwendet werden soll. Nur Ressourcen mit der angegebenen Beschreibung werden in der Antwort 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
    • note
    • Ort
    • Zugehörige Partei
    • ResourceMerkmal
    • ResourceRelationship
    • ResourceSpecification
    • StartOperatingDate

    Datentyp: Zeichenfolge

    Standard: Gibt alle Felder zurück.

    limit Maximale Anzahl der zurückzugebenden Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs.

    Standard: 20

    Datentyp: Zahl

    name Name, der zum Filtern von Ressourcen verwendet werden soll. Nur Ressourcen mit dem angegebenen Namen werden in der Antwort 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. Anforderungstext-Parameter (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 Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird.

    Beispiel: Wenn Offset=2 Und Grenzwert = 3 , Der Wert von Content-RangeHeader ist Elemente 3-5 .

    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt 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 REST API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    206 Teilinhalt. Die Anforderung wurde erfolgreich verarbeitet und hat einen Teilbereich von Inhalten zurückgegeben, der von einem 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 Typ der Ressource.
    Gültige Werte:
    • cmdb_ci_cable (Kabel)
    • 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 (Netzwerkstandort)
    • cmdb_ci_ni_physischer_Link (Physische Verbindung)
    • cmdb_ci_Strand (Litze)
    • cmdb_ci_Topology (Topologie)
    • Name einer Tabelle, die von angegeben wird sn_ni_core.equipment_tablessys_property oder Name einer Tabelle, die die angegebenen Tabellen erweitert.
    • Name einer Tabelle, die den Gerätehalter erweitert [cmdb_ci_Equipment_holder].

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung der Ressource.

    Datentyp: Zeichenfolge

    href Relativer Link zum Ressourcendatensatz.

    Datentyp: Zeichenfolge

    id SYS_ID der Ressource. Befindet sich je nach Typ der Ressource in einer der folgenden Tabellen.
    • Kabel [cmdb_ci_cable]
    • Gerätehalter [cmdb_ci_Equipment_Holder]
    • 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]
    • Litze [cmdb_ci_Strand]
    • Topologie [cmdb_ci_Topology]
    • Tabellen, die von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_holder].
    • Untergeordnete Tabellen, die eine der folgenden Tabellen erweitern:
      • Kabel [cmdb_ci_cable]
      • Gerätehalter [cmdb_ci_Equipment_Holder]
      • Litze [cmdb_ci_Strand]

    Datentyp: Zeichenfolge

    name
    Name der Ressource

    Datentyp: Zeichenfolge

    note Liste der Notizen zur Ressource.

    Datentyp: Array von Objekten

    "note": [
       {
          "text": "String"
       }
    ]
    Hinweis.Text
    Der Hinweistext.

    Datentyp: Zeichenfolge

    Ort
    Netzwerkstandort für die Ressource.

    Dieser Parameter wird für Ressourcen „Netzwerkstandort“, „physische Verbindung“ oder „logische Verbindung“ nicht unterstützt.

    Datentyp: Objekt

    "place": {
       "@referredType": "String",
       "href": "String",
       "id": "String"
    }
    Place.@referredType Typ des Orts. Dieser Wert ist immer GeographicAddress .

    Datentyp: Zeichenfolge

    Ort.href Relativer Link zum Ortsdatensatz.

    Datentyp: Zeichenfolge

    place.id
    SYS_ID des Ortsdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Netzwerkstandort [cmdb_ci_ni_Site]

    Zugehörige Partei
    RelatedParty.@referredType Typ der zugehörigen Partei. Befindet sich in der in Typ Feld.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Typ“ der Tabelle „Gruppe“ [sys_user_Group].

    ZugehörigPartei.href Relativer Link zum Datensatz der zugehörigen Partei.

    Datentyp: Zeichenfolge

    relatedParty.id
    SYS_ID des Datensatzes der zugehörigen Partei.

    Datentyp: Zeichenfolge

    Tabelle: Gruppe [sys_user_group]

    ZugehörigPartei.Rolle Rolle der zugehörigen Partei.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld Gruppentyp der Tabelle Teams [cmdb_rel_Team].

    ResourceMerkmal Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale.
    • Für Ressourcen für physische Verbindungen und logische Verbindungen: A Port A Oder Port Z Merkmal ist erforderlich. Wenn der Status der Lebenszyklusphase der Ressource „in Gebrauch“ lautet, beides Port A Und Port Z Sind erforderlich.
    • Für Gerätehalterressourcen: A Containertyp Merkmal ist erforderlich.

    Datentyp: Array von Objekten

    "resourceCharacteristic": [
       {
          "name": "String",
          "value": "String",
          "valueType": "String"
       }
    ]
    resourceCharacteristic.name
    Feldname aus der von angegebenen Ressourcentabelle @typeParameter. Sie können die Felder model_ID, Name, Network_Site, Operation_Notes, Operational_Status, nicht verwenden. Short_description, Start_date oder beliebige sys_-Präfixfelder wie sys_ID

    Datentyp: Zeichenfolge

    RessourcenMerkmal.Wert
    Der Wert des Merkmals.

    Datentyp: Zeichenfolge

    RessourcenMerkmal.WertTyp Typ des Werts.
    Gültige Werte:
    • boolean
    • Datum/Uhrzeit
    • Gleitkommazahl
    • Ganzzahl
    • ph_number
    • Referenz
    • Zeichenfolge

    Datentyp: Zeichenfolge

    ResourceRelationship Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen.
    • Für Schnittstellenkartenressourcen ist eine Beziehung zu einer Gerätehalterressource erforderlich, bei der der Containertyp „Slot“ oder „Sub Slot“ ist.
    • Für Netzwerkschnittstellen-Ressourcen ist eine Beziehung zu einem Gerät oder einer Schnittstellenkartenressource erforderlich.
    • Für Gerätehalterressourcen, 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}
      }
    ]
    ResourceBeziehung.Beziehungstyp
    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] im Übergeordneter Deskriptor Und Untergeordneter Deskriptor Spalten.

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource
    Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein.
    • Kabel
    • Ausrüstung
    • Gerätehalter
    • Schnittstellenkarte
    • Logische Verbindung
    • Netzwerkschnittstelle
    • Netzwerkstandort
    • Physische Verbindung
    • Litze
    • Topologie

    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 von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_Holder]

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource.href Relativer Link zum zugehörigen Ressourcendatensatz.

    Datentyp: Zeichenfolge

    ResourceSpecification Ressourcenspezifikation.

    Datentyp: Objekt

    "resourceSpecification": {
       "id": "String"
    }
    Ressourcenspezifikation.ID
    SYS_ID des zugeordneten Modells für die Ressource. Befindet sich je nach Modelltyp in einer der folgenden Tabellen.
    • Kabelmodelle [sn_ent_cable_model]
    • Gerätehaltermodelle [sn_ent_nw_holder_model]
    • Anlagenmodelle [sn_ent_nw_Equipment_model]
    • Schnittstellenkartenmodelle [sn_ent_nw_Interface_model]
    • Logische Verbindungsmodelle [sn_ent_logical_nw_connection_model]
    • Netzwerkschnittstellenmodelle [sn_ent_nw_Interface_model]
    • Physische Verbindungsmodelle [sn_ent_physical_nw_connection_model]
    • Litzenmodelle [sn_ent_Strand_model]
    • Topologiemodelle [sn_ent_Network_Topology_model]

    Datentyp: Zeichenfolge

    StartOperatingDate Datum und Uhrzeit, zu der die Ressource den Betrieb erstmals aufgenommen hat.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel wird abgerufen name, id, Und hrefFelder für die ersten fünf Ressourcendatensätze des Netzwerkstandorts.

    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"
       }
    ]

    Ressourcenbestand – API öffnen – 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 Typ der Ressource in einer der folgenden Tabellen.
    • Kabel [cmdb_ci_cable]
    • Gerätehalter [cmdb_ci_Equipment_Holder]
    • 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]
    • Litze [cmdb_ci_Strand]
    • Topologie [cmdb_ci_Topology]
    • Tabellen, die von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_holder].
    • Untergeordnete Tabellen, die eine der folgenden Tabellen erweitern:
      • Kabel [cmdb_ci_cable]
      • Gerätehalter [cmdb_ci_Equipment_Holder]
      • Litze [cmdb_ci_Strand]

    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
    • note
    • Ort
    • Zugehörige Partei
    • ResourceMerkmal
    • ResourceRelationship
    • ResourceSpecification
    • StartOperatingDate

    Datentyp: Zeichenfolge

    Standard: Gibt alle Felder zurück.

    Tabelle : 15. Anforderungstext-Parameter (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
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt 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 REST API-HTTP-Antwortcodes .

    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 Typ der Ressource.
    Gültige Werte:
    • cmdb_ci_cable (Kabel)
    • 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 (Netzwerkstandort)
    • cmdb_ci_ni_physischer_Link (Physische Verbindung)
    • cmdb_ci_Strand (Litze)
    • cmdb_ci_Topology (Topologie)
    • Name einer Tabelle, die von angegeben wird sn_ni_core.equipment_tablessys_property oder Name einer Tabelle, die die angegebenen Tabellen erweitert.
    • Name einer Tabelle, die den Gerätehalter erweitert [cmdb_ci_Equipment_holder].

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung der Ressource.

    Datentyp: Zeichenfolge

    href Relativer Link zum Ressourcendatensatz.

    Datentyp: Zeichenfolge

    id SYS_ID der Ressource. Befindet sich je nach Typ der Ressource in einer der folgenden Tabellen.
    • Kabel [cmdb_ci_cable]
    • Gerätehalter [cmdb_ci_Equipment_Holder]
    • 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]
    • Litze [cmdb_ci_Strand]
    • Topologie [cmdb_ci_Topology]
    • Tabellen, die von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_holder].
    • Untergeordnete Tabellen, die eine der folgenden Tabellen erweitern:
      • Kabel [cmdb_ci_cable]
      • Gerätehalter [cmdb_ci_Equipment_Holder]
      • Litze [cmdb_ci_Strand]

    Datentyp: Zeichenfolge

    name
    Name der Ressource

    Datentyp: Zeichenfolge

    note Liste der Notizen zur Ressource.

    Datentyp: Array von Objekten

    "note": [
       {
          "text": "String"
       }
    ]
    Hinweis.Text
    Der Hinweistext.

    Datentyp: Zeichenfolge

    Ort
    Netzwerkstandort für die Ressource.

    Dieser Parameter wird für Ressourcen „Netzwerkstandort“, „physische Verbindung“ oder „logische Verbindung“ nicht unterstützt.

    Datentyp: Objekt

    "place": {
       "@referredType": "String",
       "href": "String",
       "id": "String"
    }
    Place.@referredType Typ des Orts. Dieser Wert ist immer GeographicAddress .

    Datentyp: Zeichenfolge

    Ort.href Relativer Link zum Ortsdatensatz.

    Datentyp: Zeichenfolge

    place.id
    SYS_ID des Ortsdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Netzwerkstandort [cmdb_ci_ni_Site]

    Zugehörige Partei
    RelatedParty.@referredType Typ der zugehörigen Partei. Befindet sich in der in Typ Feld.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Typ“ der Tabelle „Gruppe“ [sys_user_Group].

    ZugehörigPartei.href Relativer Link zum Datensatz der zugehörigen Partei.

    Datentyp: Zeichenfolge

    relatedParty.id
    SYS_ID des Datensatzes der zugehörigen Partei.

    Datentyp: Zeichenfolge

    Tabelle: Gruppe [sys_user_group]

    ResourceMerkmal Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale.
    • Für Ressourcen für physische Verbindungen und logische Verbindungen: A Port A Oder Port Z Merkmal ist erforderlich. Wenn der Status der Lebenszyklusphase der Ressource „in Gebrauch“ lautet, beides Port A Und Port Z Sind erforderlich.
    • Für Gerätehalterressourcen: A Containertyp Merkmal ist erforderlich.

    Datentyp: Array von Objekten

    "resourceCharacteristic": [
       {
          "name": "String",
          "value": "String",
          "valueType": "String"
       }
    ]
    resourceCharacteristic.name
    Feldname aus der von angegebenen Ressourcentabelle @typeParameter. Sie können die Felder model_ID, Name, Network_Site, Operation_Notes, Operational_Status, nicht verwenden. Short_description, Start_date oder beliebige sys_-Präfixfelder wie sys_ID

    Datentyp: Zeichenfolge

    RessourcenMerkmal.Wert
    Der Wert des Merkmals.

    Datentyp: Zeichenfolge

    RessourcenMerkmal.WertTyp Typ des Werts.
    Gültige Werte:
    • boolean
    • Datum/Uhrzeit
    • Gleitkommazahl
    • Ganzzahl
    • ph_number
    • Referenz
    • Zeichenfolge

    Datentyp: Zeichenfolge

    ResourceRelationship Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen.
    • Für Schnittstellenkartenressourcen ist eine Beziehung zu einer Gerätehalterressource erforderlich, bei der der Containertyp „Slot“ oder „Sub Slot“ ist.
    • Für Netzwerkschnittstellen-Ressourcen ist eine Beziehung zu einem Gerät oder einer Schnittstellenkartenressource erforderlich.
    • Für Gerätehalterressourcen, 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}
      }
    ]
    ResourceBeziehung.Beziehungstyp
    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] im Übergeordneter Deskriptor Und Untergeordneter Deskriptor Spalten.

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource
    Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein.
    • Kabel
    • Ausrüstung
    • Gerätehalter
    • Schnittstellenkarte
    • Logische Verbindung
    • Netzwerkschnittstelle
    • Netzwerkstandort
    • Physische Verbindung
    • Litze
    • Topologie

    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 von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_Holder]

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource.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.
    • Kabelmodelle [sn_ent_cable_model]
    • Gerätehaltermodelle [sn_ent_nw_holder_model]
    • Anlagenmodelle [sn_ent_nw_Equipment_model]
    • Schnittstellenkartenmodelle [sn_ent_nw_Interface_model]
    • Logische Verbindungsmodelle [sn_ent_logical_nw_connection_model]
    • Netzwerkschnittstellenmodelle [sn_ent_nw_Interface_model]
    • Physische Verbindungsmodelle [sn_ent_physical_nw_connection_model]
    • Litzenmodelle [sn_ent_Strand_model]
    • Topologiemodelle [sn_ent_Network_Topology_model]

    Datentyp: Zeichenfolge

    StartOperatingDate Datum und Uhrzeit, zu der die Ressource den Betrieb erstmals aufgenommen hat.

    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"
    }

    Ressourcenbestand – API öffnen – 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 Typ der Ressource in einer der folgenden Tabellen.
    • Kabel [cmdb_ci_cable]
    • Gerätehalter [cmdb_ci_Equipment_Holder]
    • 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]
    • Litze [cmdb_ci_Strand]
    • Topologie [cmdb_ci_Topology]
    • Tabellen, die von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_holder].
    • Untergeordnete Tabellen, die eine der folgenden Tabellen erweitern:
      • Kabel [cmdb_ci_cable]
      • Gerätehalter [cmdb_ci_Equipment_Holder]
      • Litze [cmdb_ci_Strand]

    Datentyp: Zeichenfolge

    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    @TYPE Typ der Ressource.
    Gültige Werte:
    • cmdb_ci_cable (Kabel)
    • 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 (Netzwerkstandort)
    • cmdb_ci_ni_physischer_Link (Physische Verbindung)
    • cmdb_ci_Strand (Litze)
    • cmdb_ci_Topology (Topologie)
    • Name einer Tabelle, die von angegeben wird sn_ni_core.equipment_tablessys_property oder Name einer Tabelle, die die angegebenen Tabellen erweitert.
    • Name einer Tabelle, die den Gerätehalter erweitert [cmdb_ci_Equipment_holder].

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung der Ressource.

    Datentyp: Zeichenfolge

    href Relativer Link zum Ressourcendatensatz.

    Datentyp: Zeichenfolge

    name
    Name der Ressource

    Datentyp: Zeichenfolge

    note Liste der Notizen zur Ressource.

    Datentyp: Array von Objekten

    "note": [
       {
          "text": "String"
       }
    ]
    Hinweis.Text Erforderlich, wenn noteParameter wird verwendet.
    Der Hinweistext.

    Datentyp: Zeichenfolge

    Ort
    Netzwerkstandort für die Ressource.

    Dieser Parameter wird für Ressourcen „Netzwerkstandort“, „physische Verbindung“ oder „logische Verbindung“ nicht unterstützt.

    Datentyp: Objekt

    "place": {
       "@referredType": "String",
       "href": "String",
       "id": "String"
    }
    Place.@referredType Typ des Orts. Dieser Wert ist immer GeographicAddress .

    Datentyp: Zeichenfolge

    Ort.href Relativer Link zum Ortsdatensatz.

    Datentyp: Zeichenfolge

    place.id Erforderlich, wenn placeParameter wird verwendet.
    SYS_ID des Ortsdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Netzwerkstandort [cmdb_ci_ni_Site]

    Zugehörige Partei
    Details zu Kontakten für die Ressource.

    Datentyp: Array von Objekten

    "relatedParty": [
       {
          "@referredType": "String",
          "href": "String",
          "id": "String",
          "role": "String"
       }
    ]
    Hinweis:
    Das Entfernen von Datensätzen der relatidParty aus einer Ressource wird von diesem Endpunkt nicht unterstützt. Datensätze können manuell aus der Tabelle Teams [cmdb_rel_Team] gelöscht werden.
    RelatedParty.@referredType Typ der zugehörigen Partei. Befindet sich in der in Typ Feld.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Typ“ der Tabelle „Gruppe“ [sys_user_Group].

    ZugehörigPartei.href Relativer Link zum Datensatz der zugehörigen Partei.

    Datentyp: Zeichenfolge

    relatedParty.id Erforderlich, wenn relatedPartyParameter wird verwendet.
    ZugehörigPartei.Rolle Rolle der zugehörigen Partei.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld Gruppentyp der Tabelle Teams [cmdb_rel_Team].

    ResourceMerkmal Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale.
    • Für Ressourcen für physische Verbindungen und logische Verbindungen: A Port A Oder Port Z Merkmal ist erforderlich. Wenn der Status der Lebenszyklusphase der Ressource „in Gebrauch“ lautet, beides Port A Und Port Z Sind erforderlich.
    • Für Gerätehalterressourcen: A Containertyp Merkmal ist erforderlich.

    Datentyp: Array von Objekten

    "resourceCharacteristic": [
       {
          "name": "String",
          "value": "String",
          "valueType": "String"
       }
    ]
    resourceCharacteristic.name Erforderlich, wenn resourceCharacteristicParameter wird verwendet.
    Feldname aus der von angegebenen Ressourcentabelle @typeParameter. Sie können die Felder model_ID, Name, Network_Site, Operation_Notes, Operational_Status, nicht verwenden. Short_description, Start_date oder beliebige sys_-Präfixfelder wie sys_ID

    Datentyp: Zeichenfolge

    RessourcenMerkmal.Wert Erforderlich, wenn resourceCharacteristicParameter wird verwendet.
    Der Wert des Merkmals.

    Datentyp: Zeichenfolge

    RessourcenMerkmal.WertTyp Typ des Werts.
    Gültige Werte:
    • boolean
    • Datum/Uhrzeit
    • Gleitkommazahl
    • Ganzzahl
    • ph_number
    • Referenz
    • Zeichenfolge

    Datentyp: Zeichenfolge

    ResourceRelationship Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen.
    • Für Schnittstellenkartenressourcen ist eine Beziehung zu einer Gerätehalterressource erforderlich, bei der der Containertyp „Slot“ oder „Sub Slot“ ist.
    • Für Netzwerkschnittstellen-Ressourcen ist eine Beziehung zu einem Gerät oder einer Schnittstellenkartenressource erforderlich.
    • Für Gerätehalterressourcen, 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}
      }
    ]
    ResourceBeziehung.Beziehungstyp Erforderlich, wenn resourceRelationshipParameter wird verwendet.
    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] im Übergeordneter Deskriptor Und Untergeordneter Deskriptor Spalten.

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource Erforderlich, wenn resourceRelationshipParameter wird verwendet.
    Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein.
    • Kabel
    • Ausrüstung
    • Gerätehalter
    • Schnittstellenkarte
    • Logische Verbindung
    • Netzwerkschnittstelle
    • Netzwerkstandort
    • Physische Verbindung
    • Litze
    • Topologie

    Datentyp: Objekt

    "resource": {
       "id": "String",
       "href": "String"
    }
    resourceRelationship.resource.id Erforderlich, wenn resourceRelationshipParameter wird verwendet.
    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 von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_Holder]

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource.href Relativer Link zum zugehörigen Ressourcendatensatz.

    Datentyp: Zeichenfolge

    ResourceSpecification Ressourcenspezifikation.

    Datentyp: Objekt

    "resourceSpecification": {
       "id": "String"
    }
    resourceSpecification.id Erforderlich, wenn resourceSpecificationParameter wird verwendet.
    SYS_ID des zugeordneten Modells für die Ressource. Befindet sich je nach Modelltyp in einer der folgenden Tabellen.
    • Kabelmodelle [sn_ent_cable_model]
    • Gerätehaltermodelle [sn_ent_nw_holder_model]
    • Anlagenmodelle [sn_ent_nw_Equipment_model]
    • Schnittstellenkartenmodelle [sn_ent_nw_Interface_model]
    • Logische Verbindungsmodelle [sn_ent_logical_nw_connection_model]
    • Netzwerkschnittstellenmodelle [sn_ent_nw_Interface_model]
    • Physische Verbindungsmodelle [sn_ent_physical_nw_connection_model]
    • Litzenmodelle [sn_ent_Strand_model]
    • Topologiemodelle [sn_ent_Network_Topology_model]

    Datentyp: Zeichenfolge

    StartOperatingDate Datum und Uhrzeit, zu der die Ressource den Betrieb erstmals aufgenommen hat.

    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.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/merge-patch+json.
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt 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 REST API-HTTP-Antwortcodes .

    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 hat ein nicht unterstütztes Format, oder der Anforderungsheader des Inhaltstyps ist falsch festgelegt.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    @TYPE Typ der Ressource.
    Gültige Werte:
    • cmdb_ci_cable (Kabel)
    • 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 (Netzwerkstandort)
    • cmdb_ci_ni_physischer_Link (Physische Verbindung)
    • cmdb_ci_Strand (Litze)
    • cmdb_ci_Topology (Topologie)
    • Name einer Tabelle, die von angegeben wird sn_ni_core.equipment_tablessys_property oder Name einer Tabelle, die die angegebenen Tabellen erweitert.
    • Name einer Tabelle, die den Gerätehalter erweitert [cmdb_ci_Equipment_holder].

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung der Ressource.

    Datentyp: Zeichenfolge

    href Relativer Link zum Ressourcendatensatz.

    Datentyp: Zeichenfolge

    id SYS_ID der Ressource. Befindet sich je nach Typ der Ressource in einer der folgenden Tabellen.
    • Kabel [cmdb_ci_cable]
    • Gerätehalter [cmdb_ci_Equipment_Holder]
    • 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]
    • Litze [cmdb_ci_Strand]
    • Topologie [cmdb_ci_Topology]
    • Tabellen, die von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_holder].
    • Untergeordnete Tabellen, die eine der folgenden Tabellen erweitern:
      • Kabel [cmdb_ci_cable]
      • Gerätehalter [cmdb_ci_Equipment_Holder]
      • Litze [cmdb_ci_Strand]

    Datentyp: Zeichenfolge

    name
    Name der Ressource

    Datentyp: Zeichenfolge

    note Liste der Notizen zur Ressource.

    Datentyp: Array von Objekten

    "note": [
       {
          "text": "String"
       }
    ]
    Hinweis.Text
    Der Hinweistext.

    Datentyp: Zeichenfolge

    Ort
    Netzwerkstandort für die Ressource.

    Dieser Parameter wird für Ressourcen „Netzwerkstandort“, „physische Verbindung“ oder „logische Verbindung“ nicht unterstützt.

    Datentyp: Objekt

    "place": {
       "@referredType": "String",
       "href": "String",
       "id": "String"
    }
    Place.@referredType Typ des Orts. Dieser Wert ist immer GeographicAddress .

    Datentyp: Zeichenfolge

    Ort.href Relativer Link zum Ortsdatensatz.

    Datentyp: Zeichenfolge

    place.id
    SYS_ID des Ortsdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Netzwerkstandort [cmdb_ci_ni_Site]

    Zugehörige Partei
    RelatedParty.@referredType Typ der zugehörigen Partei. Befindet sich in der in Typ Feld.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Typ“ der Tabelle „Gruppe“ [sys_user_Group].

    ZugehörigPartei.href Relativer Link zum Datensatz der zugehörigen Partei.

    Datentyp: Zeichenfolge

    relatedParty.id
    SYS_ID des Datensatzes der zugehörigen Partei.

    Datentyp: Zeichenfolge

    Tabelle: Gruppe [sys_user_group]

    ZugehörigPartei.Rolle Rolle der zugehörigen Partei.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld Gruppentyp der Tabelle Teams [cmdb_rel_Team].

    ResourceMerkmal Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale.
    • Für Ressourcen für physische Verbindungen und logische Verbindungen: A Port A Oder Port Z Merkmal ist erforderlich. Wenn der Status der Lebenszyklusphase der Ressource „in Gebrauch“ lautet, beides Port A Und Port Z Sind erforderlich.
    • Für Gerätehalterressourcen: A Containertyp Merkmal ist erforderlich.

    Datentyp: Array von Objekten

    "resourceCharacteristic": [
       {
          "name": "String",
          "value": "String",
          "valueType": "String"
       }
    ]
    resourceCharacteristic.name
    Feldname aus der von angegebenen Ressourcentabelle @typeParameter. Sie können die Felder model_ID, Name, Network_Site, Operation_Notes, Operational_Status, nicht verwenden. Short_description, Start_date oder beliebige sys_-Präfixfelder wie sys_ID

    Datentyp: Zeichenfolge

    RessourcenMerkmal.Wert
    Der Wert des Merkmals.

    Datentyp: Zeichenfolge

    RessourcenMerkmal.WertTyp Typ des Werts.
    Gültige Werte:
    • boolean
    • Datum/Uhrzeit
    • Gleitkommazahl
    • Ganzzahl
    • ph_number
    • Referenz
    • Zeichenfolge

    Datentyp: Zeichenfolge

    ResourceRelationship Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen.
    • Für Schnittstellenkartenressourcen ist eine Beziehung zu einer Gerätehalterressource erforderlich, bei der der Containertyp „Slot“ oder „Sub Slot“ ist.
    • Für Netzwerkschnittstellen-Ressourcen ist eine Beziehung zu einem Gerät oder einer Schnittstellenkartenressource erforderlich.
    • Für Gerätehalterressourcen, 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}
      }
    ]
    ResourceBeziehung.Beziehungstyp
    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] im Übergeordneter Deskriptor Und Untergeordneter Deskriptor Spalten.

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource
    Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein.
    • Kabel
    • Ausrüstung
    • Gerätehalter
    • Schnittstellenkarte
    • Logische Verbindung
    • Netzwerkschnittstelle
    • Netzwerkstandort
    • Physische Verbindung
    • Litze
    • Topologie

    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 von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_Holder]

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource.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.
    • Kabelmodelle [sn_ent_cable_model]
    • Gerätehaltermodelle [sn_ent_nw_holder_model]
    • Anlagenmodelle [sn_ent_nw_Equipment_model]
    • Schnittstellenkartenmodelle [sn_ent_nw_Interface_model]
    • Logische Verbindungsmodelle [sn_ent_logical_nw_connection_model]
    • Netzwerkschnittstellenmodelle [sn_ent_nw_Interface_model]
    • Physische Verbindungsmodelle [sn_ent_physical_nw_connection_model]
    • Litzenmodelle [sn_ent_Strand_model]
    • Topologiemodelle [sn_ent_Network_Topology_model]

    Datentyp: Zeichenfolge

    StartOperatingDate Datum und Uhrzeit, zu der die Ressource den Betrieb erstmals aufgenommen hat.

    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"
    }

    Ressourcenbestand – API öffnen – 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. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    @TYPE Typ der Ressource.
    Gültige Werte:
    • cmdb_ci_cable (Kabel)
    • 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 (Netzwerkstandort)
    • cmdb_ci_ni_physischer_Link (Physische Verbindung)
    • cmdb_ci_Strand (Litze)
    • cmdb_ci_Topology (Topologie)
    • Name einer Tabelle, die von angegeben wird sn_ni_core.equipment_tablessys_property oder Name einer Tabelle, die die angegebenen Tabellen erweitert.
    • Name einer Tabelle, die den Gerätehalter erweitert [cmdb_ci_Equipment_holder].

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung der Ressource.

    Datentyp: Zeichenfolge

    name Erforderlich.
    Name der Ressource

    Datentyp: Zeichenfolge

    note Liste der Notizen zur Ressource.

    Datentyp: Array von Objekten

    "note": [
       {
          "text": "String"
       }
    ]
    Hinweis.Text Erforderlich, wenn noteParameter wird verwendet.
    Der Hinweistext.

    Datentyp: Zeichenfolge

    Ort Erforderlich für Gerätehalterressourcen, bei denen der Containertyp „Cage“, „Bay“, „Cabinet“, „Rack“, „Line Up“ ist oder Bestandsmodellpaket. Erforderlich für alle Ausrüstungsressourcen.
    Netzwerkstandort für die Ressource.

    Dieser Parameter wird für Ressourcen „Netzwerkstandort“, „physische Verbindung“ oder „logische Verbindung“ nicht unterstützt.

    Datentyp: Objekt

    "place": {
       "@referredType": "String",
       "href": "String",
       "id": "String"
    }
    Place.@referredType Typ des Orts. Dieser Wert ist immer GeographicAddress .

    Datentyp: Zeichenfolge

    Ort.href Relativer Link zum Ortsdatensatz.

    Datentyp: Zeichenfolge

    place.id Erforderlich, wenn placeParameter wird verwendet.
    SYS_ID des Ortsdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Netzwerkstandort [cmdb_ci_ni_Site]

    Zugehörige Partei
    Details zu Kontakten für die Ressource.

    Datentyp: Array von Objekten

    "relatedParty": [
       {
          "@referredType": "String",
          "href": "String",
          "id": "String",
          "role": "String"
       }
    ]
    RelatedParty.@referredType Typ der zugehörigen Partei. Befindet sich in der in Typ Feld.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Typ“ der Tabelle „Gruppe“ [sys_user_Group].

    ZugehörigPartei.href Relativer Link zum Datensatz der zugehörigen Partei.

    Datentyp: Zeichenfolge

    relatedParty.id Erforderlich, wenn relatedPartyParameter wird verwendet.
    SYS_ID des Datensatzes der zugehörigen Partei.

    Datentyp: Zeichenfolge

    Tabelle: Gruppe [sys_user_group]

    ResourceMerkmal Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale.
    • Für Ressourcen für physische Verbindungen und logische Verbindungen: A Port A Oder Port Z Merkmal ist erforderlich. Wenn der Status der Lebenszyklusphase der Ressource „in Gebrauch“ lautet, beides Port A Und Port Z Sind erforderlich.
    • Für Gerätehalterressourcen: A Containertyp Merkmal ist erforderlich.

    Datentyp: Array von Objekten

    "resourceCharacteristic": [
       {
          "name": "String",
          "value": "String",
          "valueType": "String"
       }
    ]
    resourceCharacteristic.name Erforderlich, wenn resourceCharacteristicParameter wird verwendet.
    Feldname aus der von angegebenen Ressourcentabelle @typeParameter. Sie können die Felder model_ID, Name, Network_Site, Operation_Notes, Operational_Status, nicht verwenden. Short_description, Start_date oder beliebige sys_-Präfixfelder wie sys_ID

    Datentyp: Zeichenfolge

    RessourcenMerkmal.Wert Erforderlich, wenn resourceCharacteristicParameter wird verwendet.
    Der Wert des Merkmals.

    Datentyp: Zeichenfolge

    RessourcenMerkmal.WertTyp Typ des Werts.
    Gültige Werte:
    • boolean
    • Datum/Uhrzeit
    • Gleitkommazahl
    • Ganzzahl
    • ph_number
    • Referenz
    • Zeichenfolge

    Datentyp: Zeichenfolge

    ResourceRelationship Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen.
    • Für Schnittstellenkartenressourcen ist eine Beziehung zu einer Gerätehalterressource erforderlich, bei der der Containertyp „Slot“ oder „Sub Slot“ ist.
    • Für Netzwerkschnittstellen-Ressourcen ist eine Beziehung zu einem Gerät oder einer Schnittstellenkartenressource erforderlich.
    • Für Gerätehalterressourcen, 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}
      }
    ]
    ResourceBeziehung.Beziehungstyp Erforderlich, wenn resourceRelationshipParameter wird verwendet.
    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] im Übergeordneter Deskriptor Und Untergeordneter Deskriptor Spalten.

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource Erforderlich, wenn resourceRelationshipParameter wird verwendet.
    Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein.
    • Kabel
    • Ausrüstung
    • Gerätehalter
    • Schnittstellenkarte
    • Logische Verbindung
    • Netzwerkschnittstelle
    • Netzwerkstandort
    • Physische Verbindung
    • Litze
    • Topologie

    Datentyp: Objekt

    "resource": {
       "id": "String",
       "href": "String"
    }
    resourceRelationship.resource.id Erforderlich, wenn resourceRelationshipParameter wird verwendet.
    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 von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_Holder]

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource.href Relativer Link zum zugehörigen Ressourcendatensatz.

    Datentyp: Zeichenfolge

    ResourceSpecification Ressourcenspezifikation.

    Datentyp: Objekt

    "resourceSpecification": {
       "id": "String"
    }
    resourceSpecification.id Erforderlich, wenn resourceSpecificationParameter wird verwendet.
    SYS_ID des zugeordneten Modells für die Ressource. Befindet sich je nach Modelltyp in einer der folgenden Tabellen.
    • Kabelmodelle [sn_ent_cable_model]
    • Gerätehaltermodelle [sn_ent_nw_holder_model]
    • Anlagenmodelle [sn_ent_nw_Equipment_model]
    • Schnittstellenkartenmodelle [sn_ent_nw_Interface_model]
    • Logische Verbindungsmodelle [sn_ent_logical_nw_connection_model]
    • Netzwerkschnittstellenmodelle [sn_ent_nw_Interface_model]
    • Physische Verbindungsmodelle [sn_ent_physical_nw_connection_model]
    • Litzenmodelle [sn_ent_Strand_model]
    • Topologiemodelle [sn_ent_Network_Topology_model]

    Datentyp: Zeichenfolge

    StartOperatingDate Datum und Uhrzeit, zu der die Ressource den Betrieb erstmals aufgenommen hat.

    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
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt 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 REST API-HTTP-Antwortcodes .

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    215 Anforderung zur Verarbeitung erfolgreich empfangen. 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 Typ der Ressource.
    Gültige Werte:
    • cmdb_ci_cable (Kabel)
    • 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 (Netzwerkstandort)
    • cmdb_ci_ni_physischer_Link (Physische Verbindung)
    • cmdb_ci_Strand (Litze)
    • cmdb_ci_Topology (Topologie)
    • Name einer Tabelle, die von angegeben wird sn_ni_core.equipment_tablessys_property oder Name einer Tabelle, die die angegebenen Tabellen erweitert.
    • Name einer Tabelle, die den Gerätehalter erweitert [cmdb_ci_Equipment_holder].

    Datentyp: Zeichenfolge

    Beschreibung Beschreibung der Ressource.

    Datentyp: Zeichenfolge

    href Relativer Link zum Ressourcendatensatz.

    Datentyp: Zeichenfolge

    id SYS_ID der Ressource. Befindet sich je nach Typ der Ressource in einer der folgenden Tabellen.
    • Kabel [cmdb_ci_cable]
    • Gerätehalter [cmdb_ci_Equipment_Holder]
    • 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]
    • Litze [cmdb_ci_Strand]
    • Topologie [cmdb_ci_Topology]
    • Tabellen, die von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_holder].
    • Untergeordnete Tabellen, die eine der folgenden Tabellen erweitern:
      • Kabel [cmdb_ci_cable]
      • Gerätehalter [cmdb_ci_Equipment_Holder]
      • Litze [cmdb_ci_Strand]

    Datentyp: Zeichenfolge

    name
    Name der Ressource

    Datentyp: Zeichenfolge

    note Liste der Notizen zur Ressource.

    Datentyp: Array von Objekten

    "note": [
       {
          "text": "String"
       }
    ]
    Hinweis.Text
    Der Hinweistext.

    Datentyp: Zeichenfolge

    Ort
    Netzwerkstandort für die Ressource.

    Dieser Parameter wird für Ressourcen „Netzwerkstandort“, „physische Verbindung“ oder „logische Verbindung“ nicht unterstützt.

    Datentyp: Objekt

    "place": {
       "@referredType": "String",
       "href": "String",
       "id": "String"
    }
    Place.@referredType Typ des Orts. Dieser Wert ist immer GeographicAddress .

    Datentyp: Zeichenfolge

    Ort.href Relativer Link zum Ortsdatensatz.

    Datentyp: Zeichenfolge

    place.id
    SYS_ID des Ortsdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Netzwerkstandort [cmdb_ci_ni_Site]

    Zugehörige Partei
    Details zu Kontakten für die Ressource.

    Datentyp: Array von Objekten

    "relatedParty": [
       {
          "@referredType": "String",
          "href": "String",
          "id": "String",
          "role": "String"
       }
    ]
    RelatedParty.@referredType Typ der zugehörigen Partei. Befindet sich in der in Typ Feld.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Typ“ der Tabelle „Gruppe“ [sys_user_Group].

    ZugehörigPartei.href Relativer Link zum Datensatz der zugehörigen Partei.

    Datentyp: Zeichenfolge

    relatedParty.id
    SYS_ID des Datensatzes der zugehörigen Partei.

    Datentyp: Zeichenfolge

    Tabelle: Gruppe [sys_user_group]

    ResourceMerkmal Liste der Merkmale der Ressource. Die folgenden Ressourcentypen erfordern bestimmte Ressourcenmerkmale.
    • Für Ressourcen für physische Verbindungen und logische Verbindungen: A Port A Oder Port Z Merkmal ist erforderlich. Wenn der Status der Lebenszyklusphase der Ressource „in Gebrauch“ lautet, beides Port A Und Port Z Sind erforderlich.
    • Für Gerätehalterressourcen: A Containertyp Merkmal ist erforderlich.

    Datentyp: Array von Objekten

    "resourceCharacteristic": [
       {
          "name": "String",
          "value": "String",
          "valueType": "String"
       }
    ]
    resourceCharacteristic.name
    Feldname aus der von angegebenen Ressourcentabelle @typeParameter. Sie können die Felder model_ID, Name, Network_Site, Operation_Notes, Operational_Status, nicht verwenden. Short_description, Start_date oder beliebige sys_-Präfixfelder wie sys_ID

    Datentyp: Zeichenfolge

    RessourcenMerkmal.Wert
    Der Wert des Merkmals.

    Datentyp: Zeichenfolge

    RessourcenMerkmal.WertTyp Typ des Werts.
    Gültige Werte:
    • boolean
    • Datum/Uhrzeit
    • Gleitkommazahl
    • Ganzzahl
    • ph_number
    • Referenz
    • Zeichenfolge

    Datentyp: Zeichenfolge

    ResourceRelationship Liste der zugehörigen Ressourcen. Die folgenden Ressourcentypen erfordern bestimmte zugehörige Ressourcen.
    • Für Schnittstellenkartenressourcen ist eine Beziehung zu einer Gerätehalterressource erforderlich, bei der der Containertyp „Slot“ oder „Sub Slot“ ist.
    • Für Netzwerkschnittstellen-Ressourcen ist eine Beziehung zu einem Gerät oder einer Schnittstellenkartenressource erforderlich.
    • Für Gerätehalterressourcen, 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}
      }
    ]
    ResourceBeziehung.Beziehungstyp
    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] im Übergeordneter Deskriptor Und Untergeordneter Deskriptor Spalten.

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource
    Details zur zugehörigen Ressource. Die zugehörige Ressource muss einer der folgenden Ressourcentypen sein.
    • Kabel
    • Ausrüstung
    • Gerätehalter
    • Schnittstellenkarte
    • Logische Verbindung
    • Netzwerkschnittstelle
    • Netzwerkstandort
    • Physische Verbindung
    • Litze
    • Topologie

    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 von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_Holder]

    Datentyp: Zeichenfolge

    Ressourcenbeziehung.Ressource.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.
    • Kabelmodelle [sn_ent_cable_model]
    • Gerätehaltermodelle [sn_ent_nw_holder_model]
    • Anlagenmodelle [sn_ent_nw_Equipment_model]
    • Schnittstellenkartenmodelle [sn_ent_nw_Interface_model]
    • Logische Verbindungsmodelle [sn_ent_logical_nw_connection_model]
    • Netzwerkschnittstellenmodelle [sn_ent_nw_Interface_model]
    • Physische Verbindungsmodelle [sn_ent_physical_nw_connection_model]
    • Litzenmodelle [sn_ent_Strand_model]
    • Topologiemodelle [sn_ent_Network_Topology_model]

    Datentyp: Zeichenfolge

    StartOperatingDate Datum und Uhrzeit, zu der die Ressource den Betrieb erstmals aufgenommen hat.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel wird ein Netzwerkstandort in Denver, Colorado, 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\": \"(214) 555-1234\"
        },
        {
          \"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": "(214) 555-1234"
          },
          {
             "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"
    }

    Ressourcenbestand – API öffnen – POST /sn_ni_Core/resourceinventoryviatemplate

    Erstellt ein Ressourcenkonfigurationselement (CI) und eine 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. Anforderungstext-Parameter (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 overridesParameter wird verwendet. Spaltenname und -Wert.

    Datentyp: Zeichenfolge

    parentId Erforderlich. SYS_ID des übergeordneten CI. Befindet sich je nach Typ des übergeordneten CI in einer der folgenden Tabellen.
    • Kabel [cmdb_ci_cable]
    • Gerätehalter [cmdb_ci_Equipment_Holder]
    • 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]
    • Litze [cmdb_ci_Strand]
    • Topologie [cmdb_ci_Topology]
    • Tabellen, die von angegeben werden sn_ni_core.equipment_tablessys_property und alle Tabellen, die die angegebenen Tabellen erweitern.
    • Tabellen, die den Gerätehalter erweitern [cmdb_ci_Equipment_holder].
    • Untergeordnete Tabellen, die eine der folgenden Tabellen erweitern:
      • Kabel [cmdb_ci_cable]
      • Gerätehalter [cmdb_ci_Equipment_Holder]
      • Litze [cmdb_ci_Strand]

    Datentyp: Zeichenfolge

    templateId Erforderlich. SYS_ID der Vorlage.

    Datentyp: Zeichenfolge

    Tabelle: Bestandsvorlage [sn_ni_Core_Inventory_template]

    TemplateÜberschreibungen Liste der Vorlagenüberschreibungen.

    Datentyp: Array von Objekten

    "templateOverrides": [
      {
        "overrideTemplateId": "String",
        "templateId": "String"     
      }
    ]
    TemplateÜberschreibungen.überschriebenTemplateId Erforderlich, wenn templateOverridesParameter wird verwendet. Verfügbare Vorlage sys_ID.

    Datentyp: Zeichenfolge

    TemplateÜberschreibungen.templateId Erforderlich, wenn templateOverridesParameter wird verwendet. Zugehörige Vorlage sys_ID

    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
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt 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 REST API-HTTP-Antwortcodes .

    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. Beispielsweise hat die Anforderung Validierungsprüfungen fehlgeschlagen.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    Ergebnis Ergebnisobjekt mit Informationen zu den erstellten CIs.

    Datentyp: Objekt

    "result": {
      "sys_id": "String"
    }
    Ergebnis.sys_ID SYS_ID des erstellten CI oben in der Hierarchie.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel wird eine CI-Hierarchie mithilfe einer Vorlage 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"
    }