Installationsbasiselement-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 119 Minuten Lesedauer

    • Die Installationsbasiselement Die API stellt Endpunkte für den Zugriff auf und die Verwaltung von Installationsbasiselementen-Datensätzen in einem bereit ServiceNow Instanz.

    Ein Installationsbasiselement stellt eine Instanz eines Produkts dar, das für einen Kunden konfiguriert wurde. Mit Installationsbasiselementen können Sie alle Käufe eines Kunden nachverfolgen.

    Mit dieser API können Sie auch CRUD-Vorgänge in der zugehörigen Liste „Installationsbasis – zugehörige Parteien“ ausführen. Darüber hinaus können Sie Datensätze in anderen zugehörigen Listen für Installationsbasiselemente lesen, z. B. Fälle, Verträge, Berechtigungen, Wartungspläne, verkaufte Produkte und Arbeitsaufträge.

    Um auf diese API zuzugreifen, benötigen Sie je nach Typ der CRUD-Aktion die Rolle sn_install_Base.IB_api_write oder sn_install_Base.IB_api_read.

    Um auf die verschiedenen Endpunkte in dieser API zuzugreifen, müssen die folgenden Plugins installiert sein:
    • Customer Service Install Base Management (com.snc.install_base)
    • Management geplanter Arbeit (sn_fsm_planned_wm), wenn Sie Wartungsplan- und Arbeitsauftragsdaten abrufen möchten.

    Diese API wird in ausgeführt sn_install_Base Namespace.

    Hinweis:
    Diese API gibt nur nicht leere Felder in den Endpunktantworten zurück. Außerdem werden keines der Felder auf Systemebene (mit vorangestelltem „sys_“) außer dem Feld „sys_ID“ zurückgegeben.

    Weitere Informationen zu Installationsbasiselementen finden Sie unter Create an Install base item.

    Installationsbasiselement: LÖSCHEN SIE /sn_install_Base/Integrations/installbaseitems/{ID}/relatedParties/{related_Party_sys_ID}

    Hebt die Zuordnung eines angegebenen Datensatzes für zugehörige Parteien zu einem angegebenen Installationsbasiselement-Datensatz auf.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/relatedParties/{related_Party_sys_ID}

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/relatedParties/{related_Party_sys_ID}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Zugehörige_Partei_sys_ID SYS_ID des Datensatzes der zugehörigen Partei.

    Datentyp: Zeichenfolge

    Tabelle: Zugehörige Partei der Installationsbasis [sn_install_Base_related_Party]
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 3. Anforderungstextparameter (XML oder 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ützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    Ergebnis Beschreibung der Endpunktergebnisse.

    Datentyp: Objekt
    Ergebnis.Status Status der Endpunktanforderung.

    Mögliche Werte:

    • ERFOLG
    • FEHLER

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/relatedparties/2a42dfae872521100b6afc86dabb356b" \
--request DELETE \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "status": "SUCCESS"
  }
}

    Installationsbasiselement – GET /sn_install_Base/Integrations/installbaseitems

    Gibt alle Installationsbasiselemente zurück. Sie können Parameter innerhalb des Aufrufs übergeben, um die Rückgabeergebnisse zu filtern.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Feldname-Wert-Paare Feld-Wert-Paare, die zum Filtern der Datensätze des Installationsbasiselements verwendet werden sollen. Wenn Sie in eine andere Tabelle angeben sys_class_name, Geben Sie dann die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die Rückgabeergebnisse zu filtern.

    Um beispielsweise nur Datensätze zurückzugeben, bei denen das Statusfeld auf „in_use“ und das Statusfeld auf „Ersatz“ festgelegt ist, übergeben Sie Folgendes: &State=in_use&Status=Ersatz .

    Datentyp: Zeichenfolge

    Standard: Alle Felder

    Tabelle: Installationsbasiselement [sn_istall_Base_item]
    Related_Party SYS_ID eines Datensatzes einer zugehörigen Partei.

    Filtert die Datensätze des Installationsbasiselements basierend auf der angegebenen zugehörigen Partei. Eine zugehörige Partei kann mit einem Installationsbasiselement oder einem verkauften Produkt verknüpft werden.

    Gültige Werte:
    • Account-sys_ID: Befindet sich in der Tabelle „Account“ [Customer_Account].
    • Verbraucher-sys_ID: Befindet sich in der Tabelle „Verbraucher“ [csm_Consumer].
    • Sys_ID des Kontakts: Befindet sich in der Tabelle „Kontakt“ [Customer-contact].
    • Sys_ID der Serviceorganisation: Befindet sich in der Tabelle „Serviceorganisation“ [sn_Customer_Service_Organization].
    • Anwender-sys_ID: Befindet sich in der Anwendertabelle [sys-user].

    Datentyp: Zeichenfolge

    Tabelle: Zugehörige Partei der Installationsbasis [sn_install_Base_related_Party]
    Verantwortlichkeit SYS_ID des zugehörigen Verantwortungsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Installationsbasisinformationen.

    Dieser Parameter ist nur gültig, wenn related_partyFeld ist ebenfalls angegeben. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die beiden entsprechen related_partyUnd responsibilityParameter.

    Weitere Informationen finden Sie unter Configure related parties for Items Received.

    Datentyp: Zeichenfolge
    sys_class_name Wenn sich die gewünschten Datensätze in einer Tabelle befinden, die die Tabelle „Installationsbasiselemente“ [sn_install_Base_item] erweitert, der Name der erweiterten Tabelle, die abgefragt werden soll.

    Datentyp: Zeichenfolge
    sysparm_limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden.

    Hinweis:
    Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 9. Anforderungstextparameter (XML oder 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ützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Die folgenden Rückgabeergebnisse beschreiben nur die Rückgabewerte für Datensätze, die aus der Tabelle „Installationsbasiselemente“ [sn_install_Base_items] zurückgegeben werden.

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze zurückgegeben werden sollen.
    Mögliche Werte:
    • Wahr: Weitere zurückzugebende Datensätze.
    • Falsch: Keine weiteren Datensätze zum Rückgeben vorhanden.

    Datentyp: Boolesche Zeichenfolge
    items Liste der Installationsbasiselemente, die den angegebenen Filterergebnissen entsprechen.

    Datentyp: Array von Objekten

    "items":[
  {
    "account": {Object},
    "active": "String",
    "asset": {Object},
    "configuration_item": {Object},
    "consumer": {Object},
    "consumer_profile": {Object},
    "contact": {Object},
    "health_status": {Object},
    "health_status_last_updated": "String",
    "household": {Object},
    "install_date": {Object},
    "location": {Object},
    "name": "String",
    "number": "String",
    "parent": {Object},
    "product": {Object},
    "service_context": {Object},
    "service_organization" {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "sys_mod_count": "String",
    "state": {Object},
    "status": {Object},
    "uninstall_date": "String"
  }
]
    Elemente.Account Details zum Kunden-Account, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    Items.Account.Display_value Textname des Kunden-Accounts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Kundenaccounts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Account.sys_ID SYS_ID des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Elemente.aktiv Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • Wahr: Installationsbasiselement ist aktiv.
    • Falsch: Installationsbasiselement ist inaktiv.

    Datentyp: Boolesche Zeichenfolge
    Elemente.Asset Details zum Asset, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    Elements.Asset.Display_value Textname des Assets, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Asset-Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Asset.sys_ID SYS_ID des Asset-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Elements.Configuration_item Details zum Konfigurationselement, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    Elements.Configuration_item.Display_value Textname des Konfigurationselements, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Konfigurationselements in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Configuration_item.sys_ID SYS_ID des Konfigurationselementdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Artikel.Verbraucher Details zum Verbraucher, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucher ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    Elemente.Verbraucher.Anzeige_Wert Textname des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Verbrauchernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Items.Consumer.sys_ID SYS_ID des Verbraucherdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Elements.Consumer_Profile Details zum Verbraucherprofil, das dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucherprofil ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    Items.Consumer_Profile.Display_value Textname des Verbraucherprofils, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Verbraucherprofils in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Consumer_Profile.sys_ID SYS_ID des Verbraucherprofildatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Elemente.Kontakt Details zum Account-Kontakt, der für den Installationsbasiselement-Datensatz verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    Elements.Kontakt.Display_value Textname des Accountkontakts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Account-Kontakts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Contact.sys_ID SYS_ID des Account-Kontaktdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Elements.Health_Status Details zum aktuellen Integritätsstatus des Installationsbasiselements. Wird nur zurückgegeben, wenn das Plugin „Proactive Customer Service Operations“ (com.snc.proactive_cs_itom) installiert ist.

    Datentyp: Objekt

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    Elements.Health_Status.Display_value Textzeichenfolge des aktuellen Integritätsstatus des Installationsbasiselements. Verwenden Sie diesen Wert, um den Integritätsstatus in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Health_Status.value Interner Wert des Integritätsstatus des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Elements.Health_Status_Last_updated Datum und Uhrzeit der letzten Aktualisierung des Integritätsstatus für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Artikel.Haushalt Details zum Haushalt, der dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin Kundenservice-Haushalt (com.snc.Household) installiert ist.

    Datentyp: Objekt

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    Artikel.Haushalt.Anzeige_Wert Textname des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Haushaltsnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elemente.Haushalt.sys_ID SYS_ID des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.install_date Details zum Datum, an dem das Installationsbasiselement aktiv wurde.

    Datentyp: Objekt

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    items.install_date.display_value Textinstallationsdatum. Verwenden Sie diesen Wert, um das Installationsdatum in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.install_date.value Interner Wert des Installationsdatums.

    Datentyp: Zeichenfolge
    Elemente.Standort Details zum Speicherort des Installationsbasiselements.

    Datentyp: Objekt

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    Elements.location.Display_value Textname des Installationsbasiselements-Standorts. Verwenden Sie diesen Wert, um den Standortnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.location.sys_ID SYS_ID des Standortdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Elemente.Nummer Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Elemente.übergeordnet Details zum übergeordneten Datensatz des Installationsbasiselements-Datensatzes.

    Datentyp: Objekt

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    Elements.parent.Display_value Textname des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den übergeordneten Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.parent.sys_ID SYS_ID des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.product Details zum Produktmodell, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diese Informationen, um die Services zu identifizieren, die einem Produktmodell zugeordnet sind.

    Datentyp: Objekt

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    items.product.display_value Textname des Produktmodells, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Produktnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.product.sys_id SYS_ID des Produktmodelldatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.service_context Details zum Servicekontext, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    items.service_context.display_value Textname des Servicekontexts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Servicekontextnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.service_context.sys_id SYS_ID des Servicekontextdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.service_organization Details zur Serviceorganisation, die dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin „Serviceorganisation“ (com.snc.service_organization) installiert ist.

    Datentyp: Objekt

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    items.service_organization.display_value Textname der Serviceorganisation, die dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen der Serviceorganisation in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.service_organization.sys_id SYS_ID des Serviceorganisationsdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Items.sys_class_Name Tabelle, die den Installationsbasiselement-Datensatz enthält.

    Datentyp: Zeichenfolge
    Elements.sys_ID SYS_ID des Installationsbasiselementdatensatzes. Befindet sich in der in angegebenen Tabelle sys_class_nameParameter.

    Datentyp: Zeichenfolge
    Items.sys_mod_count Gibt an, wie oft der zugehörige Installationsbasiselement-Datensatz geändert wurde.

    Datentyp: Zeichenfolge
    Elemente.Status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

    "state": {
  "display_value": "String",
  "value": "String"
}
    Elements.Status.Display_value Textzeichenfolge des aktuellen Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elemente.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Elemente.Status Details zum Status des Installationsbasiselements.

    Datentyp: Objekt

    "status": {
  "display_value": "String",
  "value": "String"
}
    Elements.Status.Display_value Textzeichenfolge des Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elemente.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Items.Deinstallation_date Details zum Datum, an dem das Installationsbasiselement inaktiv wurde.

    Datentyp: Objekt

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    Items.Deinstallation_date.Display_value Datum der Textdeinstallation. Verwenden Sie diesen Wert, um das Deinstallationsdatum in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Items.Deinstallation_date.value Interner Wert des Deinstallationsdatums.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    Sysparm_depth Anzahl der Ebenen, die das zurückgegebene untergeordnete Installationsbasiselement in der Hierarchie enthalten ist.

    Datentyp: Ganzzahl
    sysparm_limit Anzahl der zurückgegebenen Datensätze. Wenn dieser Wert nicht in der ursprünglichen Anforderung angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugehörigen Tabelle, aus der Datensätze ausgewertet und abgerufen wurden.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt einen einfachen Aufruf, der nur einen einzelnen Datensatz zurückgibt, der bei Offset 5 beginnt.

    curl "https://instance.servicenow.com/api/sn_install_base/v1/integrations/installbaseitems?sysparm_limit=1&sysparm_offset=5" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sysparm_offset": "5",
    "sysparm_limit": 1,
    "has_more": true,
    "items": [
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001100",
        "sys_id": "181df7ff530a1110539dddeeff7b12f4",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "sys_mod_count": "2",
        "active": "true",
        "configuration_item": {
          "sys_id": "62446ae8535e5510539dddeeff7b12db",
          "display_value": "boxeoproderp"
        },
        "name": "boxeoproderp",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie nach den Feldern gesucht wird state= „in_use“ und status= „Ersatz“ in der Tabelle „Installationsbasiselement“.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems?state=in_use&status=replacement" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sysparm_offset": "0",
    "sysparm_limit": "10",
    "has_more": false,
    "items": [
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001140",
        "sys_id": "a1a123745312d910539dddeeff7b127b",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "2dd1e7b753421110539dddeeff7b12d1",
          "display_value": "Stand"
        },
        "active": "true",
        "name": "Stand",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      },
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001139",
        "sys_id": "d0916bb05312d910539dddeeff7b1232",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "dfc127b753421110539dddeeff7b12ac",
          "display_value": "Register"
        },
        "active": "true",
        "name": "Register",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      },
      {
        "parent": {
          "sys_id": "ffd023f453de9910539dddeeff7b1264",
          "display_value": "Point of Sale System"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001141",
        "sys_id": "ffb123745312d910539dddeeff7b12cb",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2018-12-14 07:00:00",
          "display_value": "2018-12-13 23:00:00"
        },
        "product": {
          "sys_id": "59e1e7b753421110539dddeeff7b12cc",
          "display_value": "Terminal"
        },
        "active": "true",
        "name": "Terminal",
        "service_organization": {
          "sys_id": "42b51f5ab3401010700b4d43c6a8dc5a",
          "display_value": "LA City Center - West"
        },
        "status": {
          "value": "replacement",
          "display_value": "Replacement"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie die Rückgabeergebnisse mit gefiltert werden related_partyUnd responsibilityAbfrageparameter.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems?related_party=dc0185d94f341200025ba3618110c77c&responsibility=c009bbedb3730010700b4d43c6a8dce" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sysparm_offset": "0",
    "sysparm_limit": "10",
    "has_more": false,
    "items": [
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001004",
        "sys_id": "3ea014a778de1110f877d304c76fdd0d",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "consumer": {
          "sys_id": "feb5139ab3401010700b4d43c6a8dc43",
          "display_value": "Kenny Smith"
        },
        "product": {
          "sys_id": "63c8bc9778921110f877d304c76fdd34",
          "display_value": "X4 Sport Utility 4D"
        },
        "active": "true",
        "name": "X4 Sport Utility 4D",
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM001003",
        "sys_id": "6e94e3c853500010df5dddeeff7b1234",
        "contact": {
          "sys_id": "4d147a386f0331003b3c498f5d3ee437",
          "display_value": "Julie Lewis"
        },
        "active": "true",
        "configuration_item": {
          "sys_id": "a96a570453500010df5dddeeff7b1206",
          "display_value": "boxeosandbox"
        },
        "name": "Boxeo - Sandbox",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001010",
        "sys_id": "83332fde87e5a1105d0055373cbb3567",
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "install_date": {
          "value": "2023-02-26 18:59:52",
          "display_value": "2023-02-26 10:59:52"
        },
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "product": {
          "sys_id": "a9a2d0c3c6112276010db16c5ddd3461",
          "display_value": "Lenovo ThinkStation S20"
        },
        "active": "true",
        "configuration_item": {
          "sys_id": "affd3c8437201000deeabfc8bcbe5dc3",
          "display_value": "*BETH-IBM"
        },
        "name": "IB B2B",
        "location": {
          "sys_id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
          "display_value": "100 South Charles Street, Baltimore,MD"
        },
        "asset": {
          "sys_id": "bfc1fa8837f3100044e0bfc8bcbe5ddf",
          "display_value": "P1000228 - Lenovo ThinkStation S20"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        },
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001011",
        "sys_id": "9d766f168729a1105d0055373cbb3597",
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "product": {
          "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
          "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
        },
        "active": "true",
        "name": "IBA",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001013",
        "sys_id": "bd955a2687ada1100b6afc86dabb35fb",
        "health_status": {
          "value": "not_available",
          "display_value": "Not Available"
        },
        "consumer": {
          "sys_id": "59e788fbdb1b1200b6075200cf9619d2",
          "display_value": "Gilly Parker"
        },
        "product": {
          "sys_id": "1a13974053500010df5dddeeff7b122c",
          "display_value": "12000XHD Digital Press"
        },
        "active": "true",
        "name": "IBConsumer"
      },
      {
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0000901",
        "sys_id": "f77c7542b7343300ece839a6ee11a991",
        "product": {
          "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
          "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
        },
        "active": "true",
        "name": "KX Series - KX5001",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Installationsbasiselement – GET /sn_install_Base/Integrations/installbaseitem/{ID}

    Gibt einen angegebenen Installationsbasiselementdatensatz und seine untergeordnete Hierarchie zurück.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitem/{ID}

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitem/{ID}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    sys_class_name Wenn sich der beabsichtigte Datensatz in einer Tabelle befindet, die die Tabelle „Installationsbasiselemente“ [sn_install_Base_item] erweitert, der Name der erweiterten Tabelle, die abgefragt werden soll. Diese Tabelle muss die Tabelle sn_install_Base_item erweitern.

    Datentyp: Zeichenfolge
    Sysparm_depth Maximale Tiefe der Hierarchie des untergeordneten Installationsbasiselements, die zurückgegeben werden soll.

    Datentyp: Ganzzahl

    Standard: 7

    Maximum: 10
    sysparm_limit Maximale Anzahl von Datensätzen, die in jeder untergeordneten Hierarchie zurückgegeben werden sollen.

    Datentyp: Ganzzahl

    Standard: 10

    Maximum: 100
    Tabelle : 15. Anforderungstextparameter (XML oder 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ützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter 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.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Child-Installationsbasis Liste der Datensätze des untergeordneten Installationsbasiselements, die dem angegebenen Installationsbasiselement zugeordnet sind.

    Datentyp: Objekt

    "childinstallbase": {
  "items": [Array],
  "sysparm_depth": Integer
}
    childinstallbase.items Untergeordnete Installationsbasiselemente, die dem angegebenen Installationsbasiselement zugeordnet sind.

    Die Werte in diesem Array sind unter definiert items[]Array weiter unten in diesem Abschnitt.
    Childinstallbase.sysparm_depth Untergeordnete Ebene des Installationsbasiselements.

    Datentyp: Ganzzahl
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    Has_Children Kennzeichnung, die angibt, ob der Datensatz des angeforderten Installationsbasiselements untergeordnete Installationsbasiselemente enthält.
    • Wahr: Hat untergeordnete Installationsbasiselementdatensätze.
    • Falsch: Hat keine Datensätze für untergeordnete Installationsbasiselemente.

    Datentyp: Boolesch
    Element Installationsbasiselement, das den angegebenen Filterergebnissen entspricht.

    Datentyp: Objekt

    "item": {
  "account": {Object},
  "active": "String",
  "asset": {Object},
  "configuration_item": {Object},
  "consumer": {Object},
  "consumer_profile": {Object},
  "contact": {Object},
  "health_status": "Object",
  "health_status_last_updated": "String",
  "household": {Object},
  "install_date": {Object},
  "location": {Object},
  "name": "String",
  "number": "String",
  "parent": {Object},
  "product": {Object},
  "service_context": {Object},
  "service_organization" {Object},
  "sys_class_name": "String",
  "sys_id": "String",
  "state": {Object},
  "status": {Object},
  "uninstall_date": "String"
}
    Element.Account Details zum Kunden-Account, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Account.Display_value Textname des Kunden-Accounts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Kundenaccounts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Account.sys_ID SYS_ID des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.aktiv Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • Wahr: Installationsbasiselement ist aktiv.
    • Falsch: Installationsbasiselement ist inaktiv.

    Datentyp: Boolesche Zeichenfolge
    Element.Asset Details zum Asset, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Asset.Display_value Textname des Assets, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Asset-Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Asset.sys_ID SYS_ID des Asset-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Configuration_item Details zum Konfigurationselement, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Configuration_item.Display_value Textname des Konfigurationselements, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Konfigurationselements in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Configuration_item.sys_ID SYS_ID des Konfigurationselementdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Verbraucher Details zum Verbraucher, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucher ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Verbraucher.Anzeige_Wert Textname des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Verbrauchernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Verbraucher.sys_ID SYS_ID des Verbraucherdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Verbraucher_Profil Details zum Verbraucherprofil, das dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucherprofil ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Verbraucher_Profil.Anzeige_Wert Textname des Verbraucherprofils, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Verbraucherprofils in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Verbraucher_Profil.sys_ID SYS_ID des Verbraucherprofildatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Kontakt Details zum Account-Kontakt, der für den Installationsbasiselement-Datensatz verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Kontakt.Anzeige_Wert Textname des Accountkontakts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Account-Kontakts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Kontakt.sys_ID SYS_ID des Account-Kontaktdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Health_Status Details zum aktuellen Integritätsstatus des Installationsbasiselements. Wird nur zurückgegeben, wenn das Plugin „Proactive Customer Service Operations“ (com.snc.proactive_cs_itom) installiert ist.

    Datentyp: Objekt

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    Element.Health_Status.Display_value Textzeichenfolge des aktuellen Integritätsstatus des Installationsbasiselements. Verwenden Sie diesen Wert, um den Integritätsstatus in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Health_Status.value Interner Wert des Integritätsstatus des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Health_Status_Last_updated Datum und Uhrzeit der letzten Aktualisierung des Integritätsstatus für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Element.Haushalt Details zum Haushalt, der dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin Kundenservice-Haushalt (com.snc.Household) installiert ist.

    Datentyp: Objekt

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Haushalt.Anzeige_Wert Textname des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Haushaltsnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Haushalt.sys_ID SYS_ID des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.install_date Details zum Datum, an dem das Installationsbasiselement aktiv wurde.

    Datentyp: Objekt

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    item.install_date.display_value Textinstallationsdatum. Verwenden Sie diesen Wert, um das Installationsdatum in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.install_date.value Interner Wert des Installationsdatums.

    Datentyp: Zeichenfolge
    item.location Details zum Speicherort des Installationsbasiselements.

    Datentyp: Objekt

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Standort.Anzeige_Wert Textname des Installationsbasiselements-Standorts. Verwenden Sie diesen Wert, um den Standortnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Standort.sys_ID SYS_ID des Standortdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Nummer Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Element.übergeordnetes Element Details zum übergeordneten Datensatz des Installationsbasiselements-Datensatzes.

    Datentyp: Objekt

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.parent.Display_value Textname des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den übergeordneten Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.parent.sys_ID SYS_ID des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.product Details zum Produktmodell, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diese Informationen, um die Services zu identifizieren, die einem Produktmodell zugeordnet sind.

    Datentyp: Objekt

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    item.product.display_value Textname des Produktmodells, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Produktnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.product.sys_id SYS_ID des Produktmodelldatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.service_context Details zum Servicekontext, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.display_value Details zum Servicekontext, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.sys_id SYS_ID des Servicekontextdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.service_organization Details zur Serviceorganisation, die dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin „Serviceorganisation“ (com.snc.service_organization) installiert ist.

    Datentyp: Objekt

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_organization.display_value Textname der Serviceorganisation, die dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen der Serviceorganisation in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.service_organization.sys_id SYS_ID des Serviceorganisationsdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.sys_class_Name Tabelle, die den Installationsbasiselement-Datensatz enthält.

    Datentyp: Zeichenfolge
    Element.sys_ID SYS_ID des Installationsbasiselementdatensatzes. Befindet sich in der in angegebenen Tabelle sys_class_nameParameter.

    Datentyp: Zeichenfolge
    Item.sys_mod_count Gibt an, wie oft der zugehörige Installationsbasiselement-Datensatz geändert wurde.

    Datentyp: Zeichenfolge
    Element.Status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

    "state": {
  "display_value": "String",
  "value": "String"
}
    Element.Status.Display_Wert Textzeichenfolge des aktuellen Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Status Details zum Status des Installationsbasiselements.

    Datentyp: Objekt

    "status": {
  "display_value": "String",
  "value": "String"
}
    Element.Status.Display_value Textzeichenfolge des Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Deinstallationsdatum Details zum Datum, an dem das Installationsbasiselement inaktiv wurde.

    Datentyp: Objekt

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    Element.Uninstall_date.Display_value Datum der Textdeinstallation. Verwenden Sie diesen Wert, um das Deinstallationsdatum in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Uninstall_date.value Interner Wert des Deinstallationsdatums.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird. Das zugeordnete Installationsbasiselement hat keine untergeordneten Elemente.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitem/f77c7542b7343300ece839a6ee11a991" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0000901",
      "sys_id": "f77c7542b7343300ece839a6ee11a991",
      "product": {
        "sys_id": "8583ce8237732000158bbfc8bcbe5dd9",
        "display_value": "Fujitsu 1TB Hybrid Solid State Drive"
      },
      "active": "true",
      "name": "KX Series - KX5001",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    },
    "hasChildren": "false"
  }
}

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, wobei eine maximale Tiefe von vier untergeordneten Ebenen angegeben wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/e0a80e4b87b521100b6afc86dabb3565?depth=4" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0001073",
      "sys_id": "e0a80e4b87b521100b6afc86dabb3565",
      "health_status": {
        "value": "not_available",
        "display_value": "Not Available"
      },
      "active": "true",
      "name": "parent",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    },
    "hasChildren": "true",
    "childinstallbase": {
      "sysparm_depth": 2,
      "items": [
        {
          "parent": {
            "sys_id": "e0a80e4b87b521100b6afc86dabb3565",
            "display_value": "parent"
          },
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001074",
          "sys_id": "6db80e4b87b521100b6afc86dabb356b",
          "state": {
            "value": "in_use",
            "display_value": "In Use"
          },
          "health_status": {
            "value": "not_available",
            "display_value": "Not Available"
          },
          "active": "true",
          "name": "child1",
          "account": {
            "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
            "display_value": "Boxeo"
          },
          "hasChildren": "true",
          "items": {
            "sysparm_depth": 3,
            "items": [
              {
                "parent": {
                  "sys_id": "6db80e4b87b521100b6afc86dabb356b",
                  "display_value": "child1"
                },
                "sys_class_name": "sn_install_base_item",
                "number": "IBITM0001075",
                "sys_id": "36ecce4b87b521100b6afc86dabb3503",
                "health_status": {
                  "value": "not_available",
                  "display_value": "Not Available"
                },
                "active": "true",
                "name": "childL2",
                "account": {
                  "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
                  "display_value": "Boxeo"
                },
                "hasChildren": "false"
              }
            ]
          }
        }
      ]
    }
  }
}

    Installationsbasiselement – GET /sn_install_Base/Integrations/installbaseitems/{ID}/Cases

    Gibt die Fälle zurück, die einem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/Cases

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/Cases

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Feldname-Wert-Paare Feld-Wert-Paare, die zum Filtern der Falldatensätze verwendet werden sollen. Wenn Sie in eine andere Tabelle angeben sys_class_name, Geben Sie dann die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die Rückgabeergebnisse zu filtern.

    Um beispielsweise nur Datensätze zurückzugeben, bei denen das Genehmigungsfeld auf „abgelehnt“ und das Kategoriefeld auf „2“ festgelegt ist, übergeben Sie Folgendes: &Approval=rejected&category=2 .

    Datentyp: Zeichenfolge

    Tabelle: Fall [sn_customerservice_Case]

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer erweiterten Falltabelle (nicht sn_customerservice_Case) der Name der erweiterten Tabelle, die abgefragt werden soll.

    Datentyp: Zeichenfolge

    Standard: sn_customerservice_Case
    sysparm_limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden.

    Hinweis:
    Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 21. Anforderungstextparameter (XML oder 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 : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter 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.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Element Beschreibung
    Fälle Liste der Fälle, die dem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    Datentyp: Array von Objekten

    "cases": [
  {
    "account": "String",
    "active": Boolean,
    "active_account_escalation": "String",
    "active_escalation": "String",
    "activity_due": "String",
    "additional_assignee_list": "String",
    "approval": "String",
    "approval_history": "String",
    "approval_set": "String",
    "asset": "String",
    "assigned_on": "String",
    "assigned_to": "String",
    "assignment_group": "String",
    "auto_close": Boolean,
    "business_duration": "String",
    "business_impact": "String",
    "business_service": "String",
    "calendar_duration": "String",
    "case": "String",
    "case_report": "String",
    "category": Number,
    "cause": "String",
    "caused_by": "String",
    "change": "String",
    "child_case_creation_progress": Boolean,
    "closed_at": "String",
    "closed_by": "String",
    "close_notes: "String",
    "cmdb_ci": "String",
    "comments": "String",
    "comments_and_work_notes": "String",
    "company": "String",
    "consumer": "String",
    "contact": "String",
    "contact_local_time: "String",
    "contact_time_zone": "String",
    "contact_type": "String",
    "contract": "String",
    "contributor_groups": "String",
    "contributor_users": "String",
    "correlation_display": "String",
    "correlation_id": "String",
    "delivery_plan": "String",
    "delivery_task": "String",
    "description": "string",
    "due_date": "String",
    "entitlement": "String",
    "escalation": Number,
    "expected_start": "String",
    "first_response_time": "String",
    "follow_the_sun": Boolean,
    "follow_up": "String",
    "group_list": [Array],
    "impact": Number,
    "internal_user": "String",
    "initiated_as_request": Boolean,
    "knowledge": Boolean,
    "location": "String",
    "made_sla": Boolean,
    "major_case_state": "String",
    "needs_attention": Boolean,
    "notes_to_comments": Boolean,
    "notify": Number,
    "number": "String",
    "opened_at": "String",
    "opened_by": "String",
    "order": Number,
    "parent": "String",
    "partner": "String",
    "partner_contact": "String",
    "priority": Number,
    "proactive": Boolean,
    "probable_cause": "String",
    "problem": "String",
    "product": "String",
    "reassignment_count": Number,
    "recipient_list": "String",
    "rejection_goto": "String",
    "resolution_code": "String",
    "resolved_at": "String",
    "resolved_by": "String",
    "route_reason": "String",
    "service_offering": "String",
    "short_description": "String",
    "skills": "String",
    "sla_due": "String",
    "sn_app_cs_social_social_profile": "String",
    "sold_product": "String",
    "stage": "String",
    "state": Number,
    "subcategory": Number,
    "support_manager" "String",
    "sync_driver": Boolean,
    "sys_class_name": "String",
    "sys_domain": "String",
    "sys_domain_path": "String",
    "sys_id": "String",
    "task_effective_number": "String",
    "time_worked": "String",
    "universal_request": "String",
    "upon_approval": "String",
    "upon_reject": "String",
    "urgency": Number,
    "user_input": "String",
    "variables":  "String",
    "watch_list": [Array],
    "wf_activity": "String",
    "work_end": "String",
    "work_notes": "String",
    "work_notes_list": [Array],
    "work_start": "String"
    Fälle.Account
    SYS_ID des Account-Datensatzes, der dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account]
    Fälle.aktiv Kennzeichnung, die angibt, ob der Fall offen und aktiv ist.

    Mögliche Werte:

    • Wahr: Fall ist aktiv
    • Falsch: Fall ist geschlossen

    Datentyp: Boolesch

    Standardwert: wahr
    Fälle.Active_Account_Eskalation SYS_ID des aktiven Account-Eskalationsdatensatzes, der dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Eskalation [sn_customerservice_Eskalation]
    Fälle.Active_Eskalation SYS_ID des aktiven Eskalationsdatensatzes, der dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Eskalation [sn_customerservice_Eskalation]
    Fälle.Activity_due Datum, für das der zugehörige Fall voraussichtlich abgeschlossen sein wird.

    Datentyp: Zeichenfolge
    Fälle.zusätzliche_Beauftragte_Liste Liste der sys_IDs der zusätzlichen Personen (mit Ausnahme des primären Beauftragten), die dem Account zugewiesen wurden.

    Datentyp: Array

    Maximum: 4.000

    Tabelle: Benutzer [sys_user]
    Fälle.Genehmigung Zeichenfolge, die den Typ der erforderlichen Genehmigung beschreibt.

    Mögliche Werte:

    • genehmigt
    • Abgebrochen
    • Duplikat
    • Not_required
    • Nicht angefordert
    • abgelehnt
    • Angefordert

    Datentyp: Zeichenfolge

    Maximal Zeichen: 40

    Standard: Nicht angefordert
    Fälle.Approval_history Liste aller Genehmigungen, die dem Fall zugeordnet sind.

    Datentyp: Zeichenfolge

    Maximal Zeichen: 4.000
    Fälle.Approval_Set Datum und Uhrzeit der Genehmigung der zugehörigen Aktion.

    Datentyp: Zeichenfolge
    Fälle.Asset SYS_ID des Asset-Datensatzes, der dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Asset [alm_Asset]
    Fälle.assigned_on Datum und Uhrzeit, zu der der Fall der in identifizierten Person zugewiesen wurde assigned_toParameter.

    Datentyp: Zeichenfolge (Datum)

    Maximale Länge: 40
    Fälle.assigned_to
    SYS_ID der Person, die dem Fall zugewiesen ist.

    Tabelle: Benutzer [sys_user]

    Datentyp: Zeichenfolge
    Fälle.Zuweisungsgruppe SYS_ID der Kundenservice-Mitarbeitergruppe, die dem Fall zugewiesen ist.

    Datentyp: Zeichenfolge

    Tabelle: Gruppe [sys_user_group]
    cases.auto_close Kennzeichnung, die angibt, ob der Fall automatisch geschlossen wurde.

    Mögliche Werte:

    • Wahr: Fall wurde automatisch geschlossen
    • Falsch: Fall wurde nicht automatisch geschlossen

    Datentyp: Boolesch

    Standardwert: false
    Fälle.Business_duration Dauer in Kalenderarbeitsstunden, Arbeitstagen und Arbeitswochen, die zum Abschließen des Falls benötigt wurde.

    Datentyp: Zeichenfolge
    Fälle.Business_Impact Auswirkung des Problems auf den zugehörigen Kunden.

    Datentyp: Zeichenfolge

    Maximal Zeichen: 4.000
    Fälle.Business_Service SYS_ID des Servicedatensatzes, der dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Service [cmdb_ci_Service]
    cases.calendar_duration Dauer in Kalenderstunden, Tagen und Wochen, die zum Abschluss des Falls benötigt wurde.

    Datentyp: Zeichenfolge (Dauer)

    Maximale Länge: 40
    cases.case Kurzbeschreibung des Falls und Fallnummer.

    Datentyp: Zeichenfolge

    Maximale Länge: 300
    cases.case_report SYS_ID des zugehörigen Fallberichts.

    Datentyp: Zeichenfolge

    Tabelle: Fallbericht [sn_customerservice_Case_Report]
    cases.category Fallkategorie.

    Mögliche Werte:

    • 0: Frage
    • 1: Problem
    • 2: Funktion

    Datentyp: Zahl (Ganzzahl)

    Standard: 1
    cases.cause Details zur Ursache des Problems.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    cases.caused_by SYS_ID der Change-Anforderung, die die Erstellung des Falls verursacht hat.

    Datentyp: Zeichenfolge

    Tabelle: Change Request [change_request]
    cases.change SYS_ID der Change-Anforderung, die die Erstellung des Falls verursacht hat.

    Datentyp: Zeichenfolge

    Tabelle: Change Request [change_request]
    cases.child_case_creation_progress Kennzeichnung, die angibt, ob der Fall ein untergeordneter Fall ist, der aus einem schwerwiegenden Fall erstellt wurde.

    Mögliche Werte:

    • Wahr: Untergeordneter Fall, der aus einem schwerwiegenden Fall erstellt wurde
    • Falsch: Kein untergeordneter Fall

    Datentyp: Boolesch
    Fälle.Closed_at Datum und Uhrzeit, zu der der Fall geschlossen wurde.

    Datentyp: Zeichenfolge
    Fälle.Closed_by SYS_ID des Anwenders, der den Fall geschlossen hat.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    Fälle.CLOSE_Notes Notizen, die beim Schließen des Falls gemacht wurden.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    Fälle.cmdb_ci SYS_ID des Konfigurationselements, das dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Konfigurationselement [cmdb_ci]
    cases.comments Zusätzliche Kommentare zum Fall.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    cases.comments_and_work_notes Kommentare und Arbeitsnotizen, die für den Fall eingegeben wurden.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    cases.company SYS_ID des Unternehmens, das dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Unternehmen [Core_Company]
    Fälle.Verbraucher Nur Business-to-Consumer-Fälle. SYS_ID der Person, die in Bezug auf diesen Fall kontaktiert werden soll.

    Datentyp: Zeichenfolge

    Tabelle: Verbraucher [csm_Consumer]
    Fälle.Kontakt Nur Business-to-Business-basierte Fälle. SYS_ID der Person, die bezüglich dieses Falls kontaktiert werden soll.

    Datentyp: Zeichenfolge

    Tabelle: Kontakt [Customer_contact]
    Fälle.Contact_local_time Ortszeit des Kontakts.

    Datentyp: Zeichenfolge

    Maximale Länge: 70
    Fälle.Contact_time_Zone Zeitzone des Kontakts, der dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    Fälle.Contact_type Methode, mit der der Fall ursprünglich gemeldet wurde.
    Mögliche Werte:
    • Chat
    • E-Mail
    • Telefon
    • Social Media
    • Web

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    Fälle.Vertrag SYS_ID des Vertrags, der dem Fall zugeordnet ist. Dieser Vertrag enthält Informationen über die Art des Supports, der dem Fall zugehöriges Unternehmen bereitgestellt wird. Ein Vertrag kann ein Unternehmen und einen Kontakt sowie die spezifischen Assets enthalten, die abgedeckt werden. Ein Vertrag kann außerdem mehrere Serviceberechtigungen und SLAs enthalten.

    Datentyp: Zeichenfolge

    Tabelle: Vertrag [ast_contract]
    Fälle.Beitragender_Gruppen Liste der sys_IDs der Anwendergruppen, die zum Fall beigetragen haben.

    Datentyp: Zeichenfolge

    Tabelle: Gruppe [sys_user_group]
    Fälle.Beitragender_Anwender Liste der sys_IDs der Anwender, die zum Fall beigetragen haben.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    Fälle.Korrelation_Anzeige Korrelationsanzeige.

    Datentyp: Zeichenfolge

    Maximale Länge: 100
    Fälle.Korrelation_ID Korrelationsbezeichner.

    Datentyp: Zeichenfolge

    Maximale Länge: 100
    cases.delivery_plan SYS_ID des übergeordneten Ausführungsplans für diesen Fall.

    Datentyp: Zeichenfolge

    Tabelle: Ausführungsplan [sc_Cat_item_Delivery_Plan]
    cases.delivery_task SYS_ID der Ausführungsplanaufgabe.

    Datentyp: Zeichenfolge

    Tabelle: Ausführungsplanaufgabe [sc_Cat_item_Delivery_Task]
    cases.description Detaillierte Beschreibung des Problems, das dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    Fälle.due_date Datum, an dem der Fall geschlossen werden soll.

    Datentyp: Zeichenfolge
    Fälle.Berechtigung SYS_ID des Berechtigungsdatensatzes, der dem Fall zugeordnet ist. Berechtigungen definieren die Art des Supports, den ein Kunde erhält, sowie die unterstützten Kommunikationskanäle. Eine Berechtigung kann einem Produkt, einem Asset, einem Account oder einem Vertrag zugeordnet werden.

    Datentyp: Zeichenfolge

    Tabelle: Berechtigung [Service_entitlement]
    cases.escalation Aktuelle Eskalationsebene.

    Mögliche Werte:

    • 0: Normal
    • 1: Mittel
    • 2: Hoch
    • 3: Überfällig

    Datentyp: Zahl (Ganzzahl)

    Standard: 0
    Fälle.expected_Start Datum und Uhrzeit, zu der die Arbeit am Fall beginnen soll.

    Datentyp: Zeichenfolge
    Cases.first_response_time Datum und Uhrzeit, zu der die erste Aktion für den Fall ausgeführt wurde.

    Datentyp: Zeichenfolge
    Fälle.Follow_the_Sun Kennzeichnung, die angibt, ob der Fall zur globalen Nachverfolgung übergeben werden soll.

    Wenn ein Kunde zusätzliche Kommentare zu einem Fall mit Priorität 1 – Kritisch oder einem Fall mit Priorität 2 – hoch eingibt oder der Fall eskaliert wird, wird die Kennzeichnung automatisch auf „wahr“ festgelegt.

    Mögliche Werte:

    • Wahr: Fall muss zur globalen Nachverfolgung übergeben werden
    • Falsch: Fall darf nicht zur globalen Nachverfolgung übergeben werden

    Datentyp: Boolesch

    Standardwert: false
    Fälle.Follow_up Datum und Uhrzeit der nächsten Folgeaktion.

    Datentyp: Zeichenfolge
    cases.group_list Liste der sys_IDs der Gruppendatensätze, die dem Fall zugeordnet sind.

    Datentyp: Array

    Tabelle: Gruppe [sys_user_group]
    Fälle.Auswirkung Auswirkung auf den Kunden.

    Mögliche Werte:

    • 1: Hoch
    • 2: Mittel
    • 3: Niedrig

    Datentyp: Zahl (Ganzzahl)

    Standard: 3
    cases.internal_user SYS_ID des internen Anwenders für diesen Fall.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    cases.initiated_as_request Kennzeichnung, die angibt, ob diese Anfrage als Anforderung vom Kunden initiiert wurde.

    Mögliche Werte:

    • Wahr: Anfrage vom Kunden initiiert.
    • Falsch: Anfrage wurde nicht vom Kunden initiiert.

    Datentyp: Boolesch

    Standardwert: false
    Fälle.Wissen Kennzeichnung, die angibt, ob für das angegebene Problem ein Knowledge Base-artikel verfügbar ist.

    Mögliche Werte:

    • Wahr: Knowledge Base-artikel ist für dieses Problem verfügbar
    • Falsch: Knowledge Base-artikel ist für dieses Problem nicht verfügbar

    Datentyp: Boolesch

    Standardwert: false
    Fälle.Standort SYS_ID des Datensatzes, der den Unternehmensstandort beschreibt.

    Datentyp: Zeichenfolge

    Tabelle: Standort [cmn_location]
    Fälle.Made_sla Kennzeichnung, die angibt, ob der Fall in Übereinstimmung mit der zugehörigen Servicelevel-Vereinbarung gelöst wurde.

    Mögliche Werte:

    • Wahr: Fall wurde in Übereinstimmung mit SLA gelöst
    • Falsch: Fall wurde nicht gemäß SLA gelöst

    Datentyp: Boolesch

    Standardwert: wahr
    Fälle.Major_Case_State Aktueller Status des schwerwiegenden Falls.

    Mögliche Werte:

    • Akzeptiert: Anfangsstatus, wenn ein Manager einen schwerwiegenden Fall erstellt oder wenn ein Manager einen Kandidatenfall hochgestuft.
    • Abgebrochen: Fall wurde abgebrochen.
    • Vorgeschlagen: Anfangsstatus, wenn ein Service Desk-Mitarbeiter oder Manager einen Kandidatenfall erstellt oder vorschlägt.
    • Abgelehnt: Manager hat Kandidatenfall abgelehnt.

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    Needs_Attention Kennzeichnung, die angibt, ob für den Fall Handlungsbedarf besteht.

    Mögliche Werte:

    • Wahr: Fall erfordert zusätzliche Aufmerksamkeit
    • Falsch: Fall erfordert keine zusätzliche Aufmerksamkeit

    Datentyp: Boolesch

    Standardwert: false
    cases.notes_to_comments Kennzeichnung, die angibt, ob den Kommentaren die Lösungshinweise hinzugefügt werden sollen.

    Mögliche Werte:

    • Wahr: Lösungsnotizen werden den Kommentaren ebenfalls hinzugefügt, wenn sie hinzugefügt werden
    • Falsch: Lösungshinweise in Kommentaren sind nicht erforderlich

    Datentyp: Boolesch
    cases.notify Methode zur Benachrichtigung des Kontakts/Verbrauchers.

    Mögliche Werte:

    • 1: Nicht benachrichtigen
    • 2: E-Mail senden
    • 3: Telefon

    Datentyp: Zahl (Ganzzahl)

    Standard: 1
    Fälle.Nummer Fallnummer.

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    Fälle.opened_at Datum und Uhrzeit der Öffnung des Falls.

    Datentyp: Zeichenfolge
    Fälle.opened_by SYS_ID der Person, die den Fall ursprünglich geöffnet hat.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    Fälle.Auftrag Reihenfolge des Falls.

    Datentyp: Zahl (Ganzzahl)
    Fälle.übergeordnet SYS_ID des übergeordneten Falls, dem dieser Fall (untergeordnetes Element) zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Aufgabe [Aufgabe]
    Fälle.Partner SYS_ID des Partners, der dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account]
    Fälle.Partner_contact SYS_ID des Partnerkontakts, der dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Kontakt [Customer_contact]
    Fälle.Priorität Priorität des Falls.
    Mögliche Werte:
    • 1: Kritisch
    • 2: Hoch
    • 3: Mittel
    • 4: Niedrig

    Datentyp: Zahl (Ganzzahl)

    Standard: 4
    cases.proactive Kennzeichnung, die angibt, ob die Anfrage proaktiv überwacht wird.

    Mögliche Werte:

    • Wahr: Wird proaktiv überwacht.
    • Falsch: Wird nicht überwacht.

    Datentyp: Boolesch

    Standard: Falsch
    cases.probable_cause Mögliche Ursache des Problems, das dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    cases.problem SYS_ID des Problems, auf das der Kunde stößt.

    Datentyp: Zeichenfolge

    Tabelle: Problem [problem]
    cases.product SYS_ID des Produktmodells des Assets, das dem Fall zugeordnet ist. Ein Modell ist eine bestimmte Version oder Konfiguration eines Assets (z. B. Apple Mac Book Pro).

    Datentyp: Zeichenfolge

    Tabelle: Produktmodell [cmdb_model]
    Fälle.reassignment_count Anzahl der Neuzuweisungen des Falls an eine Person, die für die Weiterleitung des Falls verantwortlich ist.

    Datentyp: Zahl (Ganzzahl)

    Standard: 0
    Fälle.Empfänger_Liste SYS_ID des Datensatzes, der die Liste der Empfänger für die Kommunikation zu diesem Fall enthält.

    Datentyp: Zeichenfolge

    Tabelle: Empfängerliste [sn_publications_Receivers_list]
    Fälle.Ablehnung_gehe zu SYS_ID der auszuführenden Aufgabe, wenn der Fall abgelehnt wird.

    Datentyp: Zeichenfolge

    Tabelle: Aufgabe [Aufgabe]
    Fälle.Resolution_Code Lösungsstatus für den Fall, z. B. „gelöst – behoben durch Support/Anleitung bereitgestellt“.

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    Fälle.gelöst_um Datum und Uhrzeit der Lösung des Falls.

    Datentyp: Zeichenfolge
    Fälle.gelöst_von SYS_ID der Person, die den Fall gelöst hat.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    Fälle.Route_reason Grund, warum der Fall an einen anderen Beauftragten weitergeleitet wurde.

    Datentyp: Zahl (Ganzzahl)

    Maximale Länge: 40
    cases.service_offering SYS_ID des Serviceangebots, das der Zahlungsanfrage zugeordnet ist. Serviceangebote definieren das Servicelevel in Bezug auf Verfügbarkeit, Umfang, Preise und Verpackungsoptionen eindeutig.

    Datentyp: Zeichenfolge

    Tabelle: Serviceangebot [service_offering]
    Fälle.short_description Kurze Beschreibung des Falls.

    Datentyp: Zeichenfolge

    Maximale Länge: 160
    Fälle.Kompetenzen Liste der eindeutigen Bezeichner (sys_ID) der Kompetenzen, die zum Abschließen des Falls erforderlich sind.

    Datentyp: Zeichenfolge

    Tabelle: Kompetenz [cmn_Skill]
    Fälle.sla_fällig Datum/Uhrzeit, zu der der Fall basierend auf der zugehörigen Servicelevel-Vereinbarung geschlossen werden muss.

    Datentyp: Zeichenfolge
    Cases.sn_App_cs_Social_Profile SYS_ID des Social-Media-Profils, das dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Social Profile [sn_App_cs_Social_Profile]
    Fälle.sold_Product SYS_ID des zugeordneten Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Verkauftes Produkt [sn_install_Base_sold_Product]
    Fälle.Phase Phase der Anfrage, z. B. „Abgeschlossen“, „als abgelehnt geschlossen“, „Dokumentprüfung“, „Autorisierung“ usw.

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    Fälle.Status Der aktuelle Status des Falls

    Mögliche Werte:

    • 1: Neu
    • 3: Geschlossen
    • 6: Gelöst
    • 10: Offen
    • 18: Warten Auf Informationen

    Datentyp: Zahl (Ganzzahl)

    Standard: 1
    Fälle.Unterkategorie Fallunterkategorie.

    Mögliche Werte:

    0: Frage

    Datentyp: Zahl (Ganzzahl)

    Standard: 0
    Fälle.Support_Manager SYS_ID des CSM-Managers, der dem Fall zugewiesen ist.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    Fälle.Sync_Driver Kennzeichnung, die angibt, ob eine Treibersynchronisierung vorhanden ist.

    Mögliche Werte:

    • Wahr: Treiber ist synchronisiert
    • Falsch: Treiber ist nicht synchronisiert

    Datentyp: Boolesch
    Fälle.sys_class_Name Tabelle, die den Falldatensatz enthält.

    Datentyp: Zeichenfolge

    Maximale Länge: 80
    Fälle.sys_Domain Domäne, die dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Maximale Länge: 32

    Standard: Global
    Fälle.sys_Domain_path Domänenpfad.

    Datentyp: Zeichenfolge

    Maximale Länge: 255

    Standard: /
    Fälle.sys_ID Eindeutiger Bezeichner für den Fall.

    Datentyp: Zeichenfolge

    Maximale Länge: 32
    Fälle.Task_Effective_number Identifizierungsnummer.

    Wenn der Aufgabe eine Universal-Anforderung zugeordnet ist, ist dies die Ur-Nummer. Andernfalls ist es die aktuelle Aufgabennummer.

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    Fälle.Zeit_gearbeitet Gesamtzeit, die für den Fall gearbeitet wurde.

    Datentyp: Zeichenfolge
    Fälle.Universal_Request SYS_ID einer Universal-Aufgabe, zu der diese Anfrage gehört.

    Datentyp: Zeichenfolge

    Tabelle: Aufgabe [Aufgabe]
    Fälle.on_Approval Aktion, die ausgeführt werden soll, wenn der Fall genehmigt wird.

    Mögliche Werte:

    • Do_no
    • Fahren Sie fort

    Datentyp: Zeichenfolge

    Maximale Länge: 40

    Standard: Fortfahren
    Fälle.bei_ablehnen Aktion, die ausgeführt werden soll, wenn der Fall abgelehnt wird.

    Mögliche Werte:

    • abbrechen
    • goto

    Datentyp: Zeichenfolge

    Maximale Länge: 40

    Standard: Abbrechen
    Fälle.Dringlichkeit Dringlichkeit des Falls.

    Mögliche Werte:

    • 1: Hoch
    • 2: Mittel
    • 3: Niedrig

    Datentyp: Zahl (Ganzzahl)

    Standard: 3
    cases.user_input Zusätzliche Anwendereingabe.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    Fälle.Variablen Name-Wert-Paare von Variablen, die dem Fall zugeordnet sind.

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    Fälle.watch_list Liste der sys_IDs der Anwender, die Benachrichtigungen zu diesem Fall erhalten, wenn zusätzliche Kommentare hinzugefügt werden oder wenn der Status eines Falls in „gelöst“ oder „Geschlossen“ geändert wird.

    Datentyp: Array

    Tabelle: Benutzer [sys_user]
    Cases.wf_activity SYS_ID des Workflow-Aktivitätsdatensatzes, der dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Workflow-Aktivität [wf_activity]
    Fälle.Arbeit_Ende Datum und Uhrzeit des Beendens der Arbeit am Fall.

    Datentyp: Zeichenfolge
    Fälle.Arbeitsnotizen Informationen darüber, wie der Fall gelöst werden kann, oder Schritte zur Lösung des Falls.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    Fälle.Work_Notes_list Liste der sys_IDs der internen Anwender, die Benachrichtigungen zu diesem Fall erhalten, wenn Arbeitsnotizen hinzugefügt werden.

    Datentyp: Array

    Tabelle: Benutzer [sys_user]
    Fälle.Arbeit_Start Datum und Uhrzeit des Beginns der Arbeit am Fall.

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze zurückgegeben werden sollen.
    Mögliche Werte:
    • Wahr: Weitere zurückzugebende Datensätze.
    • Falsch: Keine weiteren Datensätze zum Rückgeben vorhanden.

    Datentyp: Boolesche Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sysparm_limit
    Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    In der Antwort der boolesche Parameter hasMoreWird zurückgegeben. Gibt an, ob weitere zurückzugebende Datensätze vorhanden sind, die die Filterkriterien erfüllen.

    Datentyp: Zahl

    Standard: 10
    sysparm_offset
    Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl im Parameter sysparm_offset.

    Datentyp: Zahl

    Standard: 0

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/1474a3c853500010df5dddeeff7b12ec/cases" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "cases": [
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001034",
        "initiated_as_request": "0",
        "state": "1",
        "case": "Performance is impacted with latest update​CS0001034",
        "knowledge": "0",
        "impact": "3",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "0",
        "short_description": "Performance is impacted with latest update",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001034",
        "opened_by": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "follow_the_sun": "0",
        "entitlement": {
          "sys_id": "1eb7893a6f1b31003b3c498f5d3ee4dd",
          "display_value": "24x7 Customer Support"
        },
        "opened_at": {
          "value": "2023-03-20 14:53:51",
          "display_value": "2023-03-20 07:53:51"
        },
        "case_report": {
          "sys_id": "85e8604c87f521100b6afc86dabb35b9",
          "display_value": "CSR0010014"
        },
        "subcategory": "0",
        "install_base": {
          "sys_id": "1474a3c853500010df5dddeeff7b12ec",
          "display_value": "Boxeo - Development"
        },
        "proactive": "0",
        "auto_close": "0",
        "sys_id": "92c8684087b521105d0055373cbb357e",
        "contact_type": {
          "value": "web",
          "display_value": "Web"
        },
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001008",
        "initiated_as_request": "0",
        "state": "1",
        "case": "Test Alert​CS0001008",
        "knowledge": "0",
        "impact": "3",
        "active": "1",
        "auto_created_case": "0",
        "priority": "1",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "1",
        "short_description": "Test Alert",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001008",
        "opened_by": {
          "sys_id": "08c83021acbe7300964fca436af2bb97",
          "display_value": "noc_operator "
        },
        "follow_the_sun": "0",
        "opened_at": {
          "value": "2023-03-15 08:02:58",
          "display_value": "2023-03-15 01:02:58"
        },
        "case_report": {
          "sys_id": "a4fa9d9a872d61105d0055373cbb356e",
          "display_value": "CSR0010005"
        },
        "subcategory": "0",
        "proactive": "1",
        "auto_close": "0",
        "sys_id": "60ea199a872d61105d0055373cbb35c9",
        "contact_type": {
          "value": "proactive",
          "display_value": "Alert"
        },
        "alert": {
          "sys_id": "506a559a872d61105d0055373cbb3581",
          "display_value": "Alert0010008"
        },
        "urgency": "3",
        "action_status": "4",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1"
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001033",
        "initiated_as_request": "0",
        "state": "1",
        "case": "System is down​CS0001033",
        "knowledge": "0",
        "impact": "3",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "0",
        "short_description": "System is down",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001033",
        "opened_by": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "follow_the_sun": "0",
        "entitlement": {
          "sys_id": "1eb7893a6f1b31003b3c498f5d3ee4dd",
          "display_value": "24x7 Customer Support"
        },
        "opened_at": {
          "value": "2023-03-20 14:52:48",
          "display_value": "2023-03-20 07:52:48"
        },
        "case_report": {
          "sys_id": "64b86c0c87f521100b6afc86dabb35fc",
          "display_value": "CSR0010013"
        },
        "subcategory": "0",
        "install_base": {
          "sys_id": "1474a3c853500010df5dddeeff7b12ec",
          "display_value": "Boxeo - Development"
        },
        "proactive": "0",
        "auto_close": "0",
        "sys_id": "7c98a04087b521105d0055373cbb352e",
        "contact_type": {
          "value": "web",
          "display_value": "Web"
        },
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      },
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "CS0001048",
        "initiated_as_request": "0",
        "state": "1",
        "case": "AIB with Single account​CS0001048",
        "knowledge": "0",
        "impact": "3",
        "active": "1",
        "auto_created_case": "0",
        "priority": "4",
        "sys_domain_path": "/",
        "child_case_creation_progress": "0",
        "sync_driver": "0",
        "needs_attention": "1",
        "short_description": "AIB with Single account",
        "notify": "1",
        "sys_class_name": "sn_customerservice_case",
        "reassignment_count": "0",
        "notes_to_comments": "0",
        "hierarchical_variables": "variable_pool",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "made_sla": "1",
        "task_effective_number": "CS0001048",
        "opened_by": {
          "sys_id": "08c83021acbe7300964fca436af2bb97",
          "display_value": "noc_operator "
        },
        "contact": {
          "sys_id": "4d147a386f0331003b3c498f5d3ee437",
          "display_value": "Julie Lewis"
        },
        "follow_the_sun": "0",
        "opened_at": {
          "value": "2023-03-24 03:28:58",
          "display_value": "2023-03-23 20:28:58"
        },
        "case_report": {
          "sys_id": "4082be81877161100b6afc86dabb35fe",
          "display_value": "CSR0010023"
        },
        "subcategory": "0",
        "proactive": "1",
        "auto_close": "0",
        "sys_id": "6a723e81877161100b6afc86dabb35cf",
        "contact_type": {
          "value": "proactive",
          "display_value": "Alert"
        },
        "alert": {
          "sys_id": "6b227681877161100b6afc86dabb35d5",
          "display_value": "Alert0010094"
        },
        "urgency": "3",
        "action_status": "4",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "category": "1",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Installationsbasiselement – GET /sn_install_Base/Integrations/installbaseitems/{ID}/childinstallbaseitems

    Gibt die untergeordneten Installationsbasiselemente zurück, die einem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/childinstallbaseitems

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/childinstallbaseitems

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Feldname-Wert-Paare Feld-Wert-Paare, die zum Filtern der Datensätze des untergeordneten Installationsbasiselements verwendet werden sollen.wenn Sie eine andere Tabelle in angeben sys_class_name, Geben Sie dann die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die Rückgabeergebnisse zu filtern.

    Um beispielsweise nur Datensätze zurückzugeben, bei denen das Statusfeld auf „in_use“ und das Statusfeld auf „Ersatz“ festgelegt ist, übergeben Sie Folgendes: &State=in_use&Status=Ersatz .

    Datentyp: Zeichenfolge

    Standard: Alle Felder

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    sys_class_name Bei Verwendung einer erweiterten Installationsbasiselementtabelle (nicht sn_install_Base_item) der Name der erweiterten Tabelle, die abgefragt werden soll.

    Datentyp: Zeichenfolge

    Standard: sn_install_Base_item
    sysparm_limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden.

    Hinweis:
    Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 27. Anforderungstextparameter (XML oder 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 : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 29. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze zurückgegeben werden sollen.
    Mögliche Werte:
    • Wahr: Weitere zurückzugebende Datensätze.
    • Falsch: Keine weiteren Datensätze zum Rückgeben vorhanden.

    Datentyp: Boolesche Zeichenfolge
    items Liste der Installationsbasiselemente, die den angegebenen Filterergebnissen entsprechen.

    Datentyp: Array von Objekten

    "items":[
  {
    "account": {Object},
    "active": "String",
    "asset": {Object},
    "configuration_item": {Object},
    "consumer": {Object},
    "consumer_profile": {Object},
    "contact": {Object},
    "health_status": {Object},
    "health_status_last_updated": "String",
    "household": {Object},
    "install_date": {Object},
    "location": {Object},
    "name": "String",
    "number": "String",
    "parent": {Object},
    "product": {Object},
    "service_context": {Object},
    "service_organization" {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "sys_mod_count": "String",
    "state": {Object},
    "status": {Object},
    "uninstall_date": "String"
  }
]
    Elemente.Account Details zum Kunden-Account, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    Items.Account.Display_value Textname des Kunden-Accounts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Kundenaccounts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Account.sys_ID SYS_ID des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Elemente.aktiv Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • Wahr: Installationsbasiselement ist aktiv.
    • Falsch: Installationsbasiselement ist inaktiv.

    Datentyp: Boolesche Zeichenfolge
    Elemente.Asset Details zum Asset, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    Elements.Asset.Display_value Textname des Assets, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Asset-Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Asset.sys_ID SYS_ID des Asset-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Elements.Configuration_item Details zum Konfigurationselement, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    Elements.Configuration_item.Display_value Textname des Konfigurationselements, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Konfigurationselements in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Configuration_item.sys_ID SYS_ID des Konfigurationselementdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Artikel.Verbraucher Details zum Verbraucher, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucher ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    Elemente.Verbraucher.Anzeige_Wert Textname des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Verbrauchernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Items.Consumer.sys_ID SYS_ID des Verbraucherdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Elements.Consumer_Profile Details zum Verbraucherprofil, das dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucherprofil ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    Items.Consumer_Profile.Display_value Textname des Verbraucherprofils, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Verbraucherprofils in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Consumer_Profile.sys_ID SYS_ID des Verbraucherprofildatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Elemente.Kontakt Details zum Account-Kontakt, der für den Installationsbasiselement-Datensatz verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    Elements.Kontakt.Display_value Textname des Accountkontakts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Account-Kontakts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Contact.sys_ID SYS_ID des Account-Kontaktdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Elements.Health_Status Details zum aktuellen Integritätsstatus des Installationsbasiselements. Wird nur zurückgegeben, wenn das Plugin „Proactive Customer Service Operations“ (com.snc.proactive_cs_itom) installiert ist.

    Datentyp: Objekt

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    Elements.Health_Status.Display_value Textzeichenfolge des aktuellen Integritätsstatus des Installationsbasiselements. Verwenden Sie diesen Wert, um den Integritätsstatus in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.Health_Status.value Interner Wert des Integritätsstatus des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Elements.Health_Status_Last_updated Datum und Uhrzeit der letzten Aktualisierung des Integritätsstatus für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Artikel.Haushalt Details zum Haushalt, der dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin Kundenservice-Haushalt (com.snc.Household) installiert ist.

    Datentyp: Objekt

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    Artikel.Haushalt.Anzeige_Wert Textname des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Haushaltsnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elemente.Haushalt.sys_ID SYS_ID des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.install_date Details zum Datum, an dem das Installationsbasiselement aktiv wurde.

    Datentyp: Objekt

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    items.install_date.display_value Textinstallationsdatum. Verwenden Sie diesen Wert, um das Installationsdatum in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.install_date.value Interner Wert des Installationsdatums.

    Datentyp: Zeichenfolge
    Elemente.Standort Details zum Speicherort des Installationsbasiselements.

    Datentyp: Objekt

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    Elements.location.Display_value Textname des Installationsbasiselements-Standorts. Verwenden Sie diesen Wert, um den Standortnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.location.sys_ID SYS_ID des Standortdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Elemente.Nummer Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Elemente.übergeordnet Details zum übergeordneten Datensatz des Installationsbasiselements-Datensatzes.

    Datentyp: Objekt

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    Elements.parent.Display_value Textname des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den übergeordneten Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elements.parent.sys_ID SYS_ID des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.product Details zum Produktmodell, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diese Informationen, um die Services zu identifizieren, die einem Produktmodell zugeordnet sind.

    Datentyp: Objekt

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    items.product.display_value Textname des Produktmodells, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Produktnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.product.sys_id SYS_ID des Produktmodelldatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.service_context Details zum Servicekontext, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    items.service_context.display_value Textname des Servicekontexts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Servicekontextnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.service_context.sys_id SYS_ID des Servicekontextdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.service_organization Details zur Serviceorganisation, die dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin „Serviceorganisation“ (com.snc.service_organization) installiert ist.

    Datentyp: Objekt

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    items.service_organization.display_value Textname der Serviceorganisation, die dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen der Serviceorganisation in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.service_organization.sys_id SYS_ID des Serviceorganisationsdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Items.sys_class_Name Tabelle, die den Installationsbasiselement-Datensatz enthält.

    Datentyp: Zeichenfolge
    Elements.sys_ID SYS_ID des Installationsbasiselementdatensatzes. Befindet sich in der in angegebenen Tabelle sys_class_nameParameter.

    Datentyp: Zeichenfolge
    Items.sys_mod_count Gibt an, wie oft der zugehörige Installationsbasiselement-Datensatz geändert wurde.

    Datentyp: Zeichenfolge
    Elemente.Status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

    "state": {
  "display_value": "String",
  "value": "String"
}
    Elements.Status.Display_value Textzeichenfolge des aktuellen Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elemente.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Elemente.Status Details zum Status des Installationsbasiselements.

    Datentyp: Objekt

    "status": {
  "display_value": "String",
  "value": "String"
}
    Elements.Status.Display_value Textzeichenfolge des Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Elemente.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Items.Deinstallation_date Details zum Datum, an dem das Installationsbasiselement inaktiv wurde.

    Datentyp: Objekt

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    Items.Deinstallation_date.Display_value Datum der Textdeinstallation. Verwenden Sie diesen Wert, um das Deinstallationsdatum in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Items.Deinstallation_date.value Interner Wert des Deinstallationsdatums.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    Sysparm_depth Anzahl der Ebenen, die das zurückgegebene untergeordnete Installationsbasiselement in der Hierarchie enthalten ist.

    Datentyp: Ganzzahl
    sysparm_limit Anzahl der zurückgegebenen Datensätze. Wenn dieser Wert nicht in der ursprünglichen Anforderung angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugehörigen Tabelle, aus der Datensätze ausgewertet und abgerufen wurden.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/767f34d378d21110f877d304c76fdd2a/childinstallbaseitems?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "items": [
      {
        "parent": {
          "sys_id": "767f34d378d21110f877d304c76fdd2a",
          "display_value": "X5 Sport Utility 4D"
        },
        "sys_class_name": "sn_install_base_item",
        "number": "IBITM0001005",
        "sys_id": "0704dfcc39265110f87734024cfbc222",
        "state": {
          "value": "in_use",
          "display_value": "In Use"
        },
        "consumer": {
          "sys_id": "bab5139ab3401010700b4d43c6a8dc41",
          "display_value": "Charles Barkley"
        },
        "product": {
          "sys_id": "56c84f0439265110f87734024cfbc233",
          "display_value": "Electric Power-Assist Speed-Sensing Steering"
        },
        "active": "true",
        "name": "Electric Power-Assist Speed-Sensing Steering",
        "status": {
          "value": "original",
          "display_value": "Original"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Installationsbasiselement – GET /sn_install_Base/Integrations/installbaseitems/{ID}/Contracts

    Gibt die Verträge zurück, die einem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/Contracts

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/Contracts

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 31. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    Feldname-Wert-Paare Feld-Wert-Paare, die zum Filtern der Vertragsdatensätze verwendet werden sollen. Standardmäßig verweist dies auf die Felder in der Tabelle „Vertrag“ [ast_Contract]. Wenn Sie in eine andere Tabelle angeben sys_class_name, Geben Sie dann die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die Rückgabeergebnisse zu filtern.

    Um beispielsweise nur Datensätze zurückzugeben, bei denen das Feld „erneuerbar“ auf „wahr“ festgelegt ist, übergeben Sie Folgendes: &Renewable=wahr .

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer Tabelle mit erweiterten Verträgen (nicht ast_Contract) der Name der erweiterten Tabelle, die abgefragt werden soll.

    Datentyp: Zeichenfolge

    Standard: ast_Contract
    sysparm_limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden.

    Hinweis:
    Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 33. Anforderungstextparameter (XML oder 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 : 34. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 35. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 36. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Verträge Liste der Verträge, die dem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    Datentyp: Array des Objekts

    "contracts": [
  {
    "active": "String", 
    "approver": {Object},
    "commitment": "String",
    "consumer": {Object},
    "cost_adjustment": "String",
    "cost_adjustment_percentage": "String",
    "cost_per_unit": "String",
    "contract_composite": "String",
    "ends": "String",
    "expiration": {Object},
    "lifetime_cost": "String",
    "monthly_cost": "String",
    "number": "String",
    "payment_amount": "String",
    "payment_schedule": {Object},
    "ratecard": "String",
    "renewable": "String",
    "sales_tax": "String",
    "short_description": "String",
    "starts": "String",
    "state": {Object},
    "sub_total_cost": "String",
    "sys_class_name": "String",
    "sys_domain_path": "String",
    "sys_id": "String",
    "tax_cost": "String",
    "tax_exempt": "String",
    "tax_rate": "String",
    "total_cost": "String",
    "vendor_contract": "String",
    "yearly_cost": "String"
  }
]
    Verträge.aktiv Kennzeichnung, die angibt, ob der Vertrag aktiv ist.
    Mögliche Werte:
    • Wahr: Vertrag ist aktiv.
    • Falsch: Vertrag ist inaktiv.

    Datentyp: Boolesche Zeichenfolge
    Verträge.Genehmiger Details zur Person, die zum Genehmigen des Vertrags berechtigt ist.

    Datentyp: Objekt

    "approver": {
  "display_value": "String",
  "sys_id": "String"
}
    Verträge.Genehmiger.Display_value Textname des Genehmigers, der dem Vertragsdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Genehmigers in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Verträge.Genehmiger.sys_ID SYS_ID des Genehmigerdatensatzes, der dem Vertragsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Verträge.Verbraucher Details zum Verbraucher, der dem Vertragsdatensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucher ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    Verträge.Verbraucher.Anzeige_Wert Textname des Verbrauchers, der dem Vertragsdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Verbrauchernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Verträge.Verbraucher.sys_ID SYS_ID des Verbraucherdatensatzes, der dem Vertragsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Verträge.Cost_adjustment Typ der auf diesen Vertrag angewendeten Kostenanpassung.

    Mögliche Werte:

    • Repariert
    • Manuell
    • CPI (Verbraucherpreisindex)

    Datentyp: Zeichenfolge
    Verträge.Cost_adjustment_percentage Prozentualer Anstieg oder Rückgang des Vertragspreises. Um einen Preisrückgang anzuzeigen, geben Sie einen negativen Prozentsatz ein. Es kann entweder eine Kostenanpassung oder ein Prozentsatz Kostenanpassung angegeben werden, nicht jedoch beides.

    Datentyp: Zeichenfolge
    Verträge.Cost_per_unit Kosten pro Einheit vom Produktanbieter.

    Datentyp: Zeichenfolge
    Verträge.endet Datum, an dem der Vertrag endet.

    Datentyp: Zeichenfolge
    Verträge.Ablauf Details zum Ablaufstatus des zugehörigen Vertrags.

    Datentyp: Objekt

    "expiration": {
  "display_value": "String",
  "sys_id": "String"
}
    Verträge.Ablauf.Display_Wert Ablaufstatus des zugehörigen Vertrags. Verwenden Sie diesen Wert, um den Ablaufstatus in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Verträge.Ablauf.sys_ID SYS_ID des Ablaufdatensatzes, der dem Vertragsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Verträge.Lifetime_Cost Kosten über Lebensdauer des Vertrags.

    Datentyp: Zeichenfolge
    Verträge.monatlich_Kosten Monatliche Kosten des Vertrags.

    Datentyp: Zeichenfolge
    Verträge.Nummer Vertragsnummer.

    Datentyp: Zeichenfolge
    Verträge.payment_amount Geldbetrag, der direkt an die empfangende Partei dieses Vertrags gezahlt wurde.

    Datentyp: Zeichenfolge
    Verträge.payment_schedule Details zum Zahlungszeitplan, der dem Vertrag zugeordnet ist.

    Datentyp: Objekt

    "payment_schedule": {
  "display_value": "String",
  "sys_id": "String"
}
    Verträge.Payment_schedule.Display_value Zahlungszeitplan für den zugehörigen Vertrag. Verwenden Sie diesen Wert, um den Zahlungszeitplan in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Verträge.payment_schedule.value Interner Wert des Zahlungsplans für diesen Vertrag, z. B. täglich, wöchentlich oder monatlich.

    Datentyp: Zeichenfolge
    Verträge.Bewertungskarte Kennzeichnung, die angibt, ob diesem Vertrag eine Kostenkarte zugeordnet ist.
    Mögliche Werte:
    • Wahr: Kostenkarte.
    • Falsch: Keine Kostenkarte.

    Datentyp: Boolesche Zeichenfolge

    Tabelle: Kostenpflege [fm_Contract_rate_Card]
    Verträge.Erneuerbar Kennzeichnung, die angibt, ob der Vertrag verlängerbar ist.
    Mögliche Werte:
    • Wahr: Vertrag ist verlängerbar.
    • Falsch: Vertrag ist nicht verlängerbar.

    Datentyp: Boolesche Zeichenfolge
    Verträge.Sales_Tax Kennzeichnung, die angibt, ob Umsatzsteuer für Artikel erhoben wird, auf die in diesem Vertrag verwiesen wird.
    Mögliche Werte:
    • Wahr: Umsatzsteuer wird erhoben.
    • Falsch: Es wird keine Umsatzsteuer erhoben.

    Datentyp: Boolesche Zeichenfolge
    Verträge.short_description Kurze Beschreibung des Vertrags.

    Datentyp: Zeichenfolge
    Verträge.Starts Datum, an dem der Vertrag beginnt.

    Datentyp: Zeichenfolge
    Verträge.Status Details zum aktuellen Status des Vertrags.

    Datentyp: Objekt

    "state": {
  "display_value": "String",
  "value": "String"
}
    Verträge.Status.Display_value Textzeichenfolge des aktuellen Status des Vertrags. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Verträge.Status.Wert Interner Wert oder Status des Vertrags.

    Datentyp: Zeichenfolge
    Verträge.sub_total_Cost Zwischensumme der Kosten des Vertrags.

    Datentyp: Zeichenfolge
    Verträge.sys_class_Name Tabelle, die den Vertragsdatensatz enthält.

    Datentyp: Zeichenfolge
    Contracts.sys_Domain_path Pfad zu der Domäne, in der dieser Vertrag verfügbar ist.

    Datentyp: Zeichenfolge

    Standard: „/“ = Globale Domäne
    Verträge.sys_ID SYS_ID des zugehörigen Vertragsdatensatzes.

    Datentyp: Zeichenfolge
    Verträge.Tax_Cost Gesamtsteuer für den Vertrag.

    Dieses Feld ist nur sichtbar, wenn das Feld anwendbare Steuern als ausgewählt ist Vertrieb .

    Datentyp: Zeichenfolge
    Verträge.Tax_Exempt Kennzeichnung, die angibt, ob die diesem Vertrag zugeordneten Elemente steuerbefreit sind.
    Mögliche Werte:
    • Wahr: Artikel sind steuerbefreit.
    • Falsch: Elemente sind nicht steuerbefreit.

    Datentyp: Boolesche Zeichenfolge
    Verträge.Tax_rate Steuersatz, der für steuerpflichtige Elemente berechnet wird, die dem Vertrag zugeordnet sind.

    Datentyp: Zeichenfolge
    Verträge.total_Cost Endgültige Kosten des Vertrags nach Anwendung von Anpassungen. Wenn ein Vertrag eine oder mehrere Kostenkarten hat, zeigt dieses Feld den Gesamtwert aller Kostenkarten an.

    Datentyp: Zeichenfolge
    Verträge.Vendor_Contract Vertragsnummer des Lieferanten.

    Datentyp: Zeichenfolge
    Verträge.yearly_Cost Kosten pro Jahr des Vertrags.

    Datentyp: Zeichenfolge
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze zurückgegeben werden sollen.
    Mögliche Werte:
    • Wahr: Weitere zurückzugebende Datensätze.
    • Falsch: Keine weiteren Datensätze zum Rückgeben vorhanden.

    Datentyp: Boolesche Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sysparm_limit Anzahl der zurückgegebenen Datensätze. Wenn dieser Wert nicht in der ursprünglichen Anforderung angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugehörigen Tabelle, aus der Datensätze ausgewertet und abgerufen wurden.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/167e96f053961910539dddeeff7b1298/contracts" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "contracts": [
      {
        "cost_adjustment_percentage": "0",
        "total_cost": "0",
        "cost_adjustment": "0",
        "tax_rate": "7.75",
        "number": "CNTR0000701",
        "tax_cost": "0",
        "sub_total_cost": "0",
        "state": {
          "value": "expired",
          "display_value": "Expired"
        },
        "starts": "2016-07-01",
        "contract_composite": "CoolMate KL300 1 year Limited Warranty\n\t\t​CNTR0000701",
        "tax_exempt": "false",
        "yearly_cost": "0",
        "active": "true",
        "payment_amount": "0",
        "commitment": "0",
        "sys_domain_path": "/",
        "payment_schedule": {
          "value": "Monthly",
          "display_value": "Monthly"
        },
        "renewable": "true",
        "expiration": {
          "sys_id": "c752e78ec3103000c111113e5bba8f3a",
          "display_value": "Expired"
        },
        "short_description": "CoolMate KL300 1 year Limited Warranty\n\t\t",
        "ratecard": "false",
        "sys_class_name": "ast_contract",
        "sys_id": "3f9db778c3302200e7c7d44d81d3ae0a",
        "ends": "2017-06-30",
        "consumer": {
          "sys_id": "59e788fbdb1b1200b6075200cf9619d2",
          "display_value": "Gilly Parker"
        },
        "approver": {
          "sys_id": "f2c0b27247702000cdd1706eecde27c8",
          "display_value": "Software Manager"
        },
        "monthly_cost": "0",
        "vendor_contract": "CNTR0000701",
        "lifetime_cost": "0",
        "sales_tax": "true",
        "cost_per_unit": "0"
      }
    ],
    "status": "SUCCESS"
  }
}

    Installationsbasiselement – GET /sn_install_Base/Integrations/installbaseitems/{ID}/Berechtigungen

    Gibt die Berechtigungen zurück, die einem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/berechtigungen

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/entitlements

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 37. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    Feldname-Wert-Paare Feld-Wert-Paare, die zum Filtern der Berechtigungsdatensätze verwendet werden sollen. Standardmäßig verweist dies auf die Felder in der Tabelle „Berechtigung“ [Service_entitlement]. Wenn Sie in eine andere Tabelle angeben sys_class_name, Geben Sie dann die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die Rückgabeergebnisse zu filtern.

    Um beispielsweise nur Datensätze zurückzugeben, die aktiv sind, übergeben Sie Folgendes: &Active=wahr .

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer erweiterten Berechtigungstabelle (nicht Service_entitlement) der Name der erweiterten Tabelle, die abgefragt werden soll.

    Datentyp: Zeichenfolge

    Standard: Service_entitlement
    sysparm_limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden.

    Hinweis:
    Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 39. Anforderungstextparameter (XML oder 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 : 40. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 41. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 42. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Berechtigungen Liste der Berechtigungen, die dem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    Datentyp: Objekt

    "entitlements": {
  "account": {Object},
  "active": "String",
  "business_hour": {Object},
  "contract": {Object},
  "end_date": "String",
  "entitlement_name": "String",
  "install_base_item": {Object},
  "per_unit": "String",
  "start_date": "String",
  "sys_id": "String",
  "total_units": "String",
  "remaining_units": "String",
  "unit": {Object}
  }
    Berechtigungen.Account Details zum Account, der dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Objekt

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    Berechtigungen.Account.Display_value Textname des Accounts, der dem Berechtigungsdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Accountnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Berechtigungen.Account.sys_ID SYS_ID des Account-Datensatzes, der dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Berechtigungen.aktiv Kennzeichnung, die angibt, ob die Berechtigung aktiv ist.
    Mögliche Werte:
    • 0: Berechtigung ist nicht aktiv.
    • 1: Berechtigung ist aktiv.

    Datentyp: Zeichenfolge

    Standard: 1
    Berechtigungen.Business_Hour Details zu den Geschäftszeiten für den Berechtigungsdatensatz.

    Datentyp: Objekt

    "business_hour": {
  "display_value": "String",
  "sys_id": "String"
}
    Berechtigungen.Business_Hour.Display_value Textname des Geschäftszeitdatensatzes, der dem Berechtigungsdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um die Geschäftszeiten in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Berechtigungen.Business_Hour.sys_ID SYS_ID des Geschäftszeitdatensatzes, der dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Berechtigungen.Vertrag Details zum Vertrag, der dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Objekt

    "contract": {
  "display_value": "String",
  "sys_id": "String"
}
    Berechtigungen.Vertrag.Anzeige_Wert Textname des Vertrags, der dem Berechtigungsdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Vertragsnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Berechtigungen.Vertrag.sys_ID SYS_ID des Vertragsdatensatzes, der dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Berechtigungen.end_date Enddatum der Berechtigung.

    Datentyp: Zeichenfolge
    Berechtigungen.Entitlement_Name Name der Berechtigung.

    Datentyp: Zeichenfolge
    entitlements.install_base_item Details zum Installationsbasiselement, das dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Objekt

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    entitlements.install_base_item.display_value Textname des Installationsbasiselements, das dem Berechtigungsdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Installationsbasiselements in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    entitlements.install_base_item.sys_id SYS_ID des Installationsbasiselementdatensatzes, der dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Berechtigungen.per_unit Anzahl der Produkte in einer Einheit. Beispiel: Wenn unitIst Fall , Dieser Wert wäre 12, wenn 12 Elemente pro Fall vorhanden sind.

    Datentyp: Zeichenfolge
    Berechtigungen.Start_date Startdatum der Berechtigung.

    Datentyp: Zeichenfolge
    Berechtigungen.sys_ID SYS_ID des zugehörigen Berechtigungsdatensatzes.

    Datentyp: Zeichenfolge
    Berechtigungen.total_units Anzahl der Einheiten, die ursprünglich verfügbar waren.

    Datentyp: Zeichenfolge
    Berechtigungen.remaining_units Anzahl der verbleibenden Einheiten.

    Datentyp: Zeichenfolge
    Berechtigungen.Einheit Details zur Einheit des Elements, das dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Objekt

    "unit": {
  "display_value": "String",
  "value": "String"
}
    Berechtigungen.Einheit.Anzeige_Wert Textname der Einheit des Elements, das dem Berechtigungsdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Einheitennamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Berechtigungen.Einheit.Wert Interner Name der Einheit des Elements, das dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze zurückgegeben werden sollen.
    Mögliche Werte:
    • Wahr: Weitere zurückzugebende Datensätze.
    • Falsch: Keine weiteren Datensätze zum Rückgeben vorhanden.

    Datentyp: Boolesche Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sysparm_limit Anzahl der zurückgegebenen Datensätze. Wenn dieser Wert nicht in der ursprünglichen Anforderung angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugehörigen Tabelle, aus der Datensätze ausgewertet und abgerufen wurden.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/entitlements" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "entitlements": [
      {
        "end_date": "2023-04-28",
        "remaining_units": "4978",
        "business_hour": {
          "sys_id": "08fcd0830a0a0b2600079f56b1adb9ae",
          "display_value": "8-5 weekdays"
        },
        "entitlement_name": "Entitlement",
        "sys_id": "7206095d87f121105d0055373cbb3504",
        "total_units": "5000",
        "start_date": "2023-03-27",
        "contract": {
          "sys_id": "495e16b96f0731003b3c498f5d3ee4af",
          "display_value": "CNTR0000603"
        },
        "active": "1",
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "unit": {
          "value": "cases",
          "display_value": "Cases"
        },
        "per_unit": "0",
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Installationsbasiselement – RUFT /sn_install_Base/Integrations/installbaseitems/{ID}/maintenanceplans AB

    Gibt die Wartungspläne zurück, die einem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/maintenanceplans

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/maintenanceplans

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 43. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    Feldname-Wert-Paare Feld-Wert-Paare, die zum Filtern der Wartungsplan-Datensätze verwendet werden sollen. Standardmäßig verweist dies auf die Felder in der Tabelle „Wartungsplan“ [sm_maint_Plan]. Wenn Sie in eine andere Tabelle angeben sys_class_name, Geben Sie dann die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die Rückgabeergebnisse zu filtern.

    Um beispielsweise nur Datensätze zurückzugeben, die aktiv sind, übergeben Sie Folgendes: &Active=wahr .

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer Tabelle mit erweiterten Wartungsplänen (nicht mit Wartungsplänen) der Name der erweiterten Tabelle, die abgefragt werden soll.

    Datentyp: Zeichenfolge

    Standard: Maintenanceplans
    sysparm_limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden.

    Hinweis:
    Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 45. Anforderungstextparameter (XML oder 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 : 46. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 47. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 48. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze zurückgegeben werden sollen.
    Mögliche Werte:
    • Wahr: Weitere zurückzugebende Datensätze.
    • Falsch: Keine weiteren Datensätze zum Rückgeben vorhanden.

    Datentyp: Boolesche Zeichenfolge
    Wartungspläne Liste der Wartungspläne, die dem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    Datentyp: Array des Objekts

    "maintenanceplans": [
  {
    "active": "String",
    "apply_to_new": "String",
    "allow_future_wo": "String",
    "maintenance_override_policy": {Object},
    "model": "String",
    "name": "String",
    "number": "String",
    "propagation_flag": "String",
    "sys_class_name": "String",
    "sys_id": "String",
    "table": "String",
    "type": {Object}
  }
]
    Wartungspläne. ​​Aktiv Kennzeichnung, die angibt, ob der Wartungsplan aktiv ist.
    Mögliche Werte:
    • Wahr: Wartungsplan ist aktiv.
    • Falsch: Wartungsplan ist inaktiv.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​Anwenden_auf_neu Kennzeichnung, die angibt, ob die für diesen Wartungsplan definierten Zeitpläne auf alle Datensätze angewendet werden, die der angegebenen Tabelle seit der letzten Ausführung des Plans hinzugefügt wurden, und ob sie die in der Filterbedingung eingegebenen Bedingungen erfüllen.
    Mögliche Werte:
    • Wahr: Auf alle neuen Datensätze angewendet.
    • Falsch: Nicht auf alle neuen Datensätze angewendet.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​Allow_future_wo Kennzeichnung, die angibt, ob Arbeitsaufträge dem Wartungsplan zugeordnet werden können.
    Mögliche Werte:
    • Wahr: Neue Arbeitsaufträge können zugeordnet werden.
    • Falsch: Es können keine neuen Arbeitsaufträge zugeordnet werden.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​Maintenance_override_Policy Details zur Wartungsüberschreibungsrichtlinie für den Wartungsplan.

    Datentyp: Objekt

    "maintenance_override_policy": {
  "display_value": "String",
  "value": "String"
}
    Wartungspläne. ​​Maintenance_override_Policy. ​​Display_value Textzeichenfolge, die die Überschreibungsrichtlinie beschreibt. Verwenden Sie diesen Wert, um die Überschreibungsrichtlinie in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​Maintenance_override_Policy. ​​Wert Interner Wert der Überschreibungsrichtlinie.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​Modell SYS_ID des Modelldatensatzes, der dem Wartungsplan zugeordnet ist.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​Nummer Wartungsplannummer.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​Propagierung_Flag Kennzeichnung, die angibt, ob der Wartungsplan propagiert werden kann.
    Mögliche Werte:
    • Wahr: Wartungsplan kann propagiert werden.
    • Falsch: Wartungsplan kann nicht propagiert werden.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​sys_class_Name Tabelle, die den Wartungsplan-Datensatz enthält.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​sys_ID SYS_ID des zugehörigen Wartungsplans.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​Tabelle Tabelle, die den zugehörigen Installationsbasiszeitdatensatz enthält.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​Typ Details zum Typ des Wartungsplans.

    Datentyp: Objekt

    "type": {
  "display_value": "String",
  "value": "String"
}
    Wartungspläne. ​​Typ. ​​Display_value Textzeichenfolge, die den Wartungsplantyp beschreibt. Verwenden Sie diesen Wert, um den Typ in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Wartungspläne. ​​Typ. ​​Wert Interner Wert des Wartungsplantyps.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sysparm_limit Anzahl der zurückgegebenen Datensätze. Wenn dieser Wert nicht in der ursprünglichen Anforderung angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugehörigen Tabelle, aus der Datensätze ausgewertet und abgerufen wurden.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/167e96f053961910539dddeeff7b1298/maintenanceplans" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "maintenanceplans": [
      {
        "propagation_flag": "false",
        "active": "true",
        "type": {
          "value": "install_base",
          "display_value": "Install base"
        },
        "maintenance_override_policy": {
          "value": "do_nothing",
          "display_value": "Leave alone"
        },
        "sys_class_name": "wm_planned_work_plan",
        "allow_future_wo": "true",
        "sys_id": "0b809d70877561105d0055373cbb357f",
        "number": "WP0001026",
        "name": "Plan 10",
        "model": "8583ce8237732000158bbfc8bcbe5dd9",
        "apply_to_new": "true",
        "table": "sn_install_base_item"
      }
    ],
    "status": "SUCCESS"
  }
}

    Installationsbasiselement – GET /sn_install_Base/Integrations/installbaseitems/{ID}/relatedParties AB

    Gibt die zugehörigen Parteien zurück, die einem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/relatedParties

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/relatedParties

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 49. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 50. Abfrageparameter
    Name Beschreibung
    Feldname-Wert-Paare Feld-Wert-Paare, die zum Filtern der Datensätze zugehöriger Parteien verwendet werden sollen. Standardmäßig verweist dies auf die Felder in der Tabelle „zugehörige Parteien“ [sn_install_Base_related_Party]. Wenn Sie in eine andere Tabelle angeben sys_class_name, Geben Sie dann die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die Rückgabeergebnisse zu filtern.

    Wenn Sie beispielsweise nach einem bestimmten Account und einer bestimmten verantwortlichen Partei filtern möchten, übergeben Sie die sys_IDs der beiden Datensätze: &Account=86837a386f0331003b3c498f5d3ee4ca&Responsibility=c009bbedb3730010700b4d43c6a8dcef .

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer erweiterten Tabelle „zugehörige Parteien“ (nicht „sn_install_Base_related_Party“) der Name der erweiterten Tabelle, die abgefragt werden soll.

    Datentyp: Zeichenfolge

    Standard: sn_install_Base_related_Party
    sysparm_limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden.

    Hinweis:
    Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 51. Anforderungstextparameter (XML oder 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 : 52. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 53. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 54. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze zurückgegeben werden sollen.
    Mögliche Werte:
    • Wahr: Weitere zurückzugebende Datensätze.
    • Falsch: Keine weiteren Datensätze zum Rückgeben vorhanden.

    Datentyp: Boolesche Zeichenfolge
    Zugehörige Parteien Liste der zugehörigen Parteien, die dem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    Datentyp: Array von Objekten

    "relatedparties": [
  {
    "account": {Object},
    "consumer": {Object},
    "contact": {Object},
    "install_base_item": {Object},
    "responsibility": {Object},
    "service_organization": {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "type": {Object},
    "user": {Object}
  }
]
    RelatedParties.Account Details zum Account, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    RelatedParties.Account.Display_value Textname des Accounts, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Accountnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    RelatedParties.Account.sys_ID SYS_ID des Account-Datensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    ZugehörigParteien.Verbraucher Details zum Verbraucher, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    RelatedParties.Consumer.Display_value Textname des Verbrauchers, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Verbrauchernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    RelatedParties.Consumer.sys_ID SYS_ID des Verbraucherdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    ZugehörigParteien.Kontakt Details zum Account-Kontakt, der für den Datensatz der zugehörigen Parteien verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    RelatedParties.Contact.Display_value Textname des Kontakts, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Kontaktnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    RelatedParties.contact.sys_ID SYS_ID des Kontaktdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Kontakt [Customer_contact]
    relatedparties.install_base_item Details zum Installationsbasiselement, das dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.install_base_item.display_value Textname des Installationsbasiselements, das dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Installationsbasiselements in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    relatedparties.install_base_item.sys_id SYS_ID des Installationsbasiselementdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    ZugehörigParteien.Verantwortlichkeit Details zur Zugriffsebene für die Installationsbasisinformationen.

    Datentyp: Objekt

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    RelatedParties.Responsibility.Display_value Textanzeigewert für die Zugriffsebene für die Installationsbasisinformationen.

    Datentyp: Zeichenfolge
    RelatedParties.Responsibility.sys_ID SYS_ID des zugehörigen Verantwortungsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Installationsbasisinformationen.

    Dieser Parameter ist nur gültig, wenn related_partyFeld ist ebenfalls angegeben. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die beiden entsprechen related_partyUnd responsibilityParameter.

    Weitere Informationen finden Sie unter Configure related parties for Items Received

    Datentyp: Zeichenfolge

    Tabelle: Verantwortlichkeitsdefinition [sn_customerservice_Responsibility_def]
    relatedparties.service_organization Details zur Serviceorganisation, die dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.service_organization.display_value Textname der Serviceorganisation, die dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Namen der Serviceorganisation in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    relatedparties.service_organization.sys_id SYS_ID des Datensatzes der Serviceorganisation, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Serviceorganisation [sn_Customer_Service_Organization]
    RelatedParties.sys_class_Name Tabelle, die den Datensatz der zugehörigen Parteien enthält.

    Datentyp: Zeichenfolge

    Standard: sn_install_Base_related_Party
    RelatedParties.sys_ID SYS_ID des Datensatzes der zugehörigen zugehörigen Parteien.

    Datentyp: Zeichenfolge
    RelatedParties.type Details zum Typ des Kontakts, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "type": {
  "display_value": "String",
  "sys_id": "String"
}
    RelatedParties.type.Display_value Textname des Kontakttyps, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Typ des Kontakts in der Anwenderoberfläche anzuzeigen. Weitere Informationen finden Sie unter Create related party configurations.
    Mögliche Typen:
    • Autorisiertes Konto
    • Autorisierter Verbraucher
    • Autorisierter Kontakt
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Aufgelisteter Account
    • Gelisteter Verbraucher
    • Gelisteter Kontakt
    • Gelisteter Beitragender
    • Aufgelistetes Mitglied
    • Aufgelistete Serviceorganisation

    Datentyp: Zeichenfolge
    RelatedParties.type.sys_ID SYS_ID des Typdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    relatedparties.user Details zum Anwender, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "user": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.user.display_value Textname des Anwenders, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Anwendernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    relatedparties.user.sys_id
    SYS_ID des Anwenderdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sysparm_limit Anzahl der zurückgegebenen Datensätze. Wenn dieser Wert nicht in der ursprünglichen Anforderung angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugehörigen Tabelle, aus der Datensätze ausgewertet und abgerufen wurden.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/relatedparties" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "relatedparties": [
      {
        "type": {
          "sys_id": "68ec8b2965e99110f87764df53db779f",
          "display_value": "Authorized Contact"
        },
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "sys_class_name": "sn_install_base_related_party",
        "sys_id": "8547774087f561100b6afc86dabb351a",
        "responsibility": {
          "sys_id": "c009bbedb3730010700b4d43c6a8dcef",
          "display_value": "Authorized Representative"
        },
        "contact": {
          "sys_id": "dc0185d94f341200025ba3618110c77c",
          "display_value": "Cindy Contact"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Installationsbasiselement – GET /sn_install_Base/Integrations/installbaseitems/{ID}/soldproducts

    Gibt die Datensätze verkaufter Produkte zurück, die einem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/soldproducts

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/soldproducts

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 55. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 56. Abfrageparameter
    Name Beschreibung
    Feldname-Wert-Paare Feld-Wert-Paare, die zum Filtern der Datensätze zugehöriger Parteien verwendet werden sollen. Standardmäßig verweist dies auf die Felder in der Tabelle „verkaufte Produkte“ [sn_install_Base_sold_Product]. Wenn Sie in eine andere Tabelle angeben sys_class_name, Geben Sie die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die Rückgabeergebnisse zu filtern.

    Wenn Sie beispielsweise nach den Produkten filtern möchten, die an einen bestimmten Account verkauft wurden, übergeben Sie etwas Ähnliches wie folgt, wobei der übergebene Wert die sys_ID des Accounts ist: &Account=86837a386f0331003b3c498f5d3ee4ca .

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer erweiterten Tabelle „verkaufte Produkte“ (nicht „sn_install_Base_sold_Product“) der Name der erweiterten Tabelle, die abgefragt werden soll.

    Datentyp: Zeichenfolge

    Standard: sn_install_Base_sold_Product
    sysparm_limit Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    Dieser Grenzwert wird vor der ACL-Bewertung angewendet. Erfolgt keine Datensatzrückgabe, einschließlich Datensätzen, auf die Sie Zugriff haben, ordnen Sie die Datensatzreihenfolge neu, sodass Datensätze, auf die Sie zugreifen können, zuerst zurückgegeben werden.

    Hinweis:
    Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 57. Anforderungstextparameter (XML oder 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 : 58. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 59. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 60. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze zurückgegeben werden sollen.
    Mögliche Werte:
    • Wahr: Weitere zurückzugebende Datensätze.
    • Falsch: Keine weiteren Datensätze zum Rückgeben vorhanden.

    Datentyp: Boolesche Zeichenfolge
    Gelötete Produkte Liste der verkauften Produkte, die dem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    Datentyp: Array von Objekten

    "soldproducts":[
  {
    "account": {Object},
    "contact": {Object},
    "name": "String",
    "number": "String",
    "product": {Object},
    "sys_class_name": "String",
    "sys_id": "String",
    "state": {Object}
  }
]
    Soldproducts.Account Details zum Account, der dem Produktdatensatz zugeordnet ist.

    Datentyp: Objekt

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    Soldproducts.Account.Display_value Textname des Accounts, der dem Produktdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Accountnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Soldproducts.Account.sys_ID SYS_ID des Account-Datensatzes, der dem Produktdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Gelötete Produkte.Kontakt Details zum Account-Kontakt, der für das Produkt verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    Soldproducts.contact.Display_value Textname des Kontakts, der dem Produkt zugeordnet ist. Verwenden Sie diesen Wert, um den Kontaktnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Soldproducts.contact.sys_ID SYS_ID des Kontaktdatensatzes, der dem Produktdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    soldproducts.name Name des Produkts.

    Datentyp: Zeichenfolge
    Gelötete Produkte.Nummer Produktnummer.

    Datentyp: Zeichenfolge
    Soldproducts.sys_class_Name Tabelle, die den Produktdatensatz enthält.

    Datentyp: Zeichenfolge
    Soldproducts.sys_ID SYS_ID des zugeordneten Produkts.

    Datentyp: Zeichenfolge
    Gelötete Produkte.Status Details zum aktuellen Status des Produkts.

    Datentyp: Objekt

    "state": {
  "display_value": "String",
  "value": "String"
}
    SoldProducts.State.Display_value Textzeichenfolge des aktuellen Status des Produkts. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    GelötProdukte.Status.Wert Interner Wert des Status des Produkts.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sysparm_limit Anzahl der zurückgegebenen Datensätze. Wenn dieser Wert nicht in der ursprünglichen Anforderung angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugehörigen Tabelle, aus der Datensätze ausgewertet und abgerufen wurden.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/soldproducts?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 1,
    "has_more": true,
    "soldproducts": [
      {
        "product": {
          "sys_id": "a9a2d0c3c6112276010db16c5ddd3461",
          "display_value": "Lenovo ThinkStation S20"
        },
        "sys_class_name": "sn_install_base_sold_product",
        "number": "SLPRD0001008",
        "sys_id": "17a3a7128729a1105d0055373cbb35fb",
        "contact": {
          "sys_id": "ddce70866f9331003b3c498f5d3ee417",
          "display_value": "George Warren"
        },
        "name": "SP B2B",
        "state": {
          "value": "active",
          "display_value": "Active"
        },
        "account": {
          "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
          "display_value": "Boxeo"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Installationsbasiselement – GET /sn_install_Base/Integrations/installbaseitems/{ID}/Workorders

    Gibt die Arbeitsaufträge zurück, die einem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/Workorders

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/Workorders

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 61. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 62. Abfrageparameter
    Name Beschreibung
    Feldname-Wert-Paare Feld-Wert-Paare, die zum Filtern der Datensätze zugehöriger Parteien verwendet werden sollen. Standardmäßig verweist dies auf die Felder in der Tabelle „verkaufte Produkte“ [sn_install_Base_sold_Product]. Wenn Sie in eine andere Tabelle angeben sys_class_name, Geben Sie dann die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die Rückgabeergebnisse zu filtern.

    Wenn Sie beispielsweise nach den Produkten filtern möchten, die an einen bestimmten Account verkauft wurden, übergeben Sie etwas Ähnliches wie folgt, wobei der übergebene Wert die sys_ID des Accounts ist: &Account=86837a386f0331003b3c498f5d3ee4ca .

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer erweiterten Tabelle „verkaufte Produkte“ (nicht „sn_install_Base_sold_Product“) der Name der erweiterten Tabelle, die abgefragt werden soll.

    Datentyp: Zeichenfolge

    Standard: sn_install_Base_sold_Product
    sysparm_limit Maximale Anzahl der zurückzugebenden Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs.
    Hinweis:
    Ungewöhnlich große Werte für sysparm_limit können die Systemleistung beeinträchtigen.

    Datentyp: Zahl

    Standard: 10
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl in sysparm_offsetParameter.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 63. Anforderungstextparameter (XML oder 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 : 64. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 65. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 66. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze zurückgegeben werden sollen.
    Mögliche Werte:
    • Wahr: Weitere zurückzugebende Datensätze.
    • Falsch: Keine weiteren Datensätze zum Rückgeben vorhanden.

    Datentyp: Boolesche Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sysparm_limit Anzahl der zurückgegebenen Datensätze. Wenn dieser Wert nicht in der ursprünglichen Anforderung angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugehörigen Tabelle, aus der Datensätze ausgewertet und abgerufen wurden.

    Datentyp: Zeichenfolge
    arbeitsaufträge Liste der Arbeitsaufträge, die dem angegebenen Installationsbasiselement-Datensatz zugeordnet sind.

    Datentyp: Array von Objekten

    "workorders":[
  {
    "active": "String",
    "approval": {Object},
    "billable": "String",
    "escalation": "String",
    "has_appointment": "String",
    "hierarchical_variables": "String",
    "impact": "String",
    "install_base_item": {Object},
    "is_catalog": "String",
    "knowledge": "String",
    "location": {Object},
    "made_sla": "String",
    "needs_attention": "String",
    "number": "String",
    "opened_at": {Object},
    "opened_by": {Object},
    "opened_for": {Object},
    "priority": "String",
    "reassignment_count": "String",
    "reschedule_maintenance_if_canceled": "String",
    "short_description": "String",
    "sla_suspended": "String",
    "state": "String",
    "sys_class_name": "String",
    "sys_domain_path": "String"
    "sys_id": "String",
    "task_created": "String",
    "task_effective_number": "String",
    "template_workflow_invoked": "String",
    "upon_approval": {Object},
    "upon_reject": {Object},
    "urgency": "String"
  }
]
    arbeitsaufträge.aktiv Kennzeichnung, die angibt, ob der Arbeitsauftrag aktiv ist.
    Mögliche Werte:
    • Wahr: Arbeitsauftrag ist aktiv.
    • Falsch: Arbeitsauftrag ist inaktiv.

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge.Genehmigung Details zum aktuellen Genehmigungsprozess für den Arbeitsauftrag.

    Datentyp: Objekt

    "approval": {
  "display_value": "String",
  "value": "String"
}
    arbeitsaufträge. ​Approval.Display_value Textzeichenfolge des aktuellen Status des Genehmigungsprozesses. Verwenden Sie diesen Wert, um den Genehmigungsstatus in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Genehmigung.Wert Interner Wert des Status des Genehmigungsprozesses.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Abrechenbar Kennzeichnung, die angibt, ob der Arbeitsauftrag fakturierbar ist.
    Mögliche Werte:
    • Wahr: Arbeitsauftrag ist abrechenbar.
    • Falsch: Arbeitsauftrag ist nicht abrechenbar

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge. ​Eskalation Ebene der Eskalation des Arbeitsauftrags.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Has_appointment Kennzeichnung, die angibt, ob für den Arbeitsauftrag ein geplanter Termin vorliegt.
    Mögliche Werte:
    • Wahr: Der Arbeitsauftrag hat einen Termin.
    • Falsch: Der Arbeitsauftrag hat keinen Termin.

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge. ​Install_Base_item Details zum Installationsbasiselement, das dem Arbeitsauftragsdatensatz zugeordnet ist.

    Datentyp: Objekt

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    arbeitsaufträge. ​Install_Base_item. ​Display_value Textname des Installationsbasiselements, das dem Arbeitsauftragsdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Installationsbasiselements in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Install_Base_item.sys_ID SYS_ID des Installationsbasiselementdatensatzes, der dem Arbeitsauftragsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Is_catalog Kennzeichnung, die angibt, ob Teil eines Katalogs ist.
    Mögliche Werte:
    • Wahr: Der Arbeitsauftrag ist Teil eines Katalogs.
    • Falsch: Der Arbeitsauftrag ist nicht Teil eines Katalogs.

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge.Wissen Kennzeichnung, die angibt, ob für das angegebene Arbeitsauftragsproblem ein Knowledge Base-artikel verfügbar ist.

    Mögliche Werte:

    • Wahr: Knowledge Base-artikel ist für dieses Problem verfügbar.
    • Falsch: Knowledge Base-artikel ist für dieses Problem nicht verfügbar.

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge.Standort Details zum Standort des Elements, an dem gearbeitet werden muss.

    Datentyp: Objekt

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    arbeitsaufträge. ​Standort. ​Display_value Textname des Standorts des zu bearbeitenden Elements. Verwenden Sie diesen Wert, um den Standort in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Standort. ​sys_ID SYS_ID des Standortdatensatzes, der dem Arbeitsauftragsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Made_sla Kennzeichnung, die angibt, ob die dem Arbeitsauftrag zugeordnete Arbeit die zugehörige Servicelevel-Vereinbarung (SLA) erfüllt hat.
    Mögliche Werte:
    • Wahr: SLA wurde erfüllt.
    • Falsch: SLA wurde nicht erfüllt.

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge. ​Needs_Attention Kennzeichnung, die angibt, ob für diesen Arbeitsauftrag Handlungsbedarf besteht.
    Mögliche Werte:
    • Wahr: Arbeitsauftrag erfordert Handlungsbedarf.
    • Falsch: Arbeitsauftrag erfordert keine Aufmerksamkeit.

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge. ​Nummer Eindeutige Nummer, die zur Identifizierung des Arbeitsauftrags verwendet wird.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Geöffnet_um Details dazu, wann der Arbeitsauftrag geöffnet wurde.

    Datentyp: Objekt

    "opened_at": {
  "display_value": "String",
  "value": "String"
}
    arbeitsaufträge. ​Geöffnet_um. ​Display_value Datum und Uhrzeit der Öffnung des Arbeitsauftrags. Verwenden Sie diesen Wert, um den Wert in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Geöffnet_um. ​Wert Datum und Uhrzeit der Öffnung des Arbeitsauftrags.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Geöffnet_von Details zur Person, die den Arbeitsauftrag geöffnet hat.

    Datentyp: Objekt

    "opened_by": {
  "display_value": "String",
  "sys_id": "String"
}
    arbeitsaufträge. ​Geöffnet_von. ​Display_value Textname der Person, die den Arbeitsauftrag geöffnet hat. Verwenden Sie diesen Wert, um diesen Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Geöffnet_von. ​sys_ID SYS_ID des Anwenderdatensatzes der Person, die den Arbeitsauftrag geöffnet hat.

    Datentyp: Zeichenfolge
    arbeitsaufträge.opened_for Details zu der Person, für die der Arbeitsauftrag geöffnet wurde, wenn sie sich von unterscheidet opened_byPerson.

    Datentyp: Objekt

    "opened_for": {
  "display_value": "String",
  "sys_id": "String"
}
    arbeitsaufträge. ​Geöffnet_für. ​Display_value Textname der Person, für die der Arbeitsauftrag geöffnet wurde. Verwenden Sie diesen Wert, um diesen Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Geöffnet_für. ​sys_ID SYS_ID des Anwenderdatensatzes der Person, für die der Arbeitsauftrag geöffnet wurde.

    Datentyp: Zeichenfolge
    arbeitsaufträge.Priorität Priorität des Arbeitsauftrags.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Reassignment_count Anzahl der Neuzuweisungen des Arbeitsauftrags an eine Person, die für die Weiterverschiebung des Arbeitsauftrags verantwortlich ist.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Reschedule_Maintenance_if_cancelled Kennzeichnung, die angibt, ob die Arbeit neu geplant werden soll, wenn der zugehörige Arbeitsauftrag storniert wird.
    Mögliche Werte:
    • Wahr: Planen Sie die Arbeit neu.
    • Falsch: Überprüfen Sie dies, bevor Sie die Arbeit neu planen.

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge. ​Short_description Kurzer Text, der die Arbeit beschreibt, die dem Arbeitsauftrag zugeordnet ist.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​sla_Suspended Kennzeichnung, die angibt, ob das dem Arbeitsauftrag zugeordnete SLA ausgesetzt wurde.
    Gültige Werte:
    • Wahr: SLA wurde ausgesetzt.
    • Falsch: SLA wurde nicht ausgesetzt.

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge.Status Aktueller Status des Arbeitsauftrags.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​sys_class_Name Tabelle, die den Arbeitsauftragsdatensatz enthält.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​sys_Domain_path Domänenpfad.

    Datentyp: Zeichenfolge
    arbeitsaufträge.sys_ID SYS_ID des zugehörigen Arbeitsauftragsdatensatzes.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Task_created Kennzeichnung, die angibt, ob für diesen Arbeitsauftrag eine Aufgabe erstellt wurde.
    Mögliche Werte:
    • Wahr: Aufgabe wurde für diesen Arbeitsauftrag erstellt.
    • Falsch: Aufgabe wurde für diesen Arbeitsauftrag nicht erstellt.

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge. ​Task_Effective_number Eindeutige Nummer, die zur Identifizierung des Arbeitsauftrags verwendet wird.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Template_Workflow_invoked Kennzeichnung, die angibt, ob der zugeordnete Workflow für diesen Arbeitsauftrag aufgerufen wurde.
    Mögliche Werte:
    • Wahr: Workflow wurde aufgerufen.
    • Falsch: Der Worflow wurde nicht aufgerufen.

    Datentyp: Boolesche Zeichenfolge
    arbeitsaufträge. ​On_Approval Details zur nächsten Aktion, die ausgeführt werden soll, wenn der Arbeitsauftrag genehmigt wird.

    Datentyp: Objekt

    "upon_approval": {
  "display_value": "String",
  "value": "String"
}
    arbeitsaufträge. ​On_Approval. ​Display_value Textzeichenfolge der Aktion, die ausgeführt werden soll, wenn der Arbeitsauftrag genehmigt wird. Verwenden Sie diesen Wert, um diese Informationen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​On_Approval. ​Wert Aktion, die ausgeführt werden soll, wenn der Arbeitsauftrag genehmigt wird.

    Mögliche Werte:

    • Do_no
    • Fahren Sie fort

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Bei_ablehnen Details zur nächsten Aktion, die ausgeführt werden soll, wenn der Arbeitsauftrag abgelehnt wird.

    Datentyp: Objekt

    "upon_reject": {
  "display_value": "String",
  "value": "String"
}
    arbeitsaufträge. ​Bei_ablehnen. ​Display_value Textzeichenfolge der Aktion, die ausgeführt werden soll, wenn der Arbeitsauftrag abgelehnt wird. Verwenden Sie diesen Wert, um diese Informationen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    arbeitsaufträge. ​Bei_ablehnen. ​Wert Aktion, die ausgeführt werden soll, wenn der Arbeitsauftrag abgelehnt wird.

    Mögliche Werte:

    • abbrechen
    • goto

    Datentyp: Zeichenfolge
    arbeitsaufträge.Dringlichkeit Dringlichkeit des Arbeitsauftrags.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991/workorders?sysparm_limit=1" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "sysparm_offset": 0,
    "sysparm_limit": 10,
    "has_more": false,
    "workorders": [
      {
        "upon_reject": {
          "value": "cancel",
          "display_value": "Cancel all future Tasks"
        },
        "number": "WO0010372",
        "state": "1",
        "template_workflow_invoked": "false",
        "knowledge": "false",
        "impact": "3",
        "active": "true",
        "priority": "4",
        "sys_domain_path": "/",
        "sla_suspended": "false",
        "needs_attention": "false",
        "short_description": "Test WO1",
        "sys_class_name": "wm_order",
        "reschedule_maintenance_if_canceled": "true",
        "reassignment_count": "0",
        "hierarchical_variables": "variable_pool",
        "opened_for": {
          "sys_id": "85453c616fc331003b3c498f5d3ee4fa",
          "display_value": "Jodi Seals"
        },
        "install_base_item": {
          "sys_id": "42746a3b876121100b6afc86dabb3597",
          "display_value": "KX Series - KX5000"
        },
        "has_appointment": "false",
        "escalation": "0",
        "upon_approval": {
          "value": "proceed",
          "display_value": "Proceed to Next Task"
        },
        "spam": "false",
        "made_sla": "true",
        "is_catalog": "false",
        "task_effective_number": "WO0010372",
        "opened_by": {
          "sys_id": "85453c616fc331003b3c498f5d3ee4fa",
          "display_value": "Jodi Seals"
        },
        "opened_at": {
          "value": "2023-03-20 13:33:22",
          "display_value": "2023-03-20 06:33:22"
        },
        "task_created": "false",
        "sys_id": "19761cc087b521100b6afc86dabb352f",
        "urgency": "3",
        "approval": {
          "value": "not requested",
          "display_value": "Not Yet Requested"
        },
        "billable": "false",
        "location": {
          "sys_id": "1cd145bc23070110766713d1d7bf654f",
          "display_value": "2866 Stevens Creek Blvd,Santa Clara,CA"
        }
      }
    ],
    "status": "SUCCESS"
  }
}

    Installationsbasiselement – PATCH /sn_install_Base/Integrations/installbaseitems/{ID}

    Aktualisiert einen angegebenen Installationsbasiselementdatensatz mit angegebenen Feldwerten.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 67. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 68. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 69. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Account Erforderlich, wenn ein Installationsbasiselement für einen Account erstellt wird.

    SYS_ID des Accounts, der dem Installationsbasiselement zugeordnet werden soll.

    Hinweis:
    Wenn Sie bestehen accountParameter, können Sie nicht auch übergeben consumerParameter.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account]
    aktiv Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Gültige Werte:
    • Wahr, „wahr“ oder „0“: Element ist aktiv.
    • Falsch, „falsch“ oder „1“: Element ist nicht aktiv.

    Datentyp: Boolesch

    Standardwert: wahr
    Asset SYS_ID des Assets, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Asset [alm_Asset]
    Child_install_Base_items Liste der untergeordneten Installationsbasiselemente, die diesem Installationsbasiselement zugeordnet sind.
    Hinweis:
    Die folgenden Felder des untergeordneten Installationsbasiselements dürfen sich nicht von den übergeordneten Elementen unterscheiden:
    • Account
    • Verbraucher
    • Kontakt
    • Serviceorganisation

    Datentyp: Array von Objekten

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    child_install_base_items.name Name des untergeordneten Installationsbasiselements.

    Datentyp: Zeichenfolge
    child_install_base_items.product SYS_ID des zugehörigen untergeordneten Basiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    configuration_item SYS_ID des Konfigurationselements, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Konfigurationselement [cmdb_ci]
    Verbraucher Erforderlich, wenn ein Installationsbasiselement für einen Verbraucher erstellt wird.
    SYS_ID des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Wenn Sie bestehen consumerParameter, können Sie nicht auch übergeben accountParameter. Darüber hinaus können Sie einen Verbraucher nur dann einem Installationsbasiselement zuordnen, wenn das B2B2B2C-Plugin in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge

    Tabelle: Verbraucher [csm_Consumer]
    Consumer_Profile SYS_ID des Verbraucherprofils, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Verbraucherprofil [sn_csm_Consumer_Profile]
    Kontakt
    SYS_ID des Account-Kontaktdatensatzes, der hauptsächlich für das Installationsbasiselement verantwortlich ist.
    Hinweis:
    Kontakte können nur für Account-Installationsbasiselemente angegeben werden.

    Datentyp: Zeichenfolge

    Tabelle: Kontakt [Customer_contact]
    ​Haushalt SYS_ID des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Dieses Feld ist nur gültig, wenn das Plugin Kundenservice-Haushalt (com.snc.Household) installiert ist.

    Datentyp: Zeichenfolge

    Tabelle: Haushalt [csm_Household]
    install_date Datum, an dem das Installationsbasiselement aktiv wird.

    Datentyp: Zeichenfolge

    Format: jjjj-MM-TT HH:mm:ss
    location SYS_ID des Standorts des zugehörigen Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Standort [cmn_location]
    name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Nummer Eindeutiger Bezeichner für das Installationsbasiselement.

    Datentyp: Zeichenfolge

    Standard: Automatisch vom Endpunkt generiert.
    übergeordnet SYS_ID des übergeordneten Datensatzes für diesen Installationsbasiselement-Datensatz.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Product_model SYS_ID des Produktmodells, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Produktmodell [cmdb_model]
    quantity Anzahl der installierten Elemente.

    Datentyp: Ganzzahl
    Service_context SYS_ID des Service, der dem zugrunde liegenden CI zur Berechnung des Auswirkungsschweregrads aus Ereignismanagement zugeordnet ist. Weitere Informationen finden Sie unter Service health status for install base.
    Hinweis:
    Dieses Feld ist nur gültig, wenn das Plugin „proaktiver Kundenservice mit Ereignismanagement“ installiert ist.

    Datentyp: Zeichenfolge
    Service_Organization Erforderlich, wenn ein Installationsbasiselement für eine Serviceorganisation erstellt wird.

    SYS_ID des Datensatzes der Serviceorganisation, der an der Bereitstellung des Service für den Kunden beteiligt ist.

    Hinweis:
    Wenn Sie diesen Parameter übergeben, sollten Sie nicht auch die Parameter „Account“, „Kontakt“ oder „Verbraucher“ übergeben. Die service_organizationDer Parameter ist nur verfügbar, wenn das Plugin „Serviceorganisation“ (com.snc.service_organization) in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge

    Tabelle: Serviceorganisation [sn_Customer_Service_Organization]
    Status Aktueller Status des Installationsbasiselements.
    Gültige Werte:
    • In_Gebrauch
    • Inaktiv

    Datentyp: Zeichenfolge
    status Status des Produkts.
    Gültige Werte:
    • original
    • Ersatz

    Datentyp: Zeichenfolge
    sys_class_name Name der erweiterten Installationsbasistabelle, in der der Datensatz des Installationsbasiselements aktualisiert werden soll.

    Datentyp: Zeichenfolge
    Deinstallationsdatum Datum, an dem die Installationsbasis inaktiv wird.

    Datentyp: Zeichenfolge

    Format: jjjj-MM-TT HH:mm:ss

    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 : 70. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 71. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 72. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    Element Details zum Installationsbasiselement, das aktualisiert wurde.

    Datentyp: Objekt

    "item": {
  "account": {Object},
  "active": Boolean,
  "name": "String",
  "number": "String",
  "state": {Object},
  "sys_class_name": {Object},
  "sys_id": "String"
}
    Element.Account Details zum Kunden-Account, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Account.Display_value Textname des Kunden-Accounts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Kundenaccounts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Account.sys_ID SYS_ID des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.aktiv Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • Wahr: Installationsbasiselement ist aktiv.
    • Falsch: Installationsbasiselement ist inaktiv.

    Datentyp: Boolesche Zeichenfolge
    item.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Nummer Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Element.Status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

    "state": {
  "display_value": "String",
  "value": "String"
}
    Element.Status.Display_Wert Textzeichenfolge des aktuellen Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.sys_class_Name Details zur Tabelle, die das Installationsbasiselement enthält.

    Datentyp: Objekt

    "sys_class_name": {
  "display_value": "String",
  "value": "String"
}
    Element.sys_class_Name.Display_value Textzeichenfolge des Namens der Tabelle, die das Installationsbasiselement enthält. Verwenden Sie diesen Wert, um den Tabellennamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.sys_class_Name.Wert Interner Wert der Tabelle, die das Installationsbasiselement enthält

    Datentyp: Zeichenfolge
    Element.sys_ID SYS_ID des Installationsbasiselementdatensatzes. Befindet sich in der in angegebenen Tabelle sys_class_nameParameter.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie der Name und die aktiven Felder im Installationsbasiselement-Datensatz aktualisiert werden.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/f77c7542b7343300ece839a6ee11a991" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\": \"KX Series - KX5001\",
  \"active\":true
}" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": {
        "value": "sn_install_base_item",
        "display_value": "Install Base Item"
      },
      "number": "IBITM0001001",
      "sys_id": "bc610d38cb76211050501ebfe8076d8b",
      "state": {
        "value": "inactive",
        "display_value": "Inactive"
      },
      "active": "false",
      "name": "NewTestIB",
      "account": {
        "sys_id": "8637a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}
      
}

    Installationsbasiselement – PATCH /sn_install_Base/Integrations/installbaseitems/{ID}/relatedParties/{related_Party_sys_ID}

    Aktualisiert den angegebenen Datensatz der zugehörigen Partei, der einem angegebenen Installationsbasiselement zugeordnet ist, mit den Werten im Anforderungstext.

    Wenn Sie den Typ der zugehörigen Partei ändern müssen, die einem Installationsbasiselement zugeordnet ist, müssen Sie die typspezifischen Felder für den aktuellen Typ der zugehörigen Partei entfernen und durch die typspezifischen Felder des neuen Typs der zugehörigen Partei ersetzen. Um beispielsweise von einem Typ „autorisierter Account“ zu „autorisierter Verbraucher“ zu „autorisierter Verbraucher“ zu ändern, übergeben Sie Folgendes:

    • type = „Autorisierter Verbraucher“
    • account = „“
    • consumer = „<sys_ID des Verbraucherdatensatzes>“
    • responsibility = „<sys_ID der Verantwortung des Verbrauchers>“

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/relatedParties/{related_Party_sys_ID}

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/relatedParties/{related_Party_sys_ID}

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 73. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Zugehörige_Partei_sys_ID SYS_ID des Datensatzes der zugehörigen Partei.

    Datentyp: Zeichenfolge

    Tabelle: Zugehörige Partei der Installationsbasis [sn_install_Base_related_Party]
    Tabelle : 74. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 75. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Account Erforderlich, wenn typeParameter ist einer der folgenden:
    • Autorisiertes Konto
    • Autorisierter Kontakt
    • Aufgelisteter Account
    • Gelisteter Kontakt

    SYS_ID des Accounts, der dem Installationsbasiselement zugeordnet werden soll.

    Hinweis:
    Wenn Sie bestehen accountParameter, können Sie nicht auch übergeben consumerParameter.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account]
    Verbraucher Erforderlich, wenn typeParameter ist Autorisierter Verbraucher Oder Gelisteter Verbraucher .
    SYS_ID des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Wenn Sie bestehen consumerParameter, können Sie nicht auch übergeben accountParameter. Darüber hinaus können Sie einen Verbraucher nur dann einem Installationsbasiselement zuordnen, wenn das B2B2B2C-Plugin in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge

    Tabelle: Verbraucher [csm_Consumer]
    Kontakt SYS_ID des Kontaktdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Kontakt [Customer_contact]
    Verantwortlichkeit SYS_ID des zugehörigen Verantwortungsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Installationsbasisinformationen.

    Dieser Parameter ist nur gültig, wenn related_partyFeld ist ebenfalls angegeben. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die beiden entsprechen related_partyUnd responsibilityParameter.

    Weitere Informationen finden Sie unter Configure related parties for Items Received

    Datentyp: Zeichenfolge

    Tabelle: Verantwortlichkeitsdefinition [sn_customerservice_Responsibility_def]
    Service_Organization Erforderlich, wenn typeParameter ist einer der folgenden:
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Aufgelistetes Mitglied
    • Aufgelistete Serviceorganisation

    SYS_ID des Datensatzes der Serviceorganisation, der an der Bereitstellung des Service für den Kunden beteiligt ist.

    Hinweis:
    Wenn Sie diesen Parameter übergeben, sollten Sie nicht auch die Parameter „Account“, „Kontakt“ oder „Verbraucher“ übergeben. Die service_organizationDer Parameter ist nur verfügbar, wenn das Plugin „Serviceorganisation“ (com.snc.service_organization) in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge

    Tabelle: Serviceorganisation [sn_Customer_Service_Organization]
    sys_class_name Tabelle, die den Datensatz der zugehörigen Parteien enthält.

    Datentyp: Zeichenfolge

    Standard: sn_install_Base_related_Party
    type Erforderlich. SYS_ID des Typs der zu erstellenden zugehörigen Partei.
    Mögliche Typen:
    • Autorisiertes Konto
    • Autorisierter Verbraucher
    • Autorisierter Kontakt
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Aufgelisteter Account
    • Gelisteter Verbraucher
    • Gelisteter Kontakt
    • Gelisteter Beitragender
    • Aufgelistetes Mitglied
    • Aufgelistete Serviceorganisation

    Datentyp: Zeichenfolge

    Tabelle: Konfiguration der zugehörigen Partei [sn_customerservice_related_Party_Configuration]
    Anwender Erforderlich, wenn typeDer Parameter ist einer der folgenden zugehörigen Parteitypen:
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Gelisteter Beitragender
    • Aufgelistetes Mitglied
    SYS_ID des Anwenderdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]

    Für Autorisiertes Mitglied Und Aufgelistetes Mitglied , Dieser Anwender muss dem angegebenen zugeordnet sein service_organizationDatensatz.

    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 : 76. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 77. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 78. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    Element Details zum Datensatz der zugehörigen Parteien.

    Datentyp: Array

    "item": {
  "account": {Object},
  "consumer": {Object},
  "contact": {Object},
  "install_base_item": {Object},
  "responsibility": {Object},
  "service_organization": {Object},
  "sys_class_name": "String",
  "sys_id": "String",
  "type": {Object},
  "user": {Object}
}
    Element.Account Details zum Account, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Account.Display_value Textname des Accounts, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Accountnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Account.sys_ID SYS_ID des Account-Datensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Verbraucher Details zum Verbraucher, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Verbraucher.Anzeige_Wert Textname des Verbrauchers, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Verbrauchernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Verbraucher.sys_ID SYS_ID des Verbraucherdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Kontakt Details zum Account-Kontakt, der für den Datensatz der zugehörigen Parteien verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Kontakt.Anzeige_Wert Textname des Kontakts, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Kontaktnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Kontakt.sys_ID SYS_ID des Kontaktdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Kontakt [Customer_contact]
    item.install_base_item Details zum Installationsbasiselement, das dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    item.install_base_item.display_value Textname des Installationsbasiselements, das dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Installationsbasiselements in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.install_base_item.sys_id SYS_ID des Installationsbasiselementdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Verantwortlichkeit Details zur Zugriffsebene für die Installationsbasisinformationen.

    Datentyp: Objekt

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Verantwortlichkeit.Display_value Textanzeigewert für die Zugriffsebene für die Installationsbasisinformationen.

    Datentyp: Zeichenfolge
    Element.Verantwortlichkeit.sys_ID SYS_ID des zugehörigen Verantwortungsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Installationsbasisinformationen.

    Dieser Parameter ist nur gültig, wenn related_partyFeld ist ebenfalls angegeben. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die beiden entsprechen related_partyUnd responsibilityParameter.

    Weitere Informationen finden Sie unter Configure related parties for Items Received

    Datentyp: Zeichenfolge

    Tabelle: Verantwortlichkeitsdefinition [sn_customerservice_Responsibility_def]
    Element.sys_class_Name Tabelle, die den Datensatz der zugehörigen Parteien enthält.

    Datentyp: Zeichenfolge

    Standard: sn_install_Base_related_Party
    Element.sys_ID SYS_ID des Datensatzes der zugehörigen zugehörigen Parteien.

    Datentyp: Zeichenfolge
    Element.Typ Details zum Typ des Kontakts, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "type": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Typ.Anzeige_Wert Textname des Kontakttyps, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Typ des Kontakts in der Anwenderoberfläche anzuzeigen. Weitere Informationen finden Sie unter Create related party configurations.
    Mögliche Typen:
    • Autorisiertes Konto
    • Autorisierter Verbraucher
    • Autorisierter Kontakt
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Aufgelisteter Account
    • Gelisteter Verbraucher
    • Gelisteter Kontakt
    • Gelisteter Beitragender
    • Aufgelistetes Mitglied
    • Aufgelistete Serviceorganisation

    Datentyp: Zeichenfolge
    Element.Typ.sys_ID SYS_ID des Typdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    item.user Details zum Anwender, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "user": {
  "display_value": "String",
  "sys_id": "String"
}
    item.user.display_value Textname des Anwenders, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Anwendernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.user.sys_id
    SYS_ID des Anwenderdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sysparm_limit Anzahl der zurückgegebenen Datensätze. Wenn dieser Wert nicht in der ursprünglichen Anforderung angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugehörigen Tabelle, aus der Datensätze ausgewertet und abgerufen wurden.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um den Kontaktdatensatz zu aktualisieren, der der zugehörigen Partei zugeordnet ist.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/relatedparties/f77c7542b7343300ece839a6ee11a991" \
--request PATCH \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
\"contact\": \"dc0185d94f341200025ba3618110c77c\"
}" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
"result":
  {
    "type": {
      "display_value":"Authorized Contact",
      "sys_id":"68ec8b2965e99110f87764df53db779f"
    },
    "install_base_item": {
      "display_value":"KX Series - KX5000",
      "sys_id":"f77c7542b7343300ece839a6ee11a991"
    },
    "sys_class_name":"sn_install_base_related_party",
    "sys_id":"4659539814ac6910f877ae314c1fb43a",
    "responsibility": {
      "display_value":"Authorized Representative",
      "sys_id":"c009bbedb3730010700b4d43c6a8dcef"
    },
    "contact": {
      "display_value":"Cindy Contact",
      "sys_id":"dc0185d94f341200025ba3618110c77c"
    },
    "account": {
      "display_value":"Boxeo",
      "value":"86837a386f0331003b3c498f5d3ee4ca"
    },
    "status":"SUCCESS",
  }
}

    Installationsbasiselement – PATCH /sn_install_Base/Integrations/installbaseitems/{ID}/deinstallieren

    Deinstalliert das angegebene Installationsbasiselement.

    Eine Deinstallation besteht aus der Einstellung von activeFeld bis Falsch Und wird festgelegt unistall_dateFeld an ein angegebenes Datum. Leer, wenn kein Datumswert angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/uninstall

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/uninstall

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 79. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 80. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 81. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Deinstallationsdatum Datum, an dem das angegebene Installationsbasiselement deinstalliert werden soll. Wenn nicht angegeben, wird es sofort deinstalliert.

    Datentyp: Zeichenfolge

    Format: jjjj-mm-TT hh:mm:ss

    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 : 82. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 83. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 84. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    Element Beschreibung des deinstallierten Elements.

    Datentyp: Objekt

    "item": {
  "account": {Object},
  "active": "String",
  "asset": {Object},
  "configuration_item": {Object},
  "consumer": {Object},
  "consumer_profile": {Object},
  "contact": {Object},
  "health_status": {Object},
  "health_status_last_updated": "String",
  "household": {Object},
  "install_date": {Object},
  "location": {Object},
  "name": "String",
  "number": "String",
  "parent": {Object},
  "product": {Object},
  "service_context": {Object},
  "service_organization" {Object},
  "sys_class_name": "String",
  "sys_id": "String",
  "state": {Object},
  "status": {Object},
  "uninstall_date": "String"
}
    Element.Account Details zum Kunden-Account, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Account.Display_value Textname des Kunden-Accounts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Kundenaccounts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Account.sys_ID SYS_ID des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.aktiv Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • Wahr: Installationsbasiselement ist aktiv.
    • Falsch: Installationsbasiselement ist inaktiv.

    Datentyp: Boolesche Zeichenfolge
    Element.Asset Details zum Asset, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Asset.Display_value Textname des Assets, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Asset-Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Asset.sys_ID SYS_ID des Asset-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.child_install_base_items Liste der untergeordneten Installationsbasiselemente, die diesem Installationsbasiselement zugeordnet sind.
    Hinweis:
    Die folgenden Felder des untergeordneten Installationsbasiselements dürfen sich nicht von den übergeordneten Elementen unterscheiden:
    • Account
    • Verbraucher
    • Kontakt
    • Serviceorganisation

    Datentyp: Array von Objekten

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    item.child_install_base_items.name Name des untergeordneten Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.child_install_base_items.product SYS_ID des zugehörigen untergeordneten Basiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Element.Configuration_item Details zum Konfigurationselement, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    Item.Configuration_Display_value Textname des Konfigurationselements, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Konfigurationselements in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Configuration_sys_ID SYS_ID des Konfigurationselementdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Verbraucher Details zum Verbraucher, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucher ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Verbraucher.Anzeige_Wert Textname des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Verbrauchernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Verbraucher.sys_ID SYS_ID des Verbraucherdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Verbraucher_Profil Details zum Verbraucherprofil, das dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucherprofil ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Verbraucher_Profil.Anzeige_Wert Textname des Verbraucherprofils, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Verbraucherprofils in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Verbraucher_Profil.sys_ID SYS_ID des Verbraucherprofildatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Kontakt Details zum Account-Kontakt, der für den Installationsbasiselement-Datensatz verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Kontakt.Anzeige_Wert Textname des Accountkontakts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Account-Kontakts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Kontakt.sys_ID SYS_ID des Account-Kontaktdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Health_Status Details zum aktuellen Integritätsstatus des Installationsbasiselements. Wird nur zurückgegeben, wenn das Plugin „Proactive Customer Service Operations“ (com.snc.proactive_cs_itom) installiert ist.

    Datentyp: Objekt

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    Element.Health_Status.Display_value Textzeichenfolge des aktuellen Integritätsstatus des Installationsbasiselements. Verwenden Sie diesen Wert, um den Integritätsstatus in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Health_Status.value Interner Wert des Integritätsstatus des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Health_Status_Last_updated Datum und Uhrzeit der letzten Aktualisierung des Integritätsstatus für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Element.Haushalt Details zum Haushalt, der dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin Kundenservice-Haushalt (com.snc.Household) installiert ist.

    Datentyp: Objekt

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Haushalt.Anzeige_Wert Textname des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Haushaltsnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Haushalt.sys_ID SYS_ID des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.install_date Details zum Datum, an dem das Installationsbasiselement aktiv wurde.

    Datentyp: Objekt

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    item.install_date.display_value Textinstallationsdatum. Verwenden Sie diesen Wert, um das Installationsdatum in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.install_date.value Interner Wert des Installationsdatums.

    Datentyp: Zeichenfolge
    item.location Details zum Speicherort des Installationsbasiselements.

    Datentyp: Objekt

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Standort.Anzeige_Wert Textname des Installationsbasiselements-Standorts. Verwenden Sie diesen Wert, um den Standortnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Standort.sys_ID SYS_ID des Standortdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Nummer Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Element.übergeordnetes Element Details zum übergeordneten Datensatz des Installationsbasiselements-Datensatzes.

    Datentyp: Objekt

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.parent.Display_value Textname des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den übergeordneten Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.parent.sys_ID SYS_ID des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.product Details zum Produktmodell, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diese Informationen, um die Services zu identifizieren, die einem Produktmodell zugeordnet sind.

    Datentyp: Objekt

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    item.product.display_value Textname des Produktmodells, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Produktnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.product.sys_id SYS_ID des Produktmodelldatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Artikel.Menge Anzahl der installierten Elemente.

    Datentyp: Ganzzahl
    item.service_context Details zum Servicekontext, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.display_value Details zum Servicekontext, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.sys_id SYS_ID des Servicekontextdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.service_organization Details zur Serviceorganisation, die dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin „Serviceorganisation“ (com.snc.service_organization) installiert ist.

    Datentyp: Objekt

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_organization.display_value Textname der Serviceorganisation, die dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen der Serviceorganisation in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.service_organization.sys_id SYS_ID des Serviceorganisationsdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.sys_class_Name Tabelle, die den Installationsbasiselement-Datensatz enthält.

    Datentyp: Zeichenfolge
    Element.sys_ID SYS_ID des Installationsbasiselementdatensatzes. Befindet sich in der in angegebenen Tabelle sys_class_nameParameter.

    Datentyp: Zeichenfolge
    Element.Status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

    "state": {
  "display_value": "String",
  "value": "String"
}
    Element.Status.Display_Wert Textzeichenfolge des aktuellen Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Status Details zum Status des Installationsbasiselements.

    Datentyp: Objekt

    "status": {
  "display_value": "String",
  "value": "String"
}
    Element.Status.Display_value Textzeichenfolge des Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Deinstallationsdatum Details zum Datum, an dem das Installationsbasiselement inaktiv wurde.

    Datentyp: Objekt

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    Element.Uninstall_date.Display_value Datum der Textdeinstallation. Verwenden Sie diesen Wert, um das Deinstallationsdatum in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Uninstall_date.value Interner Wert des Deinstallationsdatums.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems/42746a3b876121100b6afc86dabb3597/uninstall" \
--request PATCH \
--header "Accept:application/json" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": {
        "value": "sn_install_base_item",
        "display_value": "Install Base Item"
      },
      "number": "IBITM0000901",
      "sys_id": "f77c7542b7343300ece839a6ee11a991",
      "contact": {
        "sys_id": "4d147a386f0331003b3c498f5d3ee437",
        "display_value": "Julie Lewis"
      },
      "state": {
        "value": "inactive",
        "display_value": "Inactive"
      },
      "active": "false",
      "configuration_item": {
        "sys_id": "e5a28e07c30202001efd5cb981d3aedb",
        "display_value": "KX Series - KX5000"
      },
      "name": "KX Series - KX5000",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}

    Installationsbasiselement – POST /sn_install_Base/Integrations/installbaseitems

    Erstellt einen oder mehrere Installationsbasiselementdatensätze in der Standardtabelle des Installationsbasiselements oder in der erweiterten Tabelle, falls angegeben, und füllt sie mit den angegebenen Feldwerten aus.

    Wenn Sie einen einzelnen Installationsbasiselement-Datensatz erstellen, übergeben Sie ein Objekt im Anforderungstext, das alle Felder enthält, die in den Anforderungstext aufgenommen werden sollen. Wenn Sie mehrere Installationsbasiselementdatensätze in einem einzigen Aufruf erstellen, übergeben Sie ein Array von Objekten im Anforderungstext, das alle zu erstellenden Datensätze enthält. Der Endpunkt verarbeitet jedes der Datensatzerstellungsobjekte einzeln und erstellt Berichte. Wenn mindestens ein Datensatz nicht erstellt werden kann, wirkt sich dies nicht auf die Erstellung eines anderen Datensatzes aus.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 85. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    Tabelle : 86. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 87. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Account Erforderlich, wenn ein Installationsbasiselement für einen Account erstellt wird.

    SYS_ID des Accounts, der dem Installationsbasiselement zugeordnet werden soll.

    Hinweis:
    Wenn Sie bestehen accountParameter, können Sie nicht auch übergeben consumerParameter.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account]
    aktiv Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Gültige Werte:
    • Wahr, „wahr“ oder „0“: Element ist aktiv.
    • Falsch, „falsch“ oder „1“: Element ist nicht aktiv.

    Datentyp: Boolesch

    Standardwert: wahr
    Asset SYS_ID des Assets, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Asset [alm_Asset]
    Child_install_Base_items Liste der untergeordneten Installationsbasiselemente, die diesem Installationsbasiselement zugeordnet sind.
    Hinweis:
    Die folgenden Felder des untergeordneten Installationsbasiselements dürfen sich nicht von den übergeordneten Elementen unterscheiden:
    • Account
    • Verbraucher
    • Kontakt
    • Serviceorganisation

    Datentyp: Array von Objekten

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    child_install_base_items.name Name des untergeordneten Installationsbasiselements.

    Datentyp: Zeichenfolge
    child_install_base_items.product SYS_ID des zugehörigen untergeordneten Basiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    configuration_item SYS_ID des Konfigurationselements, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Konfigurationselement [cmdb_ci]
    Verbraucher Erforderlich, wenn ein Installationsbasiselement für einen Verbraucher erstellt wird.
    SYS_ID des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Wenn Sie bestehen consumerParameter, können Sie nicht auch übergeben accountParameter. Darüber hinaus können Sie einen Verbraucher nur dann einem Installationsbasiselement zuordnen, wenn das B2B2B2C-Plugin in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge

    Tabelle: Verbraucher [csm_Consumer]
    Consumer_Profile SYS_ID des Verbraucherprofils, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Verbraucherprofil [sn_csm_Consumer_Profile]
    Kontakt
    SYS_ID des Account-Kontaktdatensatzes, der hauptsächlich für das Installationsbasiselement verantwortlich ist.
    Hinweis:
    Kontakte können nur für Account-Installationsbasiselemente angegeben werden.

    Datentyp: Zeichenfolge

    Tabelle: Kontakt [Customer_contact]
    ​Haushalt SYS_ID des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Dieses Feld ist nur gültig, wenn das Plugin Kundenservice-Haushalt (com.snc.Household) installiert ist.

    Datentyp: Zeichenfolge

    Tabelle: Haushalt [csm_Household]
    install_date Datum, an dem das Installationsbasiselement aktiv wird.

    Datentyp: Zeichenfolge

    Format: jjjj-MM-TT HH:mm:ss
    location SYS_ID des Standorts des zugehörigen Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Standort [cmn_location]
    name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Nummer Eindeutiger Bezeichner für das Installationsbasiselement.

    Datentyp: Zeichenfolge

    Standard: Automatisch vom Endpunkt generiert.
    übergeordnet SYS_ID des übergeordneten Datensatzes für diesen Installationsbasiselement-Datensatz.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Product_model SYS_ID des Produktmodells, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Produktmodell [cmdb_model]
    quantity Anzahl der installierten Elemente.

    Datentyp: Ganzzahl
    Service_context SYS_ID des Service, der dem zugrunde liegenden CI zur Berechnung des Auswirkungsschweregrads aus Ereignismanagement zugeordnet ist. Weitere Informationen finden Sie unter Service health status for install base.
    Hinweis:
    Dieses Feld ist nur gültig, wenn das Plugin „proaktiver Kundenservice mit Ereignismanagement“ installiert ist.

    Datentyp: Zeichenfolge
    Service_Organization Erforderlich, wenn ein Installationsbasiselement für eine Serviceorganisation erstellt wird.

    SYS_ID des Datensatzes der Serviceorganisation, der an der Bereitstellung des Service für den Kunden beteiligt ist.

    Hinweis:
    Wenn Sie diesen Parameter übergeben, sollten Sie nicht auch die Parameter „Account“, „Kontakt“ oder „Verbraucher“ übergeben. Die service_organizationDer Parameter ist nur verfügbar, wenn das Plugin „Serviceorganisation“ (com.snc.service_organization) in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge

    Tabelle: Serviceorganisation [sn_Customer_Service_Organization]
    Status Aktueller Status des Installationsbasiselements.
    Gültige Werte:
    • In_Gebrauch
    • Inaktiv

    Datentyp: Zeichenfolge
    status Status des Produkts.
    Gültige Werte:
    • original
    • Ersatz

    Datentyp: Zeichenfolge
    sys_class_name Name der erweiterten Installationsbasistabelle, in der der Installationsbasiselement-Datensatz erstellt werden soll.

    Datentyp: Zeichenfolge

    Standard: Tabelle „Installationsbasiselement“ [sn_install_Base_item]
    Deinstallationsdatum Datum, an dem die Installationsbasis inaktiv wird.

    Datentyp: Zeichenfolge

    Format: jjjj-MM-TT HH:mm:ss

    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 : 88. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 89. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 90. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    Element Installationsbasiselement, das den angegebenen Filterergebnissen entspricht. Nur nicht leere Felder werden zurückgegeben.

    Datentyp: Array von Objekten

    "item": {
  "account": {Object},
  "active": "String",
  "asset": {Object},
  "child_install_base_items": {Object},
  "condition": "String",
  "configuration_item": {Object},
  "consumer": {Object},
  "consumer_profile": {Object},
  "contact": {Object},
  "health_status": {Object},
  "health_status_last_updated": "String",
  "household": {Object},
  "install_date": {Object},
  "location": {Object},
  "name": "String",
  "number": "String",
  "parent": {Object},
  "product": {Object},
  "quantity": Integer,
  "service_context": {Object},
  "service_organization" {Object},
  "sys_id": "String",
  "state": {Object},
  "status": {Object},
  "uninstall_date": "String"
}
    Element.Account Details zum Kunden-Account, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Account.Display_value Textname des Kunden-Accounts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Kundenaccounts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Account.sys_ID SYS_ID des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.aktiv Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • Wahr: Installationsbasiselement ist aktiv.
    • Falsch: Installationsbasiselement ist inaktiv.

    Datentyp: Boolesche Zeichenfolge
    Element.Asset Details zum Asset, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "asset": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Asset.Display_value Textname des Assets, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Asset-Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Asset.sys_ID SYS_ID des Asset-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.child_install_base_items Liste der untergeordneten Installationsbasiselemente, die diesem Installationsbasiselement zugeordnet sind.
    Hinweis:
    Die folgenden Felder des untergeordneten Installationsbasiselements dürfen sich nicht von den übergeordneten Elementen unterscheiden:
    • Account
    • Verbraucher
    • Kontakt
    • Serviceorganisation

    Datentyp: Array von Objekten

    "child_install_base_items": [
  {
    "name": "String",
    "product": "String"
  }
]
    item.child_install_base_items.name Name des untergeordneten Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.child_install_base_items.product SYS_ID des zugehörigen untergeordneten Basiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Element.Configuration_item Details zum Konfigurationselement, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "configuration_item": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Configuration_item.Display_value Textname des Konfigurationselements, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Konfigurationselements in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Configuration_item.sys_ID SYS_ID des Konfigurationselementdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Verbraucher Details zum Verbraucher, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucher ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Verbraucher.Anzeige_Wert Textname des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Verbrauchernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Verbraucher.sys_ID SYS_ID des Verbraucherdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Verbraucher_Profil Details zum Verbraucherprofil, das dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld Verbraucherprofil ist nur verfügbar, wenn das B2B2B2C-Plugin installiert ist.

    Datentyp: Objekt

    "consumer_profile": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Verbraucher_Profil.Anzeige_Wert Textname des Verbraucherprofils, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Verbraucherprofils in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Verbraucher_Profil.sys_ID SYS_ID des Verbraucherprofildatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Kontakt Details zum Account-Kontakt, der für den Installationsbasiselement-Datensatz verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Kontakt.Anzeige_Wert Textname des Accountkontakts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Account-Kontakts in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Kontakt.sys_ID SYS_ID des Account-Kontaktdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.Health_Status Details zum aktuellen Integritätsstatus des Installationsbasiselements. Wird nur zurückgegeben, wenn das Plugin „Proactive Customer Service Operations“ (com.snc.proactive_cs_itom) installiert ist.

    Datentyp: Objekt

    "health_status": {
  "display_value": "String",
  "value": "String"
}
    Element.Health_Status.Display_value Textzeichenfolge des aktuellen Integritätsstatus des Installationsbasiselements. Verwenden Sie diesen Wert, um den Integritätsstatus in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Health_Status.value Interner Wert des Integritätsstatus des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Health_Status_Last_updated Datum und Uhrzeit der letzten Aktualisierung des Integritätsstatus für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Element.Haushalt Details zum Haushalt, der dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin Kundenservice-Haushalt (com.snc.Household) installiert ist.

    Datentyp: Objekt

    "household": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Haushalt.Anzeige_Wert Textname des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Haushaltsnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Haushalt.sys_ID SYS_ID des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.install_date Details zum Datum, an dem das Installationsbasiselement aktiv wurde.

    Datentyp: Objekt

    "install_date": {
  "display_value": "String",
  "value": "String"
}
    item.install_date.display_value Textinstallationsdatum. Verwenden Sie diesen Wert, um das Installationsdatum in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.install_date.value Interner Wert des Installationsdatums.

    Datentyp: Zeichenfolge
    item.location Details zum Speicherort des Installationsbasiselements.

    Datentyp: Objekt

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.Standort.Anzeige_Wert Textname des Installationsbasiselements-Standorts. Verwenden Sie diesen Wert, um den Standortnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Standort.sys_ID SYS_ID des Standortdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Nummer Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    Element.übergeordnetes Element Details zum übergeordneten Datensatz des Installationsbasiselements-Datensatzes.

    Datentyp: Objekt

    "parent": {
  "display_value": "String",
  "sys_id": "String"
}
    Element.parent.Display_value Textname des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den übergeordneten Namen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.parent.sys_ID SYS_ID des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.product Details zum Produktmodell, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diese Informationen, um die Services zu identifizieren, die einem Produktmodell zugeordnet sind.

    Datentyp: Objekt

    "product": {
  "display_value": "String",
  "sys_id": "String"
}
    item.product.display_value Textname des Produktmodells, das dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Produktnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.product.sys_id SYS_ID des Produktmodelldatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Artikel.Menge Anzahl der installierten Elemente.

    Datentyp: Ganzzahl
    item.service_context Details zum Servicekontext, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.display_value Details zum Servicekontext, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

    "service_context": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_context.sys_id SYS_ID des Servicekontextdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.service_organization Details zur Serviceorganisation, die dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin „Serviceorganisation“ (com.snc.service_organization) installiert ist.

    Datentyp: Objekt

    "service_organization": {
  "display_value": "String",
  "sys_id": "String"
}
    item.service_organization.display_value Textname der Serviceorganisation, die dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Namen der Serviceorganisation in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.service_organization.sys_id SYS_ID des Serviceorganisationsdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Element.sys_class_Name Tabelle, die den Installationsbasiselement-Datensatz enthält.

    Datentyp: Zeichenfolge
    Element.sys_ID SYS_ID des Installationsbasiselementdatensatzes. Befindet sich in der in angegebenen Tabelle sys_class_nameParameter.

    Datentyp: Zeichenfolge
    Element.Status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

    "state": {
  "display_value": "String",
  "value": "String"
}
    Element.Status.Display_Wert Textzeichenfolge des aktuellen Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Status Details zum Status des Installationsbasiselements.

    Datentyp: Objekt

    "status": {
  "display_value": "String",
  "value": "String"
}
    Element.Status.Display_value Textzeichenfolge des Status des Installationsbasiselements. Verwenden Sie diesen Wert, um den Status in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Status.Wert Interner Wert des Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    Element.Deinstallationsdatum Details zum Datum, an dem das Installationsbasiselement inaktiv wurde.

    Datentyp: Objekt

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    Element.Uninstall_date.Display_value Datum der Textdeinstallation. Verwenden Sie diesen Wert, um das Deinstallationsdatum in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Element.Uninstall_date.value Interner Wert des Deinstallationsdatums.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie Sie einen einzelnen Installationsbasiselement-Datensatz erstellen.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\":\"Base Monitor\",
  \"quantity\": 4,
  \"account\":\"86837a386f0331003b3c498f5d3ee4ca\",
  \"contact\": \"dc0185d94f341200025ba3618110c77c\",
  \"configuration_item\":\"0c43baaac61122750182c132ee74bcf0\",
  \"state\":\"in_use\"
}" \
--user 'username':'password'

    Ergebnisse zurückgeben: Nur nicht leere Felder werden zurückgegeben.

    {
  "result": {
    "status": "SUCCESS",
    "item": {
      "sys_class_name": "sn_install_base_item",
      "number": "IBITM0001003",
      "sys_id": "27cb093114c66910f877324710112fd6",
      "contact": {
        "sys_id": "dc0185d94f341200025ba3618110c77c",
        "display_value": "Cindy Contact"
      },
      "state": {
        "value": "in_use",
        "display_value": "In Use"
      },
      "quantity": "4",
      "active": "true",
      "configuration_item": {
        "sys_id": "0c43baaac61122750182c132ee74bcf0",
        "display_value": "3D Pinball"
      },
      "name": "Base Monitor",
      "account": {
        "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
        "display_value": "Boxeo"
      }
    }
  }
}

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie mehrere Datensätze für Installationsbasiselemente erstellt werden.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/installbaseitems" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "[
  {
    \"name\":\"AST4 Laptop\",
    \"consumer\":\"b119803fdb1b1200b6075200cf961917\",
    \"status\":\"replacement\",
    \"install_date\":\"2023-05-18 12:00:00\",
    \"uninstall_date\":\"2023-09-28 12:00:00\"
  },
{
    \"name\":\"Base Monitor\",
    \"quantity\": 4,
    \"account\":\"86837a386f0331003b3c498f5d3ee4ca\",
    \"contact\": \"dc0185d94f341200025ba3618110c77c\",
    \"configuration_item\":\"0c43baaac61122750182c132ee74bcf0\",
    \"state\":\"in_use\"
  }
]" \
--user 'username':'password'

    Ergebnisse zurückgeben: Nur nicht leere Felder werden zurückgegeben.

    {
  "result": {
    "status": "SUCCESS",
    "items": [
      {
        "status": "SUCCESS",
        "item": {
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001018",
          "sys_id": "16fe91b1140a6910f877324710112f40",
          "uninstall_date": {
            "value": "2023-09-28 12:00:00",
            "display_value": "2023-09-28 05:00:00"
          },
          "install_date": {
            "value": "2023-05-18 12:00:00",
            "display_value": "2023-05-18 05:00:00"
          },
          "consumer": {
            "sys_id": "b119803fdb1b1200b6075200cf961917",
            "display_value": "Silvester Erik"
          },
          "active": "true",
          "name": "AST4 Laptop",
          "status": {
            "value": "replacement",
            "display_value": "Replacement"
          }
        }
      },
      {
        "status": "SUCCESS",
        "item": {
          "sys_class_name": "sn_install_base_item",
          "number": "IBITM0001019",
          "sys_id": "5efe91b1140a6910f877324710112f40",
          "contact": {
            "sys_id": "dc0185d94f341200025ba3618110c77c",
            "display_value": "Cindy Contact"
          },
          "state": {
            "value": "in_use",
            "display_value": "In Use"
          },
          "quantity": "4",
          "active": "true",
          "configuration_item": {
            "sys_id": "0c43baaac61122750182c132ee74bcf0",
            "display_value": "3D Pinball"
          },
          "name": "Base Monitor",
          "account": {
            "sys_id": "86837a386f0331003b3c498f5d3ee4ca",
            "display_value": "Boxeo"
          }
        }
      }
    ]
  }
}

    Installationsbasiselement – POST /sn_install_Base/Integrations/installbaseitems/{ID}/relatedParties

    Erstellt einen Datensatz einer zugehörigen Partei und ordnet ihn einem angegebenen Installationsbasiselement-Datensatz zu. Die in den Anforderungsparametern angegebenen Werte werden im neu erstellten Datensatz der zugehörigen Partei gespeichert.

    URL-Format

    Versionierte URL: /api/sn_install_Base/{api_Version}/Integrations/installbaseitems/{ID}/relatedParties

    Standard-URL: /api/sn_install_Base/Integrations/installbaseitems/{ID}/relatedParties

    Hinweis:
    Verfügbare Versionen werden in angegeben REST API-Explorer . Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf der Formular „geskripteter REST-Service“ .

    Unterstützte Anforderungsparameter

    Tabelle : 91. Pfadparameter
    Name Beschreibung
    api_version Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: v1 Oder v2 . Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden.

    Datentyp: Zeichenfolge
    id SYS_ID des Installationsbasiselementdatensatzes.

    Datentyp: Zeichenfolge

    Tabelle: Installationsbasiselement [sn_install_Base_item]
    Tabelle : 92. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 93. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Account Erforderlich, wenn typeParameter ist einer der folgenden:
    • Autorisiertes Konto
    • Autorisierter Kontakt
    • Aufgelisteter Account
    • Gelisteter Kontakt

    SYS_ID des Accounts, der dem Installationsbasiselement zugeordnet werden soll.

    Hinweis:
    Wenn Sie bestehen accountParameter, können Sie nicht auch übergeben consumerParameter.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account]
    Verbraucher Erforderlich, wenn typeParameter ist Autorisierter Verbraucher Oder Gelisteter Verbraucher .
    SYS_ID des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Wenn Sie bestehen consumerParameter, können Sie nicht auch übergeben accountParameter. Darüber hinaus können Sie einen Verbraucher nur dann einem Installationsbasiselement zuordnen, wenn das B2B2B2C-Plugin in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge

    Tabelle: Verbraucher [csm_Consumer]
    Kontakt SYS_ID des Kontaktdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Kontakt [Customer_contact]
    Install_Base_item SYS_ID des Installationsbasiselementdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    Verantwortlichkeit SYS_ID des zugehörigen Verantwortungsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Installationsbasisinformationen.

    Dieser Parameter ist nur gültig, wenn related_partyFeld ist ebenfalls angegeben. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die beiden entsprechen related_partyUnd responsibilityParameter.

    Weitere Informationen finden Sie unter Configure related parties for Items Received

    Datentyp: Zeichenfolge

    Tabelle: Verantwortlichkeitsdefinition [sn_customerservice_Responsibility_def]
    Service_Organization Erforderlich, wenn typeParameter ist einer der folgenden:
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Aufgelistetes Mitglied
    • Aufgelistete Serviceorganisation

    SYS_ID des Datensatzes der Serviceorganisation, der an der Bereitstellung des Service für den Kunden beteiligt ist.

    Hinweis:
    Wenn Sie diesen Parameter übergeben, sollten Sie nicht auch die Parameter „Account“, „Kontakt“ oder „Verbraucher“ übergeben. Die service_organizationDer Parameter ist nur verfügbar, wenn das Plugin „Serviceorganisation“ (com.snc.service_organization) in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge

    Tabelle: Serviceorganisation [sn_Customer_Service_Organization]
    sys_class_name Tabelle, die den Datensatz der zugehörigen Parteien enthält.

    Datentyp: Zeichenfolge

    Standard: sn_install_Base_related_Party
    type Erforderlich. SYS_ID des Typs der zu erstellenden zugehörigen Partei.
    Mögliche Typen:
    • Autorisiertes Konto
    • Autorisierter Verbraucher
    • Autorisierter Kontakt
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Aufgelisteter Account
    • Gelisteter Verbraucher
    • Gelisteter Kontakt
    • Gelisteter Beitragender
    • Aufgelistetes Mitglied
    • Aufgelistete Serviceorganisation

    Datentyp: Zeichenfolge

    Tabelle: Konfiguration der zugehörigen Partei [sn_customerservice_related_Party_Configuration]
    Anwender Erforderlich, wenn typeDer Parameter ist einer der folgenden zugehörigen Parteitypen:
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Gelisteter Beitragender
    • Aufgelistetes Mitglied

    Für Autorisiertes Mitglied Und Aufgelistetes Mitglied , Dieser Anwender muss dem angegebenen zugeordnet sein service_organizationDatensatz.

    SYS_ID des Anwenderdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .

    Tabelle : 94. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Inhaltstyp Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 95. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

    Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .

    Tabelle : 96. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz.
    404 Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Account Details zum Account, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    account": {
  "display_value": "String",
  "sys_id": "String"
}
    Account.Display_value Textname des Accounts, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Accountnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Account.sys_ID SYS_ID des Account-Datensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    Verbraucher Details zum Verbraucher, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "consumer": {
  "display_value": "String",
  "sys_id": "String"
}
    Consumer.Display_value Textname des Verbrauchers, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Verbrauchernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Consumer.sys_ID SYS_ID des Verbraucherdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    Kontakt Details zum Account-Kontakt, der für den Datensatz der zugehörigen Parteien verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    Contact.Display_value Textname des Kontakts, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Kontaktnamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Contact.sys_ID SYS_ID des Kontaktdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Kontakt [Customer_contact]
    Fehler Details zum Fehler, der beim Verarbeiten der Anforderung aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    error.detail Zusätzliche Details zum zugehörigen Fehler.

    Datentyp: Zeichenfolge
    Fehler.Nachricht Fehlermeldung, die das Problem beschreibt, das beim Versuch, die Anforderung auszuführen, aufgetreten ist.

    Datentyp: Zeichenfolge
    Install_Base_item Details zum Installationsbasiselement, das dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    Install_Base_item.Display_value Textname des Installationsbasiselements, das dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Namen des Installationsbasiselements in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Install_Base_item.sys_ID SYS_ID des Installationsbasiselementdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    Verantwortlichkeit Details zur Zugriffsebene für die Installationsbasisinformationen.

    Datentyp: Objekt

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    Verantwortlichkeit.Display_value Textanzeigewert für die Zugriffsebene für die Installationsbasisinformationen.

    Datentyp: Zeichenfolge
    Responsibility.sys_ID SYS_ID des zugehörigen Verantwortungsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Installationsbasisinformationen.

    Dieser Parameter ist nur gültig, wenn related_partyFeld ist ebenfalls angegeben. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die beiden entsprechen related_partyUnd responsibilityParameter.

    Weitere Informationen finden Sie unter Configure related parties for Items Received

    Datentyp: Zeichenfolge

    Tabelle: Verantwortlichkeitsdefinition [sn_customerservice_Responsibility_def]
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sys_class_name Tabelle, die den Datensatz der zugehörigen Parteien enthält.

    Datentyp: Zeichenfolge

    Standard: sn_install_Base_related_Party
    sys_id SYS_ID des Datensatzes der zugehörigen zugehörigen Parteien.

    Datentyp: Zeichenfolge
    sysparm_limit Anzahl der zurückgegebenen Datensätze. Wenn dieser Wert nicht in der ursprünglichen Anforderung angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugehörigen Tabelle, aus der Datensätze ausgewertet und abgerufen wurden.

    Datentyp: Zeichenfolge
    type Details zum Typ des Kontakts, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "type": {
  "display_value": "String",
  "sys_id": "String"
}
    Typ.Display_value Textname des Kontakttyps, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Typ des Kontakts in der Anwenderoberfläche anzuzeigen. Weitere Informationen finden Sie unter Create related party configurations.
    Mögliche Typen:
    • Autorisiertes Konto
    • Autorisierter Verbraucher
    • Autorisierter Kontakt
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Aufgelisteter Account
    • Gelisteter Verbraucher
    • Gelisteter Kontakt
    • Gelisteter Beitragender
    • Aufgelistetes Mitglied
    • Aufgelistete Serviceorganisation

    Datentyp: Zeichenfolge
    Typ.sys_ID SYS_ID des Typdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    Anwender Details zum Anwender, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

    "user": {
  "display_value": "String",
  "sys_id": "String"
}
    User.Display_value Textname des Anwenders, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Anwendernamen in der Anwenderoberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    Anwender.sys_ID
    SYS_ID des Anwenderdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Benutzer [sys_user]

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um einen Datensatz im Zusammenhang mit einem autorisierten Account zu erstellen und ihn einem Installationsbasiselement zuzuordnen.

    curl "https://instance.servicenow.com/api/sn_install_base/integrations/relatedparties/f77c7542b7343300ece839a6ee11a991" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  "contact":"0a232a0013691200042ab3173244b075",
  "type":"68ec8b2965e99110f87764df53db779f",
  "account":"86837a386f0331003b3c498f5d3ee4ca",
  "install_base_item":"f77c7542b7343300ece839a6ee11a991",
  "responsibility":"c009bbedb3730010700b4d43c6a8dcef",
  "sys_class_name":"sn_install_base_related_party"
}" \
--user 'username':'password'

    Ergebnisse zurückgeben:

    {
"result":
  {
    "type": {
      "display_value":"Authorized Contact",
      "sys_id":"68ec8b2965e99110f87764df53db779f"
    },
    "install_base_item": {
      "display_value":"KX Series - KX5000",
      "sys_id":"f77c7542b7343300ece839a6ee11a991"
    },
    "sys_class_name":"sn_install_base_related_party",
    "sys_id":"4659539814ac6910f877ae314c1fb43a",
    "responsibility": {
      "display_value":"Authorized Representative",
      "sys_id":"c009bbedb3730010700b4d43c6a8dcef"
    },
    "contact": {
      "display_value":"Cindy Contact",
      "sys_id":"dc0185d94f341200025ba3618110c77c"
    },
    "account": {
      "display_value":"Boxeo",
      "value":"86837a386f0331003b3c498f5d3ee4ca"
    },
    "status":"SUCCESS",
  }
}