Installationsbasiselement-API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 120 Minuten Lesedauer

    • Mit der Installationsbasiselement-API können Sie in einer ServiceNow-Instanz auf Datensätze von Installationsbasiselementen zugreifen und diese verwalten.

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

    Mit dieser API können Sie auch CRUD-Vorgänge für die zugehörige 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 entweder die Rolle sn_install_base.ib_api_write oder sn_install_base.ib_api_read, abhängig vom Typ der CRUD-Aktion, die Sie ausführen möchten.

    Für den Zugriff auf die verschiedenen Endpunkte in dieser API müssen die folgenden Plugins installiert sein:
    • Customer Service Install Base Management (com.snc.install_base)
    • Planned Work Management (Planned Work Management) (sn_fsm_planned_wm), wenn Sie Wartungsplan- und Arbeitsauftragsdaten abrufen möchten.

    Diese API wird im Namespace sn_install_base ausgeführt.

    Hinweis:
    Diese API gibt nur nicht leere Felder in den Endpunktantworten zurück. Außerdem wird keines der Felder auf Systemebene (mit dem Präfix „sys_“) zurückgegeben, mit Ausnahme des Felds sys_id.

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

    Installationsbasiselement – DELETE /sn_install_base/integrations/installbasetems/{id}/relatedparties/{related_party_sys_id}

    Hebt die Zuordnung eines angegebenen Datensatzes zugehöriger Parteien von einem angegebenen Installationsbasiselement-Datensatz auf.

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems/{id}/relatedparties/{related_party_sys_id}

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/relatedparties/{related_party_sys_id}

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    related_party_sys_id Sys_id des Datensatzes der zugehörigen Partei. Standardmäßig befindet sich diese in der Tabelle „Installationsbasis – Zugehörige Partei“ [sn_install_base_related_party].

    Datentyp: Zeichenfolge
    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    403 Unzulässig. Der Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    Ergebnis Beschreibung der Endpunktergebnisse.

    Datentyp: Objekt
    result.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/installbasetems

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

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems

    Standard-URL: /api/sn_install_base/integrations/installbasetems

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Feld Name-Wert-Paare Feld-Wert-Paare, die zum Filtern der Installationsbasiselement-Datensätze verwendet werden. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_istall_base_item]. Wenn Sie eine andere Tabelle in sys_class_nameangeben, geben Sie die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die zurückgegebenen Ergebnisse zu filtern.

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

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    related_party Sys_id eines Datensatzes einer zugehörigen Partei. Befindet sich in der Tabelle „Installationsbasis – Zugehörige Partei“ [sn_install_base_related_party].

    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:
    • sys_id des Accounts – befindet sich in der Account-Tabelle [customer_account].
    • sys_id des Verbrauchers – befindet sich in der Tabelle „Verbraucher“ [csm_consumer].
    • sys_id des Kontakts – befindet sich in der Kontakttabelle [customer-contact].
    • sys_id der Serviceorganisation – befindet sich in der Tabelle „Serviceorganisation“ [sn_customer_service_organization].
    • sys_id des Benutzers – befindet sich in der Benutzertabelle [sys-user].

    Datentyp: Zeichenfolge
    Verantwortlichkeit Sys_id des zugeordneten Zuständigkeitsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Informationen zur Installationsbasis.

    Dieser Parameter ist nur gültig, wenn auch das Feld related_party angegeben ist. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die den Parametern related_party und responsibility entsprechen.

    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 abzufragenden erweiterten Tabelle.

    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: 10.000
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie 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
    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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (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 Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze vorhanden sind, die zurückgegeben werden sollen.
    Mögliche Werte:
    • true: Weitere zurückzugebende Datensätze.
    • false: Keine weiteren Datensätze zurückzugeben.

    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"
  }
]
    items.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 Kunden-Accounts in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.account.sys_id Sys_id des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.active Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • true: Installationsbasiselement ist aktiv.
    • false: Installationsbasiselement ist inaktiv.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.asset.sys_id Sys_id des Asset-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.configuration_item Details zum Konfigurationselement, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.configuration_item.sys_id Sys_id des Konfigurationselement-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.consumer Details zum Verbraucher, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Verbraucherfeld ist nur verfügbar, wenn das B2B2C-Plugin installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.consumer.sys_id Sys_id des Verbraucherdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.consumer_profile Details zum Verbraucherprofil, das dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld „Verbraucherprofil“ ist nur verfügbar, wenn das B2B2C-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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.consumer_profile.sys_id Sys_id des Verbraucherprofil-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.contact Details zum Account-Kontakt, der für den Datensatz des Installationsbasiselements verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    items.contact.display_value Textname des Account-Kontakts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Account-Kontaktnamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.contact.sys_id Sys_id des Account-Kontaktdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.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"
}
    items.health_status.display_value Textzeichenfolge des aktuellen Integritätsstatus des Installationsbasiselements. Verwenden Sie diesen Wert, um den Integritätsstatus in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.health_status.value Interner Wert des Integritätsstatus des Installationsbasiselements.

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

    Datentyp: Zeichenfolge
    items.household Details zum Haushalt, der dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin „Customer Service Household“ (com.snc.household) installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.household.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 Benutzeroberfläche anzuzeigen.

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

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

    Datentyp: Objekt

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    items.location.display_value Textname des Speicherorts des Installationsbasiselements. Verwenden Sie diesen Wert, um den Standortnamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.location.sys_id Sys_id des Standortdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    items.number Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    items.übergeordnet Details zum übergeordneten Datensatz des Installationsbasiselement-Datensatzes.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.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 Benutzeroberflä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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.service_context.sys_id Sys_id des Service-Kontextdatensatzes, 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 „Service Organization“ (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 Benutzeroberflä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 Datensatz des Installationsbasiselements enthält.

    Datentyp: Zeichenfolge
    items.sys_id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der im Parameter sys_class_name angegebenen Tabelle.

    Datentyp: Zeichenfolge
    items.sys_mod_count Anzahl, die angibt, wie oft der zugeordnete Datensatz des Installationsbasiselements geändert wurde.

    Datentyp: Zeichenfolge
    items.status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.state.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    items.status Details zum Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.status.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    items.uninstall_date Details zum Datum, an dem das Installationsbasiselement inaktiv wurde.

    Datentyp: Objekt

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    items.uninstall_date.display_value Text-Deinstallationsdatum. Verwenden Sie diesen Wert, um das Deinstallationsdatum in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.uninstall_date.value Interner Wert des Deinstallationsdatums.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sysparm_tiefe Anzahl der Ebenen, in denen sich das zurückgegebene untergeordnete Installationsbasiselement in der Hierarchie befindet.

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

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugeordneten 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, beginnend bei Offset 5.

    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 in der Tabelle „Installationsbasiselement“ nach den Feldern state = „in_use“ und status = „replacement“ gesucht wird.

    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 zurückgegebenen Ergebnisse mithilfe der Abfrageparameter related_party und responsibility gefiltert werden.

    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/installbasetem/{id}

    Gibt einen angegebenen Installationsbasiselement-Datensatz und seine untergeordnete Hierarchie zurück.

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetem/{id}

    Standard-URL: /api/sn_install_base/integrations/installbasetem/{id}

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    sys_class_name Wenn sich der gewünschte Datensatz in einer Tabelle befindet, die die Tabelle „Installationsbasiselemente“ [sn_install_base_item] erweitert, der Name der abzufragenden erweiterten Tabelle. Diese Tabelle muss die Tabelle sn_install_base_item erweitern.

    Datentyp: Zeichenfolge
    sysparm_tiefe Maximale Tiefe der zurückzugebenden Hierarchie des untergeordneten Installationsbasiselements.

    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

    Höchstwert: 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 HTTP-Antwortcodesder REST-API.

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    childinstallbase Liste der untergeordneten Installationsbasiselement-Datensätze, 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 werden weiter unten in diesem Abschnitt unter dem Array items[] definiert.
    childinstallbase.sysparm_tiefe Untergeordnete Ebene des Installationsbasiselements.

    Datentyp: Ganzzahl
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    has_child Kennzeichnung, die angibt, ob der angeforderte Installationsbasiselement-Datensatz über untergeordnete Installationsbasiselement-Datensätze verfügt.
    • true: Hat untergeordnete Datensätze für Installationsbasiselemente.
    • false: Hat keine Datensätze für untergeordnete Installationsbasiselemente.

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

    Datentyp: Array von Objekten

    "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"
}
    item.account Details zum Kunden-Account, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.account.sys_id Sys_id des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.active Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • true: Installationsbasiselement ist aktiv.
    • false: Installationsbasiselement ist inaktiv.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.asset.sys_id Sys_id des Asset-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.configuration_item Details zum Konfigurationselement, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.configuration_item.sys_id Sys_id des Konfigurationselement-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.consumer Details zum Verbraucher, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Verbraucherfeld ist nur verfügbar, wenn das B2B2C-Plugin installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.consumer.sys_id Sys_id des Verbraucherdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.consumer_profile Details zum Verbraucherprofil, das dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld „Verbraucherprofil“ ist nur verfügbar, wenn das B2B2C-Plugin installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.consumer_profile.sys_id Sys_id des Verbraucherprofil-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.contact Details zum Account-Kontakt, der für den Datensatz des Installationsbasiselements verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Textname des Account-Kontakts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Account-Kontaktnamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.contact.sys_id Sys_id des Account-Kontaktdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.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"
}
    item.health_status.display_value Textzeichenfolge des aktuellen Integritätsstatus des Installationsbasiselements. Verwenden Sie diesen Wert, um den Integritätsstatus in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.health_status.value Interner Wert des Integritätsstatus des Installationsbasiselements.

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

    Datentyp: Zeichenfolge
    item.household Details zum Haushalt, der dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin „Customer Service Household“ (com.snc.household) installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.household.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 Benutzeroberflä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"
}
    item.location.display_value Textname des Speicherorts des Installationsbasiselements. Verwenden Sie diesen Wert, um den Standortnamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.location.sys_id Sys_id des Standortdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.number Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    item.parent Details zum übergeordneten Datensatz des Installationsbasiselement-Datensatzes.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.übergeordnet.sys_id Sys_id des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Artikel.Produkt 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 Benutzeroberflä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 Service-Kontextdatensatzes, 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 „Service Organization“ (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 Benutzeroberfläche anzuzeigen.

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

    Datentyp: Zeichenfolge
    item.sys_class_name Tabelle, die den Datensatz des Installationsbasiselements enthält.

    Datentyp: Zeichenfolge
    item.sys_id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der im Parameter sys_class_name angegebenen Tabelle.

    Datentyp: Zeichenfolge
    item.sys_mod_count Anzahl, die angibt, wie oft der zugeordnete Datensatz des Installationsbasiselements geändert wurde.

    Datentyp: Zeichenfolge
    item.status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.state.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.status Details zum Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.status.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.uninstall_date Details zum Datum, an dem das Installationsbasiselement inaktiv wurde.

    Datentyp: Objekt

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    item.uninstall_date.display_value Text-Deinstallationsdatum. Verwenden Sie diesen Wert, um das Deinstallationsdatum in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.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 weist keine untergeordneten Elemente auf.

    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/installbasetems/{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/installbasetems/{id}/cases

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/cases

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Feld Name-Wert-Paare Feld-Wert-Paare, die zum Filtern der Falldatensätze verwendet werden sollen. Standardmäßig verweist dies auf die Felder in der Falltabelle [sn_customerservice_case]. Wenn Sie eine andere Tabelle in sys_class_nameangeben, geben Sie die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die zurückgegebenen Ergebnisse 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

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer erweiterten Falltabelle (nicht sn_customerservice_case) der Name der abzufragenden erweiterten Tabelle.

    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: 10.000
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie 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
    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 HTTP-Antwortcodesder REST-API.

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    400 Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
    403 Unzulässig. Der Benutzer 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.

    Antworttextparameter (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.Konto Sys_id des Account-Datensatzes, der dem Fall zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account].

    Datentyp: Zeichenfolge
    Fälle.aktiv Kennzeichnung, die angibt, ob der Fall offen und aktiv ist.

    Mögliche Werte:

    • true: Fall ist aktiv
    • false: Fall ist geschlossen

    Datentyp: Boolesch

    Standardwert: true
    fälle.active_account_escalation Sys_id des aktiven Account-Eskalationsdatensatzes, der dem Fall zugeordnet ist. Befindet sich in der Eskalationstabelle [sn_customerservice_escalation].

    Datentyp: Zeichenfolge
    fälle.aktive_eskalation Sys_id des aktiven Eskalationsdatensatzes, der dem Fall zugeordnet ist. Befindet sich in der Eskalationstabelle [sn_customerservice_escalation].

    Datentyp: Zeichenfolge
    fälle.aktivität_due Datum, für das der Abschluss des zugeordneten Falls erwartet wird.

    Datentyp: Zeichenfolge
    fälle.zusätzliche_Beauftragte_Liste Liste der sys_ids der zusätzlichen Personen (außer dem primären Beauftragten), die dem Account zugewiesen wurden. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Array

    Maximum: 4.000
    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

    Maximale Zeichen: 40

    Standard: nicht angefordert
    fälle.approval_history Liste aller Genehmigungen, die dem Fall zugeordnet sind.

    Datentyp: Zeichenfolge

    Maximale Zeichen: 4.000
    fälle.approval_set Datum und Uhrzeit der Genehmigung der zugeordneten Aktion.

    Datentyp: Zeichenfolge
    Fälle.asset Sys_id des Asset-Datensatzes, der dem Fall zugeordnet ist. Befindet sich in der Asset-Tabelle [alm_asset].

    Datentyp: Zeichenfolge
    fälle.assigned_on Datum und Uhrzeit, zu der der Fall der im Parameter assigned_to angegebenen Person zugewiesen wurde.

    Datentyp: Zeichenfolge (Datum)

    Maximale Länge: 40
    fälle.zugewiesen_zu Sys_id der Person, die dem Fall zugewiesen ist. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge
    Fälle.Zuweisungsgruppe Sys_id der Kundenservice-Mitarbeitergruppe, die dem Fall zugewiesen ist. Befindet sich in der Gruppentabelle [sys_user_group].

    Datentyp: Zeichenfolge
    fälle.auto_close Kennzeichnung, die angibt, ob der Fall automatisch geschlossen wurde.

    Mögliche Werte:

    • true: Fall wurde automatisch geschlossen
    • false: Fall wurde nicht automatisch geschlossen

    Datentyp: Boolesch

    Standardwert: false
    fälle.business_duration Länge in Kalenderarbeitsstunden, Arbeitstagen und Arbeitswochen, die zum Abschließen des Falls benötigt wurden.

    Datentyp: Zeichenfolge
    fälle.business_impact Auswirkung des Problems auf den zugeordneten Kunden.

    Datentyp: Zeichenfolge

    Maximale Zeichen: 4.000
    fälle.business_service Sys_id des Servicedatensatzes, der dem Fall zugeordnet ist. Befindet sich in der Tabelle „Service“ [cmdb_ci_service].

    Datentyp: Zeichenfolge
    fälle.kalender_duration Dauer in Kalenderstunden, Tagen und Wochen, die zum Abschließen des Falls benötigt wurde.

    Datentyp: Zeichenfolge (Dauer)

    Maximale Länge: 40
    Fälle.Fall Kurzbeschreibung und Fallnummer des Falls.

    Datentyp: Zeichenfolge

    Maximale Länge: 300
    fälle.case_report Sys_id des zugeordneten Fallberichts. Befindet sich in der Fallberichtstabelle [sn_customerservice_case_report].

    Datentyp: Zeichenfolge
    Fälle.Kategorie Fallkategorie.

    Mögliche Werte:

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

    Datentyp: Zahl (Integer)

    Standard: 1
    Fälle.Ursache Details zur Ursache des Problems.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    fälle.cause_by Sys_id der Change-Anforderung, die die Erstellung des Falls verursacht hat. Befindet sich in der Change Request-Tabelle [change_request].

    Datentyp: Zeichenfolge
    Fälle.ändern Sys_id der Change-Anforderung, die die Erstellung des Falls verursacht hat. Befindet sich in der Change Request-Tabelle [change_request].

    Datentyp: Zeichenfolge
    fälle.child_case_creation_progress Kennzeichnung, die angibt, ob der Fall ein untergeordneter Fall ist, der aus einem schwerwiegenden Fall erstellt wurde.

    Mögliche Werte:

    • true: Untergeordneter Fall aus einem schwerwiegenden Fall erstellt
    • false: 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 Benutzers, der den Fall geschlossen hat. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge
    Fälle.close_notes Notizen, die beim Schließen des Falls erstellt wurden.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    fälle.cmdb_ci Sys_id des Konfigurationselements, das dem Fall zugeordnet ist. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci].

    Datentyp: Zeichenfolge
    Fälle.Kommentare Zusätzliche Kommentare zum Fall.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    fälle.comments_and_work_notes Für den Fall eingegebene Kommentare und Arbeitsnotizen.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    Fälle.company Sys_id des Unternehmens, das dem Fall zugeordnet ist. Befindet sich in der Tabelle „Unternehmen“ [core_company].

    Datentyp: Zeichenfolge
    Fälle.Verbraucher Nur Business-to-Consumer-Fälle. Sys_id der Person, die in Bezug auf diesen Fall kontaktiert werden soll. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer].

    Datentyp: Zeichenfolge
    Fälle.Kontakt Nur Business-to-Business-basierte Fälle. Sys_id der Person, die bezüglich dieses Falls kontaktiert werden soll. Befindet sich in der Kontakttabelle [customer_contact].

    Datentyp: Zeichenfolge
    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, in der der Fall ursprünglich gemeldet wurde.
    Mögliche Werte:
    • Chat
    • E-Mail
    • Telefon
    • sozial
    • Web

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    Fälle.Vertrag Sys_id des Vertrags, der dem Fall zugeordnet ist. Befindet sich in der Tabelle „Vertrag“ [ast_contract]. Dieser Vertrag enthält Informationen über die Art des Supports, der dem Unternehmen gewährt wird, das dem Fall zugeordnet ist. 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
    Fälle.Beitragende_Gruppen Liste der sys_ids der Benutzergruppen, die zu dem Fall beigetragen haben. Befindet sich in der Gruppentabelle [sys_user_group].

    Datentyp: Zeichenfolge
    Fälle.Beitragender_Benutzer Liste der sys_ids der Benutzer, die zu dem Fall beigetragen haben. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge
    fälle.correlation_display Korrelationsanzeige.

    Datentyp: Zeichenfolge

    Maximale Länge: 100
    fälle.correlation_id Korrelationsbezeichner.

    Datentyp: Zeichenfolge

    Maximale Länge: 100
    fälle.delivery_plan Sys_id des übergeordneten Ausführungsplans für diesen Fall. Befindet sich in der Tabelle „Ausführungsplan“ [sc_cat_item_delivery_plan].

    Datentyp: Zeichenfolge
    Fälle.Lieferung_Aufgabe Sys_id der Ausführungsplanaufgabe. Befindet sich in der Tabelle „Ausführungsplanaufgabe“ [sc_cat_item_delivery_task].

    Datentyp: Zeichenfolge
    fälle.beschreibung 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. Befindet sich in der Berechtigungstabelle [service_entitlement]. 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
    Fälle.Eskalation Aktuelle Eskalationsebene.

    Mögliche Werte:

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

    Datentyp: Zahl (Integer)

    Standard: 0
    fälle.expected_start Datum und Uhrzeit, zu der die Arbeit an dem Fall beginnen soll.

    Datentyp: Zeichenfolge
    fälle.first_response_time Datum und Uhrzeit der ersten Aktion für den Fall.

    Datentyp: Zeichenfolge
    fälle.follow_the_sun Kennzeichnung, die angibt, ob der Fall für die globale Nachverfolgung übergeben werden soll.

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

    Mögliche Werte:

    • true: Fall muss für globale Nachverfolgung übergeben werden
    • false: Fall darf nicht an die globale Nachverfolgung übergeben werden

    Datentyp: Boolesch

    Standardwert: false
    fälle.follow_up Datum und Uhrzeit der nächsten Folgeaktion.

    Datentyp: Zeichenfolge
    Fälle.Gruppe_Liste Liste der sys_ids der Gruppendatensätze, die dem Fall zugeordnet sind. Befindet sich in der Gruppentabelle [sys_user_group].

    Datentyp: Array
    Fälle.Auswirkung Auswirkung auf den Kunden.

    Mögliche Werte:

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

    Datentyp: Zahl (Integer)

    Standard: 3
    fälle.internal_user Sys_id des internen Benutzers für diesen Fall. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge
    fälle.initiiert_as_request Kennzeichnung, die angibt, ob diese Anfrage als Anforderung des Kunden initiiert wurde.

    Mögliche Werte:

    • true: Anfrage vom Kunden initiiert.
    • „false“: Anfrage wurde nicht vom Kunden initiiert.

    Datentyp: Boolesch

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

    Mögliche Werte:

    • true: Knowledge Base-Artikel ist für dieses Problem verfügbar
    • false: 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. Befindet sich in der Tabelle „Standort“ [cmn_location].

    Datentyp: Zeichenfolge
    Fälle.gefertigt_sla Kennzeichnung, die angibt, ob der Fall in Übereinstimmung mit der zugehörigen Servicelevel-Vereinbarung gelöst wurde.

    Mögliche Werte:

    • true: Fall wurde in Übereinstimmung mit dem SLA gelöst
    • false: Fall wurde nicht gemäß SLA gelöst

    Datentyp: Boolesch

    Standardwert: true
    fälle.major_case_state Aktueller Status des schwerwiegenden Falls.

    Mögliche Werte:

    • akzeptiert: Anfangsstatus, wenn ein Manager einen schwerwiegenden Fall erstellt oder einen Kandidatenfall heraufstuft.
    • abgebrochen: Fall wurde abgebrochen.
    • Vorgeschlagen: Anfangsstatus, wenn ein Service Desk-Mitarbeiter oder Manager einen Kandidatenfall erstellt oder vorschlägt.
    • abgelehnt: Vom Manager abgelehnter Kandidatenfall.

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    Bedarf_Aufmerksam Kennzeichnung, die angibt, ob der Fall Aufmerksamkeit erfordert.

    Mögliche Werte:

    • true: Fall erfordert zusätzliche Aufmerksamkeit
    • false: Fall erfordert keine zusätzliche Aufmerksamkeit

    Datentyp: Boolesch

    Standardwert: false
    fälle.notes_to_comments Kennzeichnung, die angibt, ob die Lösungsnotizen zu den Kommentaren hinzugefügt werden sollen.

    Mögliche Werte:

    • true: Lösungshinweise werden, wenn sie hinzugefügt werden, auch den Kommentaren hinzugefügt
    • false: 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 (Integer)

    Standard: 1
    Fälle.Nummer Fallnummer.

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    fälle.opened_at Datum und Uhrzeit der Eröffnung des Falls.

    Datentyp: Zeichenfolge
    fälle.opened_by Sys_id der Person, die den Fall ursprünglich geöffnet hat. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge
    Fälle.Reihenfolge Reihenfolge des Falls.

    Datentyp: Zahl (Integer)
    Fälle.übergeordnet Sys_id des übergeordneten Falls, dem dieser Fall (untergeordnetes Element) zugeordnet ist. Befindet sich in der Aufgabentabelle [Aufgabe].

    Datentyp: Zeichenfolge
    fälle.partner Sys_id des Partners, der dem Fall zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account].

    Datentyp: Zeichenfolge
    fälle.partner_kontakt Sys_id des Partnerkontakts, der dem Fall zugeordnet ist. Befindet sich in der Kontakttabelle [customer_contact].

    Datentyp: Zeichenfolge
    Fälle.Priorität Priorität des Falls.
    Mögliche Werte:
    • 1: Kritisch
    • 2: Hoch
    • 3: Moderat
    • 4: Niedrig

    Datentyp: Zahl (Integer)

    Standard: 4
    Fälle.proaktiv Kennzeichnung, die angibt, ob die Anfrage proaktiv überwacht wird.

    Mögliche Werte:

    • true: Wird proaktiv überwacht.
    • false: Wird nicht überwacht.

    Datentyp: Boolesch

    Standard: false
    Fälle.probable_cause Mögliche Ursache des Problems, das dem Fall zugeordnet ist.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    Fälle.Problem Sys_id des Problems, mit dem der Kunde konfrontiert wird. Befindet sich in der Problemtabelle [problem].

    Datentyp: Zeichenfolge
    cases.product Sys_id des Produktmodells des Assets, das dem Fall zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model]. Ein Modell ist eine bestimmte Version oder Konfiguration eines Assets (z. B. Apple Mac Book Pro).

    Datentyp: Zeichenfolge
    fälle.reassignment_count Anzahl der Fälle, in denen der Fall einer Person zugewiesen wurde, die für die Weiterentwicklung des Falls verantwortlich ist.

    Datentyp: Zahl (Integer)

    Standard: 0
    fälle.recipient_list Sys_id des Datensatzes, der die Liste der Empfänger für Mitteilungen zu diesem Fall enthält. Befindet sich in der Tabelle „Empfängerliste“ [sn_publications_recipients_list].

    Datentyp: Zeichenfolge
    fälle.rejection_goto Sys_id der auszuführenden Aufgabe, wenn der Fall abgelehnt wird. Befindet sich in der Aufgabentabelle [Aufgabe].

    Datentyp: Zeichenfolge
    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.resolved_at Datum und Uhrzeit der Lösung des Falls.

    Datentyp: Zeichenfolge
    fälle.resolved_by Sys_id der Person, die den Fall gelöst hat. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge
    Fälle.route_reason Grund, warum der Fall an einen anderen Beauftragten weitergeleitet wurde.

    Datentyp: Zahl (Integer)

    Maximale Länge: 40
    fälle.service_offering Sys_id des Serviceangebots, das der Zahlungsanfrage zugeordnet ist. Serviceangebote definieren das Serviceniveau eindeutig in Bezug auf Verfügbarkeit, Umfang, Preisgestaltung und Paketoptionen. Befindet sich in der Serviceangebotstabelle [service_offering].

    Datentyp: Zeichenfolge
    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. Befindet sich in der Kompetenztabelle [cmn_skill].

    Datentyp: Zeichenfolge
    fälle.sla_due Datum/Uhrzeit, zu der der Fall basierend auf der zugehörigen Servicelevel-Vereinbarung geschlossen werden muss.

    Datentyp: Zeichenfolge
    cases.sn_app_cs_social_social_profile Sys_id des Social Media-Profils, das dem Fall zugeordnet ist. Befindet sich in der Tabelle „Social-Profil“ [sn_app_cs_social_social_profile].

    Datentyp: Zeichenfolge
    fälle.sold_product Sys_id des zugeordneten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product].

    Datentyp: Zeichenfolge
    Fälle.Stufe Phase der Anfrage, z. B. „Abgeschlossen“, „Geschlossen – abgelehnt“, „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: Auf Info warten

    Datentyp: Zahl (Integer)

    Standard: 1
    Fälle.Unterkategorie Fallunterkategorie.

    Mögliche Werte:

    0: Frage

    Datentyp: Zahl (Integer)

    Standard: 0
    fälle.support_manager Sys_id des CSM-Managers, der dem Fall zugewiesen ist. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge
    Fälle.sync_driver Kennzeichnung, die angibt, ob eine Treibersynchronisierung erfolgt.

    Mögliche Werte:

    • true: Treiber ist synchronisiert
    • „false“: 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 Identifier für den Fall.

    Datentyp: Zeichenfolge

    Maximale Länge: 32
    fälle.task_effektiv_nummer Identifikationsnummer.

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

    Datentyp: Zeichenfolge

    Maximale Länge: 40
    fälle.time_worked Gesamtbetrag der für den Fall aufgewendeten Zeit.

    Datentyp: Zeichenfolge
    fälle.universal_request Sys_id einer UR-Aufgabe, zu der diese Anfrage gehört. Befindet sich in der Aufgabentabelle [Aufgabe].

    Datentyp: Zeichenfolge
    fälle.nach_approval Aktion, die ausgeführt werden soll, wenn der Fall genehmigt wird.

    Mögliche Werte:

    • tun_nichts
    • fortfahren

    Datentyp: Zeichenfolge

    Maximale Länge: 40

    Standard: Fortfahren
    fälle.upon_reject 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 (Integer)

    Standard: 3
    fälle.user_input Zusätzliche Benutzereingabe.

    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 Benutzer, 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. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Array
    fälle.wf_aktivität Sys_id des Workflow-Aktivitätsdatensatzes, der dem Fall zugeordnet ist. Befindet sich in der Workflow-Aktivitätstabelle [wf_aktivität].

    Datentyp: Zeichenfolge
    Fälle.work_end Datum und Uhrzeit, zu der die Arbeit an dem Fall beendet wurde.

    Datentyp: Zeichenfolge
    Fälle.work_notes Informationen darüber, wie der Fall gelöst werden kann, oder Schritte, die zu seiner Lösung unternommen wurden.

    Datentyp: Zeichenfolge

    Maximale Länge: 4.000
    fälle.work_notes_list Liste der sys_ids der internen Benutzer, die Benachrichtigungen zu diesem Fall erhalten, wenn Arbeitsnotizen hinzugefügt werden. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Array
    Fälle.work_start Datum und Uhrzeit des Beginns der Arbeit am Fall.

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze vorhanden sind, die zurückgegeben werden sollen.
    Mögliche Werte:
    • true: Weitere zurückzugebende Datensätze.
    • false: Keine weiteren Datensätze zurückzugeben.

    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 wird der boolesche Parameter hasMore zurückgegeben. Gibt an, ob weitere Datensätze zurückzugeben 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/installbasisems/{id}/childinstallbasisems

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

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems/{id}/childinstallbasetems

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/childinstallbasetems

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Feld Name-Wert-Paare Feld-Wert-Paare, die zum Filtern der Datensätze des untergeordneten Installationsbasiselements verwendet werden sollen. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item]. Wenn Sie eine andere Tabelle in sys_class_nameangeben, geben Sie die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die zurückgegebenen Ergebnisse zu filtern.

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

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer erweiterten Tabelle mit Installationsbasiselementen (nicht sn_install_base_item) der Name der abzufragenden erweiterten Tabelle.

    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: 10.000
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie 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
    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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze vorhanden sind, die zurückgegeben werden sollen.
    Mögliche Werte:
    • true: Weitere zurückzugebende Datensätze.
    • false: Keine weiteren Datensätze zurückzugeben.

    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"
  }
]
    items.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 Kunden-Accounts in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.account.sys_id Sys_id des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.active Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • true: Installationsbasiselement ist aktiv.
    • false: Installationsbasiselement ist inaktiv.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.asset.sys_id Sys_id des Asset-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.configuration_item Details zum Konfigurationselement, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.configuration_item.sys_id Sys_id des Konfigurationselement-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.consumer Details zum Verbraucher, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Verbraucherfeld ist nur verfügbar, wenn das B2B2C-Plugin installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.consumer.sys_id Sys_id des Verbraucherdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.consumer_profile Details zum Verbraucherprofil, das dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld „Verbraucherprofil“ ist nur verfügbar, wenn das B2B2C-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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.consumer_profile.sys_id Sys_id des Verbraucherprofil-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.contact Details zum Account-Kontakt, der für den Datensatz des Installationsbasiselements verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    items.contact.display_value Textname des Account-Kontakts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Account-Kontaktnamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.contact.sys_id Sys_id des Account-Kontaktdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.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"
}
    items.health_status.display_value Textzeichenfolge des aktuellen Integritätsstatus des Installationsbasiselements. Verwenden Sie diesen Wert, um den Integritätsstatus in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.health_status.value Interner Wert des Integritätsstatus des Installationsbasiselements.

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

    Datentyp: Zeichenfolge
    items.household Details zum Haushalt, der dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin „Customer Service Household“ (com.snc.household) installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.household.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 Benutzeroberfläche anzuzeigen.

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

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

    Datentyp: Objekt

    "location": {
  "display_value": "String",
  "sys_id": "String"
}
    items.location.display_value Textname des Speicherorts des Installationsbasiselements. Verwenden Sie diesen Wert, um den Standortnamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.location.sys_id Sys_id des Standortdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    items.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    items.number Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    items.übergeordnet Details zum übergeordneten Datensatz des Installationsbasiselement-Datensatzes.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.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 Benutzeroberflä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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.service_context.sys_id Sys_id des Service-Kontextdatensatzes, 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 „Service Organization“ (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 Benutzeroberflä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 Datensatz des Installationsbasiselements enthält.

    Datentyp: Zeichenfolge
    items.sys_id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der im Parameter sys_class_name angegebenen Tabelle.

    Datentyp: Zeichenfolge
    items.sys_mod_count Anzahl, die angibt, wie oft der zugeordnete Datensatz des Installationsbasiselements geändert wurde.

    Datentyp: Zeichenfolge
    items.status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.state.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    items.status Details zum Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    items.status.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    items.uninstall_date Details zum Datum, an dem das Installationsbasiselement inaktiv wurde.

    Datentyp: Objekt

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    items.uninstall_date.display_value Text-Deinstallationsdatum. Verwenden Sie diesen Wert, um das Deinstallationsdatum in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    items.uninstall_date.value Interner Wert des Deinstallationsdatums.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sysparm_tiefe Anzahl der Ebenen, in denen sich das zurückgegebene untergeordnete Installationsbasiselement in der Hierarchie befindet.

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

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugeordneten 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/installbasetems/{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/installbasetems/{id}/contracts

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/contracts

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    Feld Name-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 eine andere Tabelle in sys_class_nameangeben, geben Sie die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die zurückgegebenen Ergebnisse zu filtern.

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

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer erweiterten Vertragstabelle (nicht „ast_contract“) der Name der abzufragenden erweiterten Tabelle.

    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: 10.000
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie 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
    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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (JSON oder XML)

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

    Datentyp: Array von Objekten

    "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"
  }
]
    contract.active Kennzeichnung, die angibt, ob der Vertrag aktiv ist.
    Mögliche Werte:
    • true: Vertrag ist aktiv.
    • false: Vertrag ist inaktiv.

    Datentyp: Boolesche Zeichenfolge
    contract.approver Details zur Person, die zur Genehmigung des Vertrags berechtigt ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    contract.approver.sys_id Sys_id des Genehmigerdatensatzes, der dem Vertragsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    contract.consumer Details zum Verbraucher, der dem Vertragsdatensatz zugeordnet ist.
    Hinweis:
    Das Verbraucherfeld ist nur verfügbar, wenn das B2B2C-Plugin installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    contract.consumer.sys_id Sys_id des Verbraucherdatensatzes, der dem Vertragsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Verträge.Kosten_Anpassung Typ der auf den Vertrag angewendeten Kostenanpassung.

    Mögliche Werte:

    • Repariert
    • Manuell
    • CPI (Verbraucherpreisindex)

    Datentyp: Zeichenfolge
    Contracts.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
    contract.cost_per_unit Kosten pro Einheit des Produktanbieters.

    Datentyp: Zeichenfolge
    contract.ends Datum, an dem der Vertrag endet.

    Datentyp: Zeichenfolge
    contract.expiration Details zum Ablaufstatus des zugehörigen Vertrags.

    Datentyp: Objekt

    "expiration": {
  "display_value": "String",
  "sys_id": "String"
}
    contract.expiration.display_value Ablaufstatus des zugeordneten Vertrags. Verwenden Sie diesen Wert, um den Ablaufstatus in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    contract.expiration.sys_id Sys_id des Ablaufdatensatzes, der dem Vertragsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    contract.lifetime_cost Kosten über die Lebensdauer des Vertrags.

    Datentyp: Zeichenfolge
    contract.monthly_cost Monatliche Kosten des Vertrags.

    Datentyp: Zeichenfolge
    contract.number Vertragsnummer.

    Datentyp: Zeichenfolge
    contract.payment_amount Geldbetrag, der direkt an die Empfängerpartei dieses Vertrags gezahlt wurde.

    Datentyp: Zeichenfolge
    contract.payment_schedule Details zum Zahlungsplan, der dem Vertrag zugeordnet ist.

    Datentyp: Objekt

    "payment_schedule": {
  "display_value": "String",
  "sys_id": "String"
}
    contract.payment_schedule.display_value Zahlungsplan für den zugehörigen Vertrag. Verwenden Sie diesen Wert, um den Zahlungsplan in der Benutzeroberfläche anzuzeigen.

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

    Datentyp: Zeichenfolge
    contract.ratecard Kennzeichnung, die angibt, ob diesem Vertrag eine Kostenkarte zugeordnet ist. Befindet sich in der Tabelle „Kosten für Pflege“ [fm_contract_rate_card].
    Mögliche Werte:
    • true: Kostenkarte.
    • false: Keine Kostenkarte.

    Datentyp: Boolesche Zeichenfolge
    contract.renewable Kennzeichnung, die angibt, ob der Vertrag verlängerbar ist.
    Mögliche Werte:
    • true: Vertrag ist verlängerbar.
    • false: Vertrag ist nicht verlängerbar.

    Datentyp: Boolesche Zeichenfolge
    contract.sales_tax Kennzeichnung, die angibt, ob für Artikel, auf die sich dieser Vertrag bezieht, Umsatzsteuer berechnet wird.
    Mögliche Werte:
    • true: Umsatzsteuer wird berechnet.
    • false: Es wird keine Umsatzsteuer berechnet.

    Datentyp: Boolesche Zeichenfolge
    contract.short_description Kurze Beschreibung des Vertrags.

    Datentyp: Zeichenfolge
    contract.starts Datum, an dem der Vertrag beginnt.

    Datentyp: Zeichenfolge
    contract.state Details zum aktuellen Status des Vertrags.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    verträge.status.wert Interner Wert oder Status des Vertrags.

    Datentyp: Zeichenfolge
    contract.sub_total_cost Zwischensumme der Vertragskosten.

    Datentyp: Zeichenfolge
    contract.sys_class_name Tabelle mit dem Vertragsdatensatz.

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

    Datentyp: Zeichenfolge

    Standard: „/“ = Globale Domäne
    contract.sys_id Sys_id des zugeordneten Vertragsdatensatzes.

    Datentyp: Zeichenfolge
    contract.tax_cost Gesamtsteuer für den Vertrag.

    Dieses Feld ist nur sichtbar, wenn das Feld für anwendbare Steuern als Umsatzausgewählt ist.

    Datentyp: Zeichenfolge
    contract.tax_exempt Kennzeichnung, die angibt, ob die mit diesem Vertrag verknüpften Artikel steuerfrei sind.
    Mögliche Werte:
    • true: Elemente sind steuerfrei.
    • false: Elemente sind nicht steuerfrei.

    Datentyp: Boolesche Zeichenfolge
    contract.tax_rate Steuersatz, der für steuerpflichtige Elemente berechnet wird, die dem Vertrag zugeordnet sind.

    Datentyp: Zeichenfolge
    contract.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
    contract.yearly_cost Kosten pro Vertragsjahr.

    Datentyp: Zeichenfolge
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze vorhanden sind, die zurückgegeben werden sollen.
    Mögliche Werte:
    • true: Weitere zurückzugebende Datensätze.
    • false: Keine weiteren Datensätze zurückzugeben.

    Datentyp: Boolesche Zeichenfolge
    status Status des Endpunktaufrufs.

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

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugeordneten 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/installbasetems/{id}/entitlements

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

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems/{id}/entitlements

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/entitlements

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 38. Abfrageparameter
    Name Beschreibung
    Feld Name-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 eine andere Tabelle in sys_class_nameangeben, geben Sie die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die zurückgegebenen Ergebnisse zu filtern.

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

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer erweiterten Berechtigungstabelle (nicht service_entitlement) der Name der abzufragenden erweiterten Tabelle.

    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: 10.000
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie 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
    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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (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}
  }
    entitlements.account Details zum Account, der dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Objekt

    "account": {
  "display_value": "String",
  "sys_id": "String"
}
    entitlements.account.display_value Textname des Accounts, der dem Berechtigungsdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Kontonamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    entitlements.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
    entitlements.business_hour Details zu den Geschäftszeiten für den Berechtigungsdatensatz.

    Datentyp: Objekt

    "business_hour": {
  "display_value": "String",
  "sys_id": "String"
}
    entitlements.business_hour.display_value Textname des Geschäftszeiten-Datensatzes, der dem Berechtigungsdatensatz zugeordnet ist. Verwenden Sie diesen Wert, um die Geschäftszeiten in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    entitlements.business_hour.sys_id Sys_id des Geschäftszeiten-Datensatzes, der dem Berechtigungsdatensatz zugeordnet ist.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    entitlements.contract.sys_id Sys_id des Vertragsdatensatzes, der dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    entitlements.end_date Enddatum der Berechtigung.

    Datentyp: Zeichenfolge
    entitlements.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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    entitlements.install_base_item.sys_id Sys_id des Installationsbasiselement-Datensatzes, der dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    entitlements.per_unit Anzahl der Produkte in einer Einheit. Beispiel: Wenn unit der Fallist, wäre dieser Wert 12, wenn pro Fall 12 Elemente vorhanden sind.

    Datentyp: Zeichenfolge
    Berechtigungen.start_date Startdatum der Berechtigung.

    Datentyp: Zeichenfolge
    entitlements.sys_id Sys_id des zugeordneten Berechtigungsdatensatzes.

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

    Datentyp: Zeichenfolge
    entitlements.remaining_units Anzahl der verbleibenden Einheiten.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    entitlements.unit.value Interner Name der Einheit des Elements, das dem Berechtigungsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze vorhanden sind, die zurückgegeben werden sollen.
    Mögliche Werte:
    • true: Weitere zurückzugebende Datensätze.
    • false: Keine weiteren Datensätze zurückzugeben.

    Datentyp: Boolesche Zeichenfolge
    status Status des Endpunktaufrufs.

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

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugeordneten 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 – GET /sn_install_base/integrations/installbasetems/{id}/maintenanceplans

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

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems/{id}/maintenanceplans

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/maintenanceplans

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 44. Abfrageparameter
    Name Beschreibung
    Feld Name-Wert-Paare Feld-Wert-Paare zum Filtern der Wartungsplandatensätze. Standardmäßig verweist dies auf die Felder in der Tabelle „Wartungsplan“ [sm_maint_plan]. Wenn Sie eine andere Tabelle in sys_class_nameangeben, geben Sie die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die zurückgegebenen Ergebnisse zu filtern.

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

    Datentyp: Zeichenfolge

    Standard: Alle Felder
    sys_class_name Bei Verwendung einer erweiterten Wartungsplantabelle (keine Wartungspläne) der Name der abzufragenden erweiterten Tabelle.

    Datentyp: Zeichenfolge

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

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

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

    Datentyp: Zahl

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

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie 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
    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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze vorhanden sind, die zurückgegeben werden sollen.
    Mögliche Werte:
    • true: Weitere zurückzugebende Datensätze.
    • false: Keine weiteren Datensätze zurückzugeben.

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

    Datentyp: Array von Objekten

    "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:
    • true: Wartungsplan ist aktiv.
    • false: Wartungsplan ist inaktiv.

    Datentyp: Zeichenfolge
    Wartungspläne​​apply_to_new 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 dass sie die in der Filterbedingung eingegebenen Bedingungen erfüllen.
    Mögliche Werte:
    • true: Wird auf alle neuen Datensätze angewendet.
    • false: Wird nicht auf alle neuen Datensätze angewendet.

    Datentyp: Zeichenfolge
    Wartungspläne​​allow_zukünftiges_wo Kennzeichnung, die angibt, ob Arbeitsaufträge dem Wartungsplan zugeordnet werden können.
    Mögliche Werte:
    • true: Neue Arbeitsaufträge können zugeordnet werden.
    • false: 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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    wartungspläne.​​maintenance_override_policy.​​value Interner Wert der Überschreibungsrichtlinie.

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

    Datentyp: Zeichenfolge
    Wartungspläne.​​Nummer Nummer des Wartungsplans.

    Datentyp: Zeichenfolge
    Wartungspläne​​propagation_flag Kennzeichnung, die angibt, ob der Wartungsplan weitergegeben werden kann.
    Mögliche Werte:
    • true: Der Wartungsplan kann weitergegeben werden.
    • false: Wartungsplan kann nicht weitergegeben werden.

    Datentyp: Zeichenfolge
    wartungspläne​​sys_class_name Tabelle mit dem Wartungsplandatensatz.

    Datentyp: Zeichenfolge
    wartungspläne.​​sys_id Sys_id des zugeordneten Wartungsplans.

    Datentyp: Zeichenfolge
    Wartungspläne.​​Tabelle Tabelle, die den zugeordneten Zeitdatensatz der Installationsbasis 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 Benutzeroberflä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 in der ursprünglichen Anforderung nicht angegeben ist, wird der Standardwert verwendet.

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugeordneten 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/installbasetems/{id}/relatedparties

    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/installbasetems/{id}/relatedparties

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/relatedparties

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 50. Abfrageparameter
    Name Beschreibung
    Feld Name-Wert-Paare Feld-Wert-Paare, die zum Filtern der Datensätze der zugehörigen Parteien verwendet werden sollen. Standardmäßig verweist dies auf die Felder in der Tabelle „Zugehörige Parteien“ [sn_install_base_related_party]. Wenn Sie eine andere Tabelle in sys_class_nameangeben, geben Sie die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die zurückgegebenen Ergebnisse zu filtern.

    Wenn Sie beispielsweise nach einem bestimmten Account und einer 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 abzufragenden erweiterten Tabelle.

    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: 10.000
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie 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
    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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze vorhanden sind, die zurückgegeben werden sollen.
    Mögliche Werte:
    • true: Weitere zurückzugebende Datensätze.
    • false: Keine weiteren Datensätze zurückzugeben.

    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 Kontonamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    relatedparties.account.sys_id Sys_id des Account-Datensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    relatedparties.consumer 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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    relatedparties.consumer.sys_id Sys_id des Verbraucherdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    relatedparties.contact 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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    relatedparties.contact.sys_id Sys_id des Kontaktdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Kontakttabelle [customer_contact].

    Datentyp: Zeichenfolge
    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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    relatedparties.install_base_item.sys_id Sys_id des Installationsbasiselement-Datensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    relatedparties.responsibility Details zur Zugriffsebene für die Informationen zur Installationsbasis.

    Datentyp: Objekt

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    relatedparties.responsibility.display_value Textanzeigewert für die Zugriffsebene für die Informationen zur Installationsbasis.

    Datentyp: Zeichenfolge
    relatedparties.responsibility.sys_id Sys_id des zugeordneten Zuständigkeitsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Informationen zur Installationsbasis. Befindet sich in der Tabelle „Zuständigkeitsdefinition“ [sn_customerservice_responsibility_def].

    Dieser Parameter ist nur gültig, wenn auch das Feld related_party angegeben ist. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die den Parametern related_party und responsibility entsprechen.

    Weitere Informationen finden Sie unter Configure related parties for items received

    Datentyp: Zeichenfolge
    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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    relatedparties.service_organization.sys_id Sys_id des Serviceorganisationsdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Tabelle „Serviceorganisation“ [sn_customer_service_organization].

    Datentyp: Zeichenfolge
    relatedparties.sys_class_name Tabelle mit dem Datensatz der zugehörigen Parteien.

    Datentyp: Zeichenfolge

    Standard: sn_install_base_related_party
    relatedparties.sys_id Sys_id des zugeordneten Datensatzes der 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 Kontakttyp in der Benutzeroberfläche anzuzeigen. Weitere Informationen finden Sie unter Add related party configurations to cases, sold products, install bases, or service organizations.
    Mögliche Typen:
    • Autorisiertes Konto
    • Autorisierter Verbraucher
    • Autorisierter Kontakt
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Gelistetes Konto
    • Gelisteter Verbraucher
    • Gelisteter Kontakt
    • Aufgeführter Beitragender
    • Aufgeführtes Mitglied
    • Aufgeführte Serviceorganisation

    Datentyp: Zeichenfolge
    relatedparties.type.sys_id Sys_id des Datensatztyps, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    relatedparties.user.sys_id
    Sys_id des Benutzerdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

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

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugeordneten 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/installbasetems/{id}/soldproducts

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

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems/{id}/soldproducts

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/soldproducts

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 56. Abfrageparameter
    Name Beschreibung
    Feld Name-Wert-Paare Feld-Wert-Paare, die zum Filtern der Datensätze der zugehörigen Parteien verwendet werden sollen. Standardmäßig verweist dies auf die Felder in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Wenn Sie eine andere Tabelle in sys_class_nameangeben, geben Sie die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die zurückgegebenen Ergebnisse zu filtern.

    Wenn Sie beispielsweise nach den Produkten filtern möchten, die an einen bestimmten Account verkauft wurden, übergeben Sie einen ähnlichen Wert wie den folgenden, 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 für verkaufte Produkte (nicht sn_install_base_sold_product) der Name der abzufragenden erweiterten Tabelle.

    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: 10.000
    sysparm_offset Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie 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
    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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze vorhanden sind, die zurückgegeben werden sollen.
    Mögliche Werte:
    • true: Weitere zurückzugebende Datensätze.
    • false: Keine weiteren Datensätze zurückzugeben.

    Datentyp: Boolesche Zeichenfolge
    verkaufteProdukte 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 Kontonamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    „soldproducts.account.sys_id“. Sys_id des Account-Datensatzes, der dem Produktdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    „soldproducts.contact“. 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 Benutzeroberflä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
    verkaufteProdukte.Nummer Produktnummer.

    Datentyp: Zeichenfolge
    „soldproducts.sys_class_name“. Tabelle mit dem Produktdatensatz.

    Datentyp: Zeichenfolge
    „soldproducts.sys_id“. Sys_id des zugeordneten Produkts.

    Datentyp: Zeichenfolge
    verkaufteProdukte.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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    „soldproducts.state.value“ Interner Wert für den Status des Produkts.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

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

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugeordneten 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/installbasetems/{id}/workaufträge

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

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems/{id}/workaufträge

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/workaufträge

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 62. Abfrageparameter
    Name Beschreibung
    Feld Name-Wert-Paare Feld-Wert-Paare, die zum Filtern der Datensätze der zugehörigen Parteien verwendet werden sollen. Standardmäßig verweist dies auf die Felder in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Wenn Sie eine andere Tabelle in sys_class_nameangeben, geben Sie die Felder in dieser Tabelle an.

    Sie können ein oder mehrere Feld-Wert-Paare übergeben, um die zurückgegebenen Ergebnisse zu filtern.

    Wenn Sie beispielsweise nach den Produkten filtern möchten, die an einen bestimmten Account verkauft wurden, übergeben Sie etwas Ähnliches wie das Folgende, 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 für verkaufte Produkte (nicht sn_install_base_sold_product) der Name der abzufragenden erweiterten Tabelle.

    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.
    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 im Parameter sysparm_offset.

    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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    has_more Kennzeichnung, die angibt, ob in der Tabelle weitere Datensätze vorhanden sind, die zurückgegeben werden sollen.
    Mögliche Werte:
    • true: Weitere zurückzugebende Datensätze.
    • false: Keine weiteren Datensätze zurückzugeben.

    Datentyp: Boolesche Zeichenfolge
    status Status des Endpunktaufrufs.

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

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugeordneten 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"
  }
]
    workaufträge.aktiv Kennzeichnung, die angibt, ob der Arbeitsauftrag aktiv ist.
    Mögliche Werte:
    • true: Arbeitsauftrag ist aktiv.
    • false: 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"
}
    workaufträge.​approval.display_value Textzeichenfolge des aktuellen Status des Genehmigungsprozesses. Verwenden Sie diesen Wert, um den Genehmigungsstatus in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    workaufträge.​approval.value Interner Wert für den Status des Genehmigungsprozesses.

    Datentyp: Zeichenfolge
    Arbeitsaufträge.​Abrechenbar Kennzeichnung, die angibt, ob der Arbeitsauftrag verrechenbar ist.
    Mögliche Werte:
    • true: Arbeitsauftrag ist verrechenbar.
    • false: Arbeitsauftrag ist nicht abrechenbar

    Datentyp: Boolesche Zeichenfolge
    Arbeitsaufträge.​Eskalation Eskalationsebene des Arbeitsauftrags.

    Datentyp: Zeichenfolge
    workaufträge.​has_appointment Kennzeichnung, die angibt, ob für den Arbeitsauftrag ein Termin geplant ist.
    Mögliche Werte:
    • true: Arbeitsauftrag hat einen Termin.
    • false: Arbeitsauftrag hat keinen Termin.

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

    Datentyp: Objekt

    "install_base_item": {
  "display_value": "String",
  "sys_id": "String"
}
    workaufträ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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    workaufträge.​install_base_item.sys_id Sys_id des Installationsbasiselement-Datensatzes, der dem Arbeitsauftragsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    workaufträge.​is_catalog Kennzeichnung, die angibt, ob Teil eines Katalogs ist.
    Mögliche Werte:
    • true: Arbeitsauftrag ist Teil eines Katalogs.
    • false: Arbeitsauftrag ist nicht Teil eines Katalogs.

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

    Mögliche Werte:

    • true: Knowledge Base-Artikel ist für dieses Problem verfügbar.
    • false: Knowledge Base-Artikel ist für dieses Problem nicht verfügbar.

    Datentyp: Boolesche Zeichenfolge
    workaufträge.location Details zum Speicherort des Elements, an dem gearbeitet werden muss.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    workaufträge.​location.​sys_id Sys_id des Standortdatensatzes, der dem Arbeitsauftragsdatensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    workaufträge.​gefertigt_sla Kennzeichnung, die angibt, ob die dem Arbeitsauftrag zugeordnete Arbeit die zugehörige Servicelevel-Vereinbarung (Service Level Agreement, SLA) erfüllt.
    Mögliche Werte:
    • true: SLA wurde erfüllt.
    • false: SLA wurde nicht erfüllt.

    Datentyp: Boolesche Zeichenfolge
    workaufträge.​needs_attention Kennzeichnung, die angibt, ob dieser Arbeitsauftrag Aufmerksamkeit erfordert.
    Mögliche Werte:
    • true: Arbeitsauftrag mit Handlungsbedarf.
    • false: Arbeitsauftrag erfordert keine Aufmerksamkeit.

    Datentyp: Boolesche Zeichenfolge
    Arbeitsaufträge.​Nummer Eindeutige Nummer zur Identifizierung des Arbeitsauftrags.

    Datentyp: Zeichenfolge
    workaufträge.​opened_at Details darüber, wann der Arbeitsauftrag geöffnet wurde.

    Datentyp: Objekt

    "opened_at": {
  "display_value": "String",
  "value": "String"
}
    workaufträge.​opened_at.​display_value Datum und Uhrzeit, zu der der Arbeitsauftrag geöffnet wurde. Verwenden Sie diesen Wert, um den Wert in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    workaufträge.​opened_at.​value Datum und Uhrzeit, zu der der Arbeitsauftrag geöffnet wurde.

    Datentyp: Zeichenfolge
    workaufträge.​opened_by Details zur Person, die den Arbeitsauftrag geöffnet hat.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    workaufträge.​opened_by.​sys_id Sys_id des Benutzerdatensatzes der Person, die den Arbeitsauftrag geöffnet hat.

    Datentyp: Zeichenfolge
    arbeitsaufträge.opened_for Details zur Person, für die der Arbeitsauftrag geöffnet wurde, falls anders als die Person opened_by.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    workaufträge.​opened_for.​sys_id Sys_id des Benutzerdatensatzes der Person, für die der Arbeitsauftrag geöffnet wurde.

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

    Datentyp: Zeichenfolge
    workaufträge.​reassignment_count Anzahl der Neuzuweisungen des Arbeitsauftrags an eine Person, die für die Verschiebung des Arbeitsauftrags verantwortlich ist.

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

    Datentyp: Boolesche Zeichenfolge
    workaufträge.​short_description Kurzer Text, der die mit dem Arbeitsauftrag verbundene Arbeit beschreibt.

    Datentyp: Zeichenfolge
    workaufträge.​sla_ausgesetzt Kennzeichnung, die angibt, ob die dem Arbeitsauftrag zugeordnete SLA ausgesetzt wurde.
    Gültige Werte:
    • true: SLA wurde ausgesetzt.
    • false: SLA wurde nicht ausgesetzt.

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

    Datentyp: Zeichenfolge
    workaufträge.​sys_class_name Tabelle, die den Arbeitsauftragsdatensatz enthält.

    Datentyp: Zeichenfolge
    workaufträge.​sys_domain_path Domänenpfad

    Datentyp: Zeichenfolge
    workaufträge.sys_id Sys_id des zugeordneten Arbeitsauftragsdatensatzes.

    Datentyp: Zeichenfolge
    workaufträge.​task_created Kennzeichnung, die angibt, ob eine Aufgabe für diesen Arbeitsauftrag erstellt wurde.
    Mögliche Werte:
    • true: Aufgabe wurde für diesen Arbeitsauftrag erstellt.
    • false: Für diesen Arbeitsauftrag wurde keine Aufgabe erstellt.

    Datentyp: Boolesche Zeichenfolge
    workaufträge.​task_effektive_Nummer Eindeutige Nummer zur Identifizierung des Arbeitsauftrags.

    Datentyp: Zeichenfolge
    workaufträge.​template_workflow_invoked Kennzeichnung, die angibt, ob der zugeordnete Workflow für diesen Arbeitsauftrag aufgerufen wurde.
    Mögliche Werte:
    • true: Workflow wurde aufgerufen.
    • false: Workflow wurde nicht aufgerufen.

    Datentyp: Boolesche Zeichenfolge
    workaufträge.​upon_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"
}
    workaufträge.​upon_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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    workaufträge.​upon_approval.​value Aktion, die ausgeführt werden soll, wenn der Arbeitsauftrag genehmigt wird.

    Mögliche Werte:

    • tun_nichts
    • fortfahren

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    workaufträge.​upon_reject.​value 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/installbasetems/{id}

    Aktualisiert einen angegebenen Installationsbasiselement-Datensatz mit angegebenen Feldwerten.

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems/{id}

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    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. Befindet sich in der Tabelle „Account“ [customer_account].

    Hinweis:
    Wenn Sie den Parameter account übergeben, können Sie nicht auch den Parameter consumer übergeben.

    Datentyp: Zeichenfolge
    aktiv Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Gültige Werte:
    • true, „true“ oder „0“: Element ist aktiv.
    • false, „false“ oder „1“: Element ist nicht aktiv.

    Datentyp: Boolesch

    Standardwert: true
    Asset Sys_id des Assets, das dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Asset-Tabelle [alm_asset].

    Datentyp: Zeichenfolge
    child_install_base_items Liste der untergeordneten Installationsbasiselemente, die diesem Installationsbasiselement zugeordnet sind.
    Hinweis:
    Die folgenden Felder des untergeordneten Installationsbasiselements dürfen sich nicht vom übergeordneten Element unterscheiden:
    • Account
    • consumer
    • 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 zugeordneten Datensatzes des untergeordneten Basiselements. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    configuration_item Sys_id des Konfigurationselements, das dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci].

    Datentyp: Zeichenfolge
    consumer Erforderlich beim Erstellen eines Installationsbasiselements für einen Verbraucher.
    Sys_id des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer].
    Hinweis:
    Wenn Sie den Parameter consumer übergeben, können Sie nicht auch den Parameter account übergeben. Darüber hinaus können Sie einen Verbraucher nur dann einem Installationsbasiselement zuordnen, wenn das B2B2C-Plugin in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge
    Consumer_profile Sys_id des Verbraucherprofils, das dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Verbraucherprofil“ [sn_csm_consumer_profile].

    Datentyp: Zeichenfolge
    Kontakt
    Sys_id des Account-Kontaktdatensatzes, der primär für das Installationsbasiselement verantwortlich ist. Befindet sich in der Kontakttabelle [customer_contact].
    Hinweis:
    Kontakte können nur für Account-Installationsbasiselemente angegeben werden.

    Datentyp: Zeichenfolge
    ​Haushalt Sys_id des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Haushalt“ [csm_household].
    Hinweis:
    Dieses Feld ist nur gültig, wenn das Plugin „Customer Service Household“ (com.snc.household) installiert ist.

    Datentyp: Zeichenfolge
    install_date Datum, an dem das Installationsbasiselement aktiv wird.

    Datentyp: Zeichenfolge

    Format: jjjj-MM-tt HH:mm:ss
    location Sys_id des Standorts des zugeordneten Produkts. Befindet sich in der Tabelle „Standort“ [cmn_location].

    Datentyp: Zeichenfolge
    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. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    product_model Sys_id des Produktmodells, das dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model].

    Datentyp: Zeichenfolge
    quantity Anzahl der installierten Elemente.

    Datentyp: Ganzzahl
    service_context Sys_id des Service, der dem zugrunde liegenden CI für die Berechnung des Auswirkungsschweregrads aus Event Management zugeordnet ist. Weitere Informationen finden Sie unter Service health status for install base.
    Hinweis:
    Dieses Feld ist nur gültig, wenn das Plugin „Proactive Customer Service Operations with Event Management“ installiert ist.

    Datentyp: Zeichenfolge
    service_organization Erforderlich beim Erstellen eines Installationsbasiselements für eine Serviceorganisation.

    Sys_id des Serviceorganisationsdatensatzes, der an der Bereitstellung des Service für den Kunden beteiligt ist. Befindet sich in der Tabelle „Serviceorganisation“ [sn_customer_service_organization].

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

    Datentyp: Zeichenfolge
    Status Aktueller Status des Installationsbasiselements.
    Gültige Werte:
    • in_use
    • 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
    uninstall_date 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
    Content-Type 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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    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"
}
    item.account Details zum Kunden-Account, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.account.sys_id Sys_id des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.active Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • true: Installationsbasiselement ist aktiv.
    • false: Installationsbasiselement ist inaktiv.

    Datentyp: Boolesche Zeichenfolge
    item.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.number Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    item.status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.state.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.sys_class_name Details zur Tabelle, die das Installationsbasiselement enthält.

    Datentyp: Objekt

    "sys_class_name": {
  "display_value": "String",
  "value": "String"
}
    item.sys_class_name.display_value Textzeichenfolge des Namens der Tabelle, die das Installationsbasiselement enthält. Verwenden Sie diesen Wert, um den Tabellennamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.sys_class_name.value Interner Wert der Tabelle, die das Installationsbasiselement enthält

    Datentyp: Zeichenfolge
    item.sys_id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der im Parameter sys_class_name angegebenen Tabelle.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie der Name und die aktiven Felder im Datensatz des Installationsbasiselements 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/installbasisms/{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 sie durch die typspezifischen Felder des neuen Typs der zugehörigen Partei ersetzen. Um beispielsweise den Typ „Autorisierter Account“ in „Autorisierter Verbraucher“ zu ändern, übergeben Sie Folgendes:

    • type = „Autorisierter Verbraucher“
    • account = „“
    • consumer = "<sys_id of consumer record> “
    • responsibility = "<sys_id of responsibility of consumer> “

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems/{id}/relatedparties/{related_party_sys_id}

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/relatedparties/{related_party_sys_id}

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    related_party_sys_id Sys_id des Datensatzes der zugehörigen Partei. Standardmäßig befindet sich diese in der Tabelle „Installationsbasis – Zugehörige Partei“ [sn_install_base_related_party].

    Datentyp: Zeichenfolge
    Tabelle : 74. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 75. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Account Erforderlich, wenn der Parameter type einer der folgenden ist:
    • Autorisiertes Konto
    • Autorisierter Kontakt
    • Gelistetes Konto
    • Gelisteter Kontakt

    Sys_id des Accounts, der dem Installationsbasiselement zugeordnet werden soll. Befindet sich in der Tabelle „Account“ [customer_account].

    Hinweis:
    Wenn Sie den Parameter account übergeben, können Sie nicht auch den Parameter consumer übergeben.

    Datentyp: Zeichenfolge
    consumer Erforderlich, wenn der Parameter typeAutorisierter Verbraucher oder Aufgeführter Verbraucherist.
    Sys_id des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer].
    Hinweis:
    Wenn Sie den Parameter consumer übergeben, können Sie nicht auch den Parameter account übergeben. Darüber hinaus können Sie einen Verbraucher nur dann einem Installationsbasiselement zuordnen, wenn das B2B2C-Plugin in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge
    Kontakt Sys_id des Kontaktdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Kontakttabelle [customer_contact].

    Datentyp: Zeichenfolge
    Verantwortlichkeit Sys_id des zugeordneten Zuständigkeitsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Informationen zur Installationsbasis. Befindet sich in der Tabelle „Zuständigkeitsdefinition“ [sn_customerservice_responsibility_def].

    Dieser Parameter ist nur gültig, wenn auch das Feld related_party angegeben ist. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die den Parametern related_party und responsibility entsprechen.

    Weitere Informationen finden Sie unter Configure related parties for items received

    Datentyp: Zeichenfolge
    service_organization Erforderlich, wenn der Parameter type einer der folgenden ist:
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Aufgeführtes Mitglied
    • Aufgeführte Serviceorganisation

    Sys_id des Serviceorganisationsdatensatzes, der an der Bereitstellung des Service für den Kunden beteiligt ist. Befindet sich in der Tabelle „Serviceorganisation“ [sn_customer_service_organization].

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

    Datentyp: Zeichenfolge
    sys_class_name Tabelle mit dem Datensatz der zugehörigen Parteien.

    Datentyp: Zeichenfolge

    Standard: sn_install_base_related_party
    type Erforderlich. Sys_id des Typs der zu erstellenden zugehörigen Partei. Befindet sich in der Tabelle „Konfiguration der zugehörigen Partei“ [sn_customerservice_related_party_configuration].
    Mögliche Typen:
    • Autorisiertes Konto
    • Autorisierter Verbraucher
    • Autorisierter Kontakt
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Gelistetes Konto
    • Gelisteter Verbraucher
    • Gelisteter Kontakt
    • Aufgeführter Beitragender
    • Aufgeführtes Mitglied
    • Aufgeführte Serviceorganisation

    Datentyp: Zeichenfolge
    Anwender Erforderlich, wenn der Parameter type einer der folgenden zugehörigen Parteitypen ist:
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Aufgeführter Beitragender
    • Aufgeführtes Mitglied
    Sys_id des Benutzerdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge

    Für autorisierte Mitglieder und aufgelistete Mitgliedermuss dieser Benutzer dem angegebenen Datensatz service_organization zugeordnet werden.

    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
    Content-Type 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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    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}
}
    item.account Details zum Account, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.account.sys_id Sys_id des Account-Datensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.consumer.sys_id Sys_id des Verbraucherdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.contact.sys_id Sys_id des Kontaktdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Kontakttabelle [customer_contact].

    Datentyp: Zeichenfolge
    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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.install_base_item.sys_id Sys_id des Installationsbasiselement-Datensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    item.responsibility Details zur Zugriffsebene für die Informationen zur Installationsbasis.

    Datentyp: Objekt

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    item.responsibility.display_value Textanzeigewert für die Zugriffsebene für die Informationen zur Installationsbasis.

    Datentyp: Zeichenfolge
    item.verantwortung.sys_id Sys_id des zugeordneten Zuständigkeitsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Informationen zur Installationsbasis. Befindet sich in der Tabelle „Zuständigkeitsdefinition“ [sn_customerservice_responsibility_def].

    Dieser Parameter ist nur gültig, wenn auch das Feld related_party angegeben ist. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die den Parametern related_party und responsibility entsprechen.

    Weitere Informationen finden Sie unter Configure related parties for items received

    Datentyp: Zeichenfolge
    item.sys_class_name Tabelle mit dem Datensatz der zugehörigen Parteien.

    Datentyp: Zeichenfolge

    Standard: sn_install_base_related_party
    item.sys_id Sys_id des zugeordneten Datensatzes der zugehörigen Parteien.

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

    Datentyp: Objekt

    "type": {
  "display_value": "String",
  "sys_id": "String"
}
    item.type.display_value Textname des Kontakttyps, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Kontakttyp in der Benutzeroberfläche anzuzeigen. Weitere Informationen finden Sie unter Add related party configurations to cases, sold products, install bases, or service organizations.
    Mögliche Typen:
    • Autorisiertes Konto
    • Autorisierter Verbraucher
    • Autorisierter Kontakt
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Gelistetes Konto
    • Gelisteter Verbraucher
    • Gelisteter Kontakt
    • Aufgeführter Beitragender
    • Aufgeführtes Mitglied
    • Aufgeführte Serviceorganisation

    Datentyp: Zeichenfolge
    item.type.sys_id Sys_id des Datensatztyps, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

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

    Datentyp: Objekt

    "user": {
  "display_value": "String",
  "sys_id": "String"
}
    item.user.display_value Textname des Benutzers, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Benutzernamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.user.sys_id
    Sys_id des Benutzerdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

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

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

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um den der zugehörigen Partei zugeordneten Kontaktdatensatz zu aktualisieren.

    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/installbasetems/{id}/uninstall

    Deinstalliert das angegebene Installationsbasiselement.

    Eine Deinstallation besteht aus dem Festlegen des Felds active auf „ falsch “ und dem Festlegen des Felds unistall_date auf ein bestimmtes Datum. Leer, wenn kein Datumswert angegeben ist.

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems/{id}/uninstall

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/uninstall

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 80. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 81. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    uninstall_date 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
    Content-Type 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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    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"
}
    item.account Details zum Kunden-Account, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.account.sys_id Sys_id des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.active Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • true: Installationsbasiselement ist aktiv.
    • false: Installationsbasiselement ist inaktiv.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.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 vom übergeordneten Element unterscheiden:
    • Account
    • consumer
    • 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 zugeordneten Datensatzes des untergeordneten Basiselements. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    item.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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.configuration_sys_id Sys_id des Konfigurationselement-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.consumer Details zum Verbraucher, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Verbraucherfeld ist nur verfügbar, wenn das B2B2C-Plugin installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.consumer.sys_id Sys_id des Verbraucherdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.consumer_profile Details zum Verbraucherprofil, das dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld „Verbraucherprofil“ ist nur verfügbar, wenn das B2B2C-Plugin installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.consumer_profile.sys_id Sys_id des Verbraucherprofil-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.contact Details zum Account-Kontakt, der für den Datensatz des Installationsbasiselements verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Textname des Account-Kontakts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Account-Kontaktnamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.contact.sys_id Sys_id des Account-Kontaktdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.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"
}
    item.health_status.display_value Textzeichenfolge des aktuellen Integritätsstatus des Installationsbasiselements. Verwenden Sie diesen Wert, um den Integritätsstatus in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.health_status.value Interner Wert des Integritätsstatus des Installationsbasiselements.

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

    Datentyp: Zeichenfolge
    item.household Details zum Haushalt, der dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin „Customer Service Household“ (com.snc.household) installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.household.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 Benutzeroberflä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"
}
    item.location.display_value Textname des Speicherorts des Installationsbasiselements. Verwenden Sie diesen Wert, um den Standortnamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.location.sys_id Sys_id des Standortdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.number Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    item.parent Details zum übergeordneten Datensatz des Installationsbasiselement-Datensatzes.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.übergeordnet.sys_id Sys_id des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Artikel.Produkt 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 Benutzeroberflä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 Service-Kontextdatensatzes, 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 „Service Organization“ (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 Benutzeroberfläche anzuzeigen.

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

    Datentyp: Zeichenfolge
    item.sys_class_name Tabelle, die den Datensatz des Installationsbasiselements enthält.

    Datentyp: Zeichenfolge
    item.sys_id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der im Parameter sys_class_name angegebenen Tabelle.

    Datentyp: Zeichenfolge
    item.status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.state.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.status Details zum Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.status.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.uninstall_date Details zum Datum, an dem das Installationsbasiselement inaktiv wurde.

    Datentyp: Objekt

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    item.uninstall_date.display_value Text-Deinstallationsdatum. Verwenden Sie diesen Wert, um das Deinstallationsdatum in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.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/installbasetems

    Erstellt einen oder mehrere Installationsbasiselement-Datensätze in der Standardtabelle „Installationsbasiselement“ oder in der erweiterten Tabelle, falls angegeben, und füllt sie mit den angegebenen Feldwerten.

    Beim Erstellen eines einzelnen Installationsbasiselement-Datensatzes übergeben Sie ein Objekt im Anforderungstext, der alle Felder enthält, die in den Anforderungstext aufgenommen werden sollen. Wenn Sie mehrere Installationsbasiselement-Datensätze in einem einzigen Aufruf erstellen, übergeben Sie im Anforderungstext ein Array von Objekten, das alle zu erstellenden Datensätze enthält. Der Endpunkt verarbeitet und meldet jedes der Datensatzerstellungsobjekte einzeln. Wenn einer oder mehrere Datensätze nicht erstellt werden können, hat dies keine Auswirkungen auf die Erstellung anderer Datensätze.

    URL-Format

    Versionierte URL: /api/sn_install_base/{api_version}/integrations/installbasetems

    Standard-URL: /api/sn_install_base/integrations/installbasetems

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    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. Befindet sich in der Tabelle „Account“ [customer_account].

    Hinweis:
    Wenn Sie den Parameter account übergeben, können Sie nicht auch den Parameter consumer übergeben.

    Datentyp: Zeichenfolge
    aktiv Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Gültige Werte:
    • true, „true“ oder „0“: Element ist aktiv.
    • false, „false“ oder „1“: Element ist nicht aktiv.

    Datentyp: Boolesch

    Standardwert: true
    Asset Sys_id des Assets, das dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Asset-Tabelle [alm_asset].

    Datentyp: Zeichenfolge
    child_install_base_items Liste der untergeordneten Installationsbasiselemente, die diesem Installationsbasiselement zugeordnet sind.
    Hinweis:
    Die folgenden Felder des untergeordneten Installationsbasiselements dürfen sich nicht vom übergeordneten Element unterscheiden:
    • Account
    • consumer
    • 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 zugeordneten Datensatzes des untergeordneten Basiselements. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    configuration_item Sys_id des Konfigurationselements, das dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Konfigurationselement“ [cmdb_ci].

    Datentyp: Zeichenfolge
    consumer Erforderlich beim Erstellen eines Installationsbasiselements für einen Verbraucher.
    Sys_id des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer].
    Hinweis:
    Wenn Sie den Parameter consumer übergeben, können Sie nicht auch den Parameter account übergeben. Darüber hinaus können Sie einen Verbraucher nur dann einem Installationsbasiselement zuordnen, wenn das B2B2C-Plugin in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge
    Consumer_profile Sys_id des Verbraucherprofils, das dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Verbraucherprofil“ [sn_csm_consumer_profile].

    Datentyp: Zeichenfolge
    Kontakt
    Sys_id des Account-Kontaktdatensatzes, der primär für das Installationsbasiselement verantwortlich ist. Befindet sich in der Kontakttabelle [customer_contact].
    Hinweis:
    Kontakte können nur für Account-Installationsbasiselemente angegeben werden.

    Datentyp: Zeichenfolge
    ​Haushalt Sys_id des Haushalts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Haushalt“ [csm_household].
    Hinweis:
    Dieses Feld ist nur gültig, wenn das Plugin „Customer Service Household“ (com.snc.household) installiert ist.

    Datentyp: Zeichenfolge
    install_date Datum, an dem das Installationsbasiselement aktiv wird.

    Datentyp: Zeichenfolge

    Format: jjjj-MM-tt HH:mm:ss
    location Sys_id des Standorts des zugeordneten Produkts. Befindet sich in der Tabelle „Standort“ [cmn_location].

    Datentyp: Zeichenfolge
    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. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    product_model Sys_id des Produktmodells, das dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model].

    Datentyp: Zeichenfolge
    quantity Anzahl der installierten Elemente.

    Datentyp: Ganzzahl
    service_context Sys_id des Service, der dem zugrunde liegenden CI für die Berechnung des Auswirkungsschweregrads aus Event Management zugeordnet ist. Weitere Informationen finden Sie unter Service health status for install base.
    Hinweis:
    Dieses Feld ist nur gültig, wenn das Plugin „Proactive Customer Service Operations with Event Management“ installiert ist.

    Datentyp: Zeichenfolge
    service_organization Erforderlich beim Erstellen eines Installationsbasiselements für eine Serviceorganisation.

    Sys_id des Serviceorganisationsdatensatzes, der an der Bereitstellung des Service für den Kunden beteiligt ist. Befindet sich in der Tabelle „Serviceorganisation“ [sn_customer_service_organization].

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

    Datentyp: Zeichenfolge
    Status Aktueller Status des Installationsbasiselements.
    Gültige Werte:
    • in_use
    • 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 erstellt werden soll.

    Datentyp: Zeichenfolge

    Standard: Tabelle „Installationsbasiselement“ [sn_install_base_item].
    uninstall_date 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
    Content-Type 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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    Datentyp: Zeichenfolge
    Element Installationsbasiselement, das den angegebenen Filterergebnissen entspricht. Es werden nur nicht leere Felder 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"
}
    item.account Details zum Kunden-Account, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.account.sys_id Sys_id des Kunden-Account-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.active Kennzeichnung, die angibt, ob das Installationsbasiselement aktiv ist.
    Mögliche Werte:
    • true: Installationsbasiselement ist aktiv.
    • false: Installationsbasiselement ist inaktiv.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.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 vom übergeordneten Element unterscheiden:
    • Account
    • consumer
    • 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 zugeordneten Datensatzes des untergeordneten Basiselements. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    item.configuration_item Details zum Konfigurationselement, das dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.configuration_item.sys_id Sys_id des Konfigurationselement-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.consumer Details zum Verbraucher, der dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Verbraucherfeld ist nur verfügbar, wenn das B2B2C-Plugin installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.consumer.sys_id Sys_id des Verbraucherdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.consumer_profile Details zum Verbraucherprofil, das dem Installationsbasiselement-Datensatz zugeordnet ist.
    Hinweis:
    Das Feld „Verbraucherprofil“ ist nur verfügbar, wenn das B2B2C-Plugin installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.consumer_profile.sys_id Sys_id des Verbraucherprofil-Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.contact Details zum Account-Kontakt, der für den Datensatz des Installationsbasiselements verantwortlich ist.

    Datentyp: Objekt

    "contact": {
  "display_value": "String",
  "sys_id": "String"
}
    item.contact.display_value Textname des Account-Kontakts, der dem Installationsbasiselement-Datensatz zugeordnet ist. Verwenden Sie diesen Wert, um den Account-Kontaktnamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.contact.sys_id Sys_id des Account-Kontaktdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.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"
}
    item.health_status.display_value Textzeichenfolge des aktuellen Integritätsstatus des Installationsbasiselements. Verwenden Sie diesen Wert, um den Integritätsstatus in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.health_status.value Interner Wert des Integritätsstatus des Installationsbasiselements.

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

    Datentyp: Zeichenfolge
    item.household Details zum Haushalt, der dem Installationsbasiselement-Datensatz zugeordnet ist. Wird nur zurückgegeben, wenn das Plugin „Customer Service Household“ (com.snc.household) installiert ist.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.household.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 Benutzeroberflä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"
}
    item.location.display_value Textname des Speicherorts des Installationsbasiselements. Verwenden Sie diesen Wert, um den Standortnamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.location.sys_id Sys_id des Standortdatensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    item.name Name des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.number Eindeutige ID für das Installationsbasiselement.

    Datentyp: Zeichenfolge
    item.parent Details zum übergeordneten Datensatz des Installationsbasiselement-Datensatzes.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.übergeordnet.sys_id Sys_id des übergeordneten Datensatzes, der dem Installationsbasiselement-Datensatz zugeordnet ist.

    Datentyp: Zeichenfolge
    Artikel.Produkt 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 Benutzeroberflä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 Service-Kontextdatensatzes, 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 „Service Organization“ (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 Benutzeroberfläche anzuzeigen.

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

    Datentyp: Zeichenfolge
    item.sys_class_name Tabelle, die den Datensatz des Installationsbasiselements enthält.

    Datentyp: Zeichenfolge
    item.sys_id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der im Parameter sys_class_name angegebenen Tabelle.

    Datentyp: Zeichenfolge
    item.status Details zum aktuellen Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.state.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.status Details zum Status des Installationsbasiselements.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    item.status.value Interner Wert für den Status des Installationsbasiselements.

    Datentyp: Zeichenfolge
    item.uninstall_date Details zum Datum, an dem das Installationsbasiselement inaktiv wurde.

    Datentyp: Objekt

    "uninstall_date": {
  "display_value": "String",
  "value": "String"
}
    item.uninstall_date.display_value Text-Deinstallationsdatum. Verwenden Sie diesen Wert, um das Deinstallationsdatum in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    item.uninstall_date.value Interner Wert des Deinstallationsdatums.

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie ein einzelner Installationsbasiselement-Datensatz erstellt wird.

    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: Es werden nur nicht leere Felder 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 Installationsbasiselement-Datensätze 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: Es werden nur nicht leere Felder 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/installbasisms/{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/installbasetems/{id}/relatedparties

    Standard-URL: /api/sn_install_base/integrations/installbasetems/{id}/relatedparties

    Unterstützte Anforderungsparameter

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

    Datentyp: Zeichenfolge
    id Sys_id des Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item].

    Datentyp: Zeichenfolge
    Tabelle : 92. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 93. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Account Erforderlich, wenn der Parameter type einer der folgenden ist:
    • Autorisiertes Konto
    • Autorisierter Kontakt
    • Gelistetes Konto
    • Gelisteter Kontakt

    Sys_id des Accounts, der dem Installationsbasiselement zugeordnet werden soll. Befindet sich in der Tabelle „Account“ [customer_account].

    Hinweis:
    Wenn Sie den Parameter account übergeben, können Sie nicht auch den Parameter consumer übergeben.

    Datentyp: Zeichenfolge
    consumer Erforderlich, wenn der Parameter typeAutorisierter Verbraucher oder Aufgeführter Verbraucherist.
    Sys_id des Verbrauchers, der dem Installationsbasiselement-Datensatz zugeordnet ist. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer].
    Hinweis:
    Wenn Sie den Parameter consumer übergeben, können Sie nicht auch den Parameter account übergeben. Darüber hinaus können Sie einen Verbraucher nur dann einem Installationsbasiselement zuordnen, wenn das B2B2C-Plugin in Ihrer Instanz installiert ist.

    Datentyp: Zeichenfolge
    Kontakt Sys_id des Kontaktdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Kontakttabelle [customer_contact].

    Datentyp: Zeichenfolge
    install_base_item Sys_id des Installationsbasiselement-Datensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    Verantwortlichkeit Sys_id des zugeordneten Zuständigkeitsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Informationen zur Installationsbasis. Befindet sich in der Tabelle „Zuständigkeitsdefinition“ [sn_customerservice_responsibility_def].

    Dieser Parameter ist nur gültig, wenn auch das Feld related_party angegeben ist. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die den Parametern related_party und responsibility entsprechen.

    Weitere Informationen finden Sie unter Configure related parties for items received

    Datentyp: Zeichenfolge
    service_organization Erforderlich, wenn der Parameter type einer der folgenden ist:
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Aufgeführtes Mitglied
    • Aufgeführte Serviceorganisation

    Sys_id des Serviceorganisationsdatensatzes, der an der Bereitstellung des Service für den Kunden beteiligt ist. Befindet sich in der Tabelle „Serviceorganisation“ [sn_customer_service_organization].

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

    Datentyp: Zeichenfolge
    sys_class_name Tabelle mit dem Datensatz der zugehörigen Parteien.

    Datentyp: Zeichenfolge

    Standard: sn_install_base_related_party
    type Erforderlich. Sys_id des Typs der zu erstellenden zugehörigen Partei. Befindet sich in der Tabelle „Konfiguration der zugehörigen Partei“ [sn_customerservice_related_party_configuration].
    Mögliche Typen:
    • Autorisiertes Konto
    • Autorisierter Verbraucher
    • Autorisierter Kontakt
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Gelistetes Konto
    • Gelisteter Verbraucher
    • Gelisteter Kontakt
    • Aufgeführter Beitragender
    • Aufgeführtes Mitglied
    • Aufgeführte Serviceorganisation

    Datentyp: Zeichenfolge
    Anwender Erforderlich, wenn der Parameter type einer der folgenden zugehörigen Parteitypen ist:
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Aufgeführter Beitragender
    • Aufgeführtes Mitglied

    Für autorisierte Mitglieder und aufgelistete Mitgliedermuss dieser Benutzer dem angegebenen Datensatz service_organization zugeordnet werden.

    Sys_id des Benutzerdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge

    Header

    Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter Unterstützte REST-API-Header.

    Tabelle : 94. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    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 HTTP-Antwortcodesder REST-API.

    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 Benutzer 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.

    Antworttextparameter (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 Kontonamen in der Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    account.sys_id Sys_id des Account-Datensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    verbraucher.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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    contact.sys_id Sys_id des Kontaktdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Kontakttabelle [customer_contact].

    Datentyp: Zeichenfolge
    Fehler Details zum Fehler, der beim Versuch, die Anforderung zu verarbeiten, aufgetreten ist.

    Datentyp: Objekt

    "error": {
  "detail": "String",
  "message": "String"
}
    Fehler.Detail Zusätzliche Details zum zugeordneten Fehler.

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

    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 Benutzeroberfläche anzuzeigen.

    Datentyp: Zeichenfolge
    install_base_item.sys_id Sys_id des Installationsbasiselement-Datensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

    Datentyp: Zeichenfolge
    Verantwortlichkeit Details zur Zugriffsebene für die Informationen zur Installationsbasis.

    Datentyp: Objekt

    "responsibility": {
  "display_value": "String",
  "sys_id": "String"
}
    Responsibility.display_value Textanzeigewert für die Zugriffsebene für die Informationen zur Installationsbasis.

    Datentyp: Zeichenfolge
    Verantwortung.sys_id Sys_id des zugeordneten Zuständigkeitsdatensatzes. Dieser Datensatz definiert die Zugriffsebene für die Informationen zur Installationsbasis. Befindet sich in der Tabelle „Zuständigkeitsdefinition“ [sn_customerservice_responsibility_def].

    Dieser Parameter ist nur gültig, wenn auch das Feld related_party angegeben ist. Wenn angegeben, werden nur die Installationsbasiselemente zurückgegeben, die den Parametern related_party und responsibility entsprechen.

    Weitere Informationen finden Sie unter Configure related parties for items received

    Datentyp: Zeichenfolge
    status Status des Endpunktaufrufs.

    Datentyp: Zeichenfolge
    sys_class_name Tabelle mit dem Datensatz der zugehörigen Parteien.

    Datentyp: Zeichenfolge

    Standard: sn_install_base_related_party
    sys_id Sys_id des zugeordneten Datensatzes der zugehörigen Parteien.

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

    Datentyp: Zahl
    sysparm_offset Offset (Ausgangspunkt) in der zugeordneten 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"
}
    type.display_value Textname des Kontakttyps, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Verwenden Sie diesen Wert, um den Kontakttyp in der Benutzeroberfläche anzuzeigen. Weitere Informationen finden Sie unter Add related party configurations to cases, sold products, install bases, or service organizations.
    Mögliche Typen:
    • Autorisiertes Konto
    • Autorisierter Verbraucher
    • Autorisierter Kontakt
    • Autorisierter Beitragender
    • Autorisiertes Mitglied
    • Autorisierte Serviceorganisation
    • Gelistetes Konto
    • Gelisteter Verbraucher
    • Gelisteter Kontakt
    • Aufgeführter Beitragender
    • Aufgeführtes Mitglied
    • Aufgeführte Serviceorganisation

    Datentyp: Zeichenfolge
    type.sys_id Sys_id des Datensatztyps, der dem Datensatz der zugehörigen Parteien zugeordnet ist.

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

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    user.sys_id
    Sys_id des Benutzerdatensatzes, der dem Datensatz der zugehörigen Parteien zugeordnet ist. Befindet sich in der Benutzertabelle [sys_user].

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird, um einen zugehörigen Datensatz für ein autorisiertes Konto zu erstellen und 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",
  }
}