---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Produktinstanz: Bereichsbezogen, global

# Produktinstanz: Bereichsbezogen, global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

Die Produktinstanz Die API bietet Methoden zum Generieren eines Produktinstanzbezeichners (PID), zum Abrufen von PID-Konfigurationsdaten und zum Bestimmen, ob eine Modellkategorie eine Produktinstanz ist.

Diese API wird in ausgeführt `sn_cmdb `Namespace und erfordert die Rolle „category_Manager" oder „snc_internal". Zugriff wird auch Anwendern mit Zugriffssteuerungslisten (ACLs) für die Tabelle „Modellkategorie" \[cmdb_model_category\] gewährt. Sie können die ACLs in der Tabelle \[sys_DB_object\] anzeigen.

Eine PID ist ein eindeutiger Bezeichner für eine Produktinstanz und verknüpft Asset, Konfigurationselement (CI) und Installationsbasiselement (IBI), um Aktualisierungen zwischen allgemeinen Produktdarstellungen zu synchronisieren. Eine Produktinstanz ist Assets einer bestimmten Modellkategorie zugeordnet.

Der Zugriff auf Installationsbasiselemente erfordert das Plugin „Kundenservice-Installationsbasisverwaltung" (com.snc.install_base).  
Siehe auch:

* [Model categories](https://www.servicenow.com/docs/access?context=c_ModelCategories&version=yokohama&pubname=yokohama-it-asset-management&ft:locale=en-US)
* [Product Instance feature in Hardware Asset Management](https://www.servicenow.com/docs/access?context=product-instance-for-assets&version=yokohama&pubname=yokohama-it-asset-management&ft:locale=en-US)
* [Create an install base item](https://www.servicenow.com/docs/access?context=create-install-base-item&version=yokohama&pubname=yokohama-customer-service-management&ft:locale=en-US)
{#ProductInstanceBothAPI__ul_d14_5x4_zzb}

## Produktinstanz -- generatePID (Zeichenfolge className, Zeichenfolge modCategorySysId, Objekt jsonKeyValues) {#ariaid-title2}

Generiert den Hash-Wert der Produktinstanz und gibt ihn zurück.
Diese Methode kann mehrmals aufgerufen werden, ohne die Leistung der aufrufenden Anwendung zu beeinträchtigen. Diese Methode ändert keine Daten in der Datenbank und speichert die Daten, die zum Berechnen der PID erforderlich sind.

Ein Produktinstanzbezeichner (PID) ist ein eindeutiger Bezeichner für eine Produktinstanz und verknüpft Assets, CIs und Installationsbasiselemente (IBI).  
Eine PID wird basierend auf den folgenden Elementen generiert, die in der Tabelle „Produktinstanzbezeichnerkonfigurationen" \[product_instance_identifier_configuration\] definiert sind:

* PID-Konfigurationen (schreibgeschützt)
* Auftrag, der jeder Konfiguration zugewiesen ist

{#ProductInstance-generatePID_S_S_O__ul_dll_42w_21c}Siehe auch [Product Instance feature in Hardware Asset Management](https://www.servicenow.com/docs/access?context=product-instance-for-assets&version=yokohama&pubname=yokohama-it-asset-management&ft:locale=en-US).
{#ProductInstance-generatePID_S_S_O__table_mxt_n4d_tzb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| className | Zeichenfolge | Tabellenname für die zu generierende PID. |
| ModelCategorySysId | Zeichenfolge | Die sys_ID der Modellkategorie in der Tabelle „Modellkategorien" \[cmdb_model_category\]. Informationen hierzu finden Sie unter [Model categories](https://www.servicenow.com/docs/access?context=c_ModelCategories&version=yokohama&pubname=yokohama-it-asset-management&ft:locale=en-US). |
| JsonKeyValues | Objekt | JSON-Schlüssel-Wert-Paar von PID-Parametern, die in der Tabelle „Produktinstanzbezeichnerkonfigurationen" \[product_instance_identifier_configuration\] konfiguriert sind. Die Schlüssel-Wert-Paare enthalten Attributnamen mit den entsprechenden Werten. Diese Werte variieren je nach den für die PID definierten Konfigurationseigenschaften. |
[Tabelle : 1. Parameter]

{#ProductInstance-generatePID_S_S_O__table_mxt_n4d_tzb} {#ProductInstance-generatePID_S_S_O__table_nxt_n4d_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | Informationen, die zum Generieren der PID verwendet werden. Das Objekt gibt mit einem leeren Eigenschaftswert „Product_instance_ID" unter den folgenden Bedingungen zurück: * Für die PID fehlen die erforderlichen PID-Konfigurationsattribute. Die PID-Konfiguration befindet sich in der Tabelle „Produktinstanzbezeichnerkonfigurationen" \[product_instance_identifier_configuration\]. * Der angegebenen Klasse ist keine Produktinstanz zugeordnet. {#ProductInstance-generatePID_S_S_O__ul_u4s_5fx_21c} { "model_category_sysId": "String", "parameters": [Array], "product_instance_id": "String" } |
| \<Object\>.Model_category_sysId | Die sys_ID der Produktkategorie in der Tabelle „Modellkategorien" \[cmdb_model_category\]. Dieser Wert kann sich vom Eingabewert unterscheiden, wenn die Modellkategoriehierarchie zum Generieren der PID verwendet wurde. Datentyp: Zeichenfolge |
| \<Object\>.Parameter | Liste der Parameter, die zum Generieren der PID verwendet und in der Tabelle „Produktinstanzbezeichnerkonfigurationen" \[product_instance_identifier_configuration\] definiert wurden. Datentyp: Array von Zeichenfolgen |
| \<Object\>.Product_instance_ID | PID im Feld „Product_instance_ID" eines Assets, CI oder Installationsbasiselements. Der Hash-Wert der PID kann für diese Eigenschaft festgelegt werden, um allgemeine Werte in Objekten einer der folgenden Tabellen zu synchronisieren: * Assets \[alm_Asset\] * Configuration Items \[cmdb_ci\] * Installationsbasiselemente \[sn_install_base_item\] {#ProductInstance-generatePID_S_S_O__ul_j4s_5cx_21c}Installationsbasiselemente erfordern das Plugin „Kundenservice-Installationsbasisverwaltung" (com.snc.install_base). Datentyp: Zeichenfolge |
[Tabelle : 2. Rückgaben]

{#ProductInstance-generatePID_S_S_O__table_nxt_n4d_tzb}  
Das folgende Beispiel zeigt, wie eine PID für ein Asset in der Tabelle „medizinische Assets" \[sn_ent_medical_asset\] erstellt wird. Diese Tabelle ist im Plugin „Kundenservice-Installationsbasisverwaltung" (com.snc.install_base) enthalten.

    var output = sn_cmdb.ProductInstance.generatePID('sn_ent_medical_asset', '4b8aa89a77710110dd5fca22fe5a9984', { "serial_number" : "SN1001"});
    gs.info(JSON.stringify(output,null,'\t'));

Ausgabe:

    {
      "model_category_sysId": "4b8aa89a77710110dd5fca22fe5a9984",
      "product_instance_id": "tw8QgznsS4cP3b4U0+rSbnbIWxirYpeVSquk3g81K/8=",
      "parameters": [
        "serial_number"
      ]
    }

## Produktinstanz -- getPIDConfig (Zeichenfolge className, Zeichenfolge modelCategorySysId) {#ariaid-title3}

Ruft die der Modellkategorie zugeordnete PID-Konfiguration basierend auf der Hierarchie und dem Klassennamen ab.
Diese Methode scannt alle Hierarchien für die Modellkategorie und gibt die PID-Konfiguration(en) für die erste gefundene Modellkategorie zurück.
{#ProductInstance-getPIDConfig_S_S__table_mxt_n4d_tzb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| className | Zeichenfolge | Tabellenname für die zu generierende PID. |
| ModelCategorySysId | Zeichenfolge | Die sys_ID der Modellkategorie in der Tabelle „Modellkategorien" \[cmdb_model_category\]. Informationen hierzu finden Sie unter [Model categories](https://www.servicenow.com/docs/access?context=c_ModelCategories&version=yokohama&pubname=yokohama-it-asset-management&ft:locale=en-US). |
[Tabelle : 3. Parameter]

{#ProductInstance-getPIDConfig_S_S__table_mxt_n4d_tzb} {#ProductInstance-getPIDConfig_S_S__table_nxt_n4d_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Objekt | JSON-Objekt, das die PID-Konfigurationen enthält, die dem angegebenen Klassennamen und der angegebenen Modellkategorie zugeordnet sind. { "model_category_sysId": "String", "configs": [Array] } |
| \<Object\>.Model_category_sysId | Die sys_ID der Produktkategorie in der Tabelle „Modellkategorien" \[cmdb_model_category\]. Dieser Wert kann sich vom Eingabewert unterscheiden, wenn die Modellkategoriehierarchie zum Generieren der PID verwendet wurde. Datentyp: Zeichenfolge |
| \<Object\>.Konfigurationen | Liste der einzelnen Konfigurationen, die der angegebenen Modellkategorie zugeordnet sind. "configs": [ { "configuration_order": Number, "parameters": [Array] } ] Datentyp: Array |
| \<Object\>.Configs.Configuration_order | Gibt die Reihenfolge der Konfiguration zurück, die in der Tabelle „Produktinstanzbezeichnerparameter" \[product_instance_identifier_parameters\] definiert ist. Datentyp: Zahl |
| \<Object\>.Configs.Parameters | Liste aller Parameter, die der Konfiguration und ihrer Reihenfolge zugeordnet sind. "parameters": [ { "parameter_class_attribute_name": "String", "parameter_class_name": "String", "parameter_name": "String", "parameter_order": Number } ] Datentyp: Array von Objekten |
| \<Object\>.configs.parameters.parameter_class_attribute_name | Parametername, der der Eigenschaft „Parameter_class_Name" zugeordnet ist. Diese Zeichenfolge stellt den Namen der Spalte dar, die dieser Klasse entspricht. Datentyp: Zeichenfolge |
| \<Object\>.Congs.Parameters.Parameter_class_Name | Klassenname, der dem in der Tabelle „Produktinstanzbezeichnerparameter" \[product_instance_identifier_parameters\] definierten Parameter zugeordnet ist. Datentyp: Zeichenfolge |
| \<Object\>.Congs.Parameters.Parameter_Name | Parametername, der in der Tabelle „Produktinstanzbezeichnerparameter" \[product_instance_identifier_parameters\] definiert ist. Datentyp: Zeichenfolge |
| \<Object\>.Congs.Parameters.Parameter_order | Reihenfolge des Parameters, der in der Tabelle „Produktinstanzbezeichner-Parameter" \[product_instance_identifier_parameters\] definiert ist. Datentyp: Zahl |
[Tabelle : 4. Rückgaben]

{#ProductInstance-getPIDConfig_S_S__table_nxt_n4d_tzb}  
Das folgende Beispiel zeigt, wie Konfigurationsdetails für eine Modellkategorie abgerufen werden, die in der Tabelle „medizinische Assets" \[sn_ent_medical_asset\] genannt wird. Diese Tabelle ist im Plugin „Kundenservice-Installationsbasisverwaltung" (com.snc.install_base) enthalten.

    var config = sn_cmdb.ProductInstance.getPIDConfig('sn_ent_medical_asset', '4b8aa89a77710110dd5fca22fe5a9984');
    gs.info(JSON.stringify(config,null,'\t'));

Ausgabe:

    {
      "model_category_sysId": "4b8aa89a77710110dd5fca22fe5a9984",
      "configs": [
        {
          "parameters": [
            {
              "parameter_class_attribute_name": "serial_number",
              "parameter_class_name": "sn_ent_medical_asset",
              "parameter_name": "serial_number",
              "parameter_order": 1
            }
          ],
          "configuration_order": 100
        },
        {
          "parameters": [
            {
              "parameter_class_attribute_name": "parent",
              "parameter_class_name": "sn_ent_medical_asset",
              "parameter_name": "parent_asset",
              "parameter_order": 1
            },
            {
              "parameter_class_attribute_name": "model_component_id",
              "parameter_class_name": "sn_ent_medical_asset",
              "parameter_name": "model_component_id",
              "parameter_order": 2
            }
          ],
          "configuration_order": 200
        }
      ]
    }

## Produktinstanz -- isProductInstance(Zeichenfolge modelCategorySysId) {#ariaid-title4}

Überprüft, ob eine bestimmte Modellkategorie eine Produktinstanz ist.
Wenn beide der folgenden Bedingungen erfüllt sind, qualifiziert sich die Modellkategorie als Produktinstanz:

* Der Wert der Kennzeichnung „is_model_category" der Modellkategorie ist „wahr".
* Für die Modellkategorie ist eine gültige Konfiguration in der Tabelle „Produktinstanzbezeichner-Konfigurationen" \[product_instance_identifier_configuration\] definiert.
{#ProductInstance-isProductInstance_S__ul_wpz_wtc_f1c}

Diese Methode kann in Business-Regeln verwendet werden, bevor aufgerufen wird GeneratePID() Methode.
{#ProductInstance-isProductInstance_S__table_mxt_n4d_tzb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ModelCategorySysId | Zeichenfolge | Die sys_ID der Modellkategorie in der Tabelle „Modellkategorien" \[cmdb_model_category\]. Informationen hierzu finden Sie unter [Model categories](https://www.servicenow.com/docs/access?context=c_ModelCategories&version=yokohama&pubname=yokohama-it-asset-management&ft:locale=en-US). |
[Tabelle : 5. Parameter]

{#ProductInstance-isProductInstance_S__table_mxt_n4d_tzb} {#ProductInstance-isProductInstance_S__table_nxt_n4d_tzb__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob die angegebene Modellkategorie eine Produktinstanz ist. Gültige Werte: * Wahr: Die angegebene Modellkategorie ist eine Produktinstanz. * Falsch: Die angegebene Modellkategorie ist keine Produktinstanz. {#ProductInstance-isProductInstance_S__ul_ybz_qvw_tzb} |
[Tabelle : 6. Rückgaben]

{#ProductInstance-isProductInstance_S__table_nxt_n4d_tzb}  
Das folgende Beispiel zeigt, wie bestimmt wird, ob die angegebene Modellkategorie eine Produktinstanz ist.

    var isProductInstance =  sn_cmdb.ProductInstance.isProductInstance('4b8aa89a77710110dd5fca22fe5a9984');
    gs.info(isProductInstance);

Ausgabe:

    true


