Product Inventory Open API

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

    • Die Product Inventory Open API bietet Endpunkte zum Erstellen und Abrufen von Produktbeständen.

    Verwenden Sie diese API, um Produktbestandsinformationen zwischen externen Systemen und Now Platformzu verwalten.

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

    Diese API wird innerhalb des Namespace sn_prd_invt bereitgestellt.

    Der aufrufende Benutzer muss die Rolle sn_prd_invt.product_inventory_integrator haben.

    Diese API erstellt und aktualisiert Daten in den folgenden Tabellen.
    • Produktmerkmale [sn_prd_invt_product_characteristics]
    • Produktbestand [sn_prd_invt_product_inventory]
    • Produktmodell [cmdb_model]
    • Produktmodellmerkmal [sn_prd_pm_product_model_characteristic]

    Die Product Inventory Open API ist eine ServiceNow® -Implementierung der REST-Spezifikation der TM Forum Product Inventory Management-API. Diese Implementierung basiert auf der REST-Spezifikation TMF637 Product Inventory Management API Release 19, August 2019. Die offene Product Inventory- API ist vom TM Forum konform.

    TMF-Konformitätslogo

    Product Inventory Open API – GET /sn_prd_invt/product

    Ruft eine Liste aller Produktbestände ab.

    URL-Format

    Standard-URL: api/sn_prd_invt/product

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Kunde Filtern Sie Produktbestände nach Kunden. Nur Produktangebote mit einer Kunden-sys_id oder einer externen ID, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben.

    Datentyp: Zeichenfolge
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter nicht verwendet wird, werden alle Felder zurückgegeben.

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

    Standard: 20

    Höchstwert: 100

    Datentyp: Zahl
    Offset Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Standard: 0

    Datentyp: Zahl
    Ort Filtern Sie Produktbestände nach Ort. In der Antwort werden nur Produktangebote zurückgegeben, deren sys_id oder externe ID mit dem Wert dieses Parameters übereinstimmt.

    Datentyp: Zeichenfolge
    status Filtern Sie Produktbeständenach Status. In der Antwort werden nur Produktbestände mit einem Status zurückgegeben, der dem Wert dieses Parameters entspricht.

    Datentyp: Zeichenfolge
    Tabelle : 3. Anforderungstextparameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

    Tabelle : 4. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Keine
    Tabelle : 5. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Inhaltsbereich Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird.

    Wenn beispielsweise offset=2 und limit=3festgelegt ist, lautet der Wert der Kopfzeile Content-Rangeitems 3-5.
    Content-Type Datenformat des Antworttexts. Unterstützt nur application/json.
    Verknüpfung Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
    • zuerst
    • letzte
    • Weiter
    • previous
    X-Gesamtzahl Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

    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 Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
    206 In Antwort zurückgegebene Teilressource (mit Paginierung).
    400
    Ungültige Anforderung. Mögliche Gründe:
    • Ungültiger Pfadparameter
    • Ungültiger URI
    404 Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    href Relativer Link zum Produktbestandsdatensatz.

    Datentyp: Zeichenfolge
    id Sys_id des Produktbestands aus der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    Name Name des Produktbestands.

    Datentyp: Zeichenfolge
    Ort Ort, der dem Produkt zugeordnet ist.

    Datentyp: Zeichenfolge
    produktMerkmal Liste der Produktmerkmale.

    Datentyp: Array

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    produktMerkmal.name Name des Merkmals.

    Datentyp: Zeichenfolge
    produktMerkmal.wert Wert des Merkmals.

    Datentyp: Zeichenfolge
    productOffering Produktangebot, dem der Produktbestand zugeordnet ist.

    Datentyp: Objekt

    "productOffering": {
   "id": "String",
   "internalId": "String",
   "internalVersion": "String",
   "name": "String",
   "version": "String"
}
    productOffering.id Initial_version oder external_id des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.interneId Initial_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    productOffering.internalVersion Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.name Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.version External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktPreis Gibt ein leeres Array zurück.

    Datentyp: Array
    productRelationship Liste der zugehörigen Produkte.

    Datentyp: Array

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    produktBeziehung.produktId Sys_id des zugehörigen Produkts aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    productRelationship.relationshipType Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    produktSpecification.id Initial_version oder external_id der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    produktSpecification.internalId Initial_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    produktSpecification.internalVersion Version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    Produktspezifikation.Version External_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    realizationResource Ressource, die das Produkt realisiert. Die Realisierungsressource ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizationResource.id Sys_id der ausführenden Ressource. Befindet sich in der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationResource.type Typ der ausführenden Ressource.

    Gültiger Wert: child

    Datentyp: Zeichenfolge
    realappingService Service, der das Produkt realisiert. Der ausführende Service ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizationService.id Sys_id des ausführenden Service. Befindet sich in der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationService.type Typ des ausführenden Service.

    Gültiger Wert: child

    Datentyp: Zeichenfolge
    relatedPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array

    "relatedParty": [
   {
      "id": "String",
      "@referredType": "String"
   }
]
    relatedPartei.id Sys_id des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist. Befindet sich in den Tabellen „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer].

    Datentyp: Zeichenfolge
    relatedPartei.@referenziertTyp Typ des Kunden.
    Mögliche Werte:
    • Kunde
    • Kundenkontakt
    • Verbraucher

    Datentyp: Zeichenfolge
    Status Aktueller Status des Produkts.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel werden alle Produktbestände abgerufen.

    curl --location --request GET "https://instance.service-now.com/api/sn_prd_invt/product" \
--user 'username':'password'

    Antworttext.

    [
   {
      "id": "037fd87ec3603010abc8b5183c40ddf2",
      "relatedParty": [
         {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Example Company",
            "@type": "RelatedParty",
            "@referredType": "Customer"
         },
         {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
         }
      ],
      "name": "Routing and Configuration PI0000318",
      "productSpecification": {
         "id": "aec57e981bb420106ba59acf034bcb08",
         "name": "Routing and Configuration",
         "version": "",
         "internalVersion": "1",
         "internalId": "aec57e981bb420106ba59acf034bcb08"
      },
      "status": "Active",
      "productOffering": {
         "id": "69017a0f536520103b6bddeeff7b127d",
         "name": "Premium SD-WAN Offering",
         "version": "",
         "internalVersion": "1",
         "internalId": "69017a0f536520103b6bddeeff7b127d"
      },
      "product": "ce0b52c7532520103b6bddeeff7b12f5",
      "place": {
         "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
         "name": "100 South Charles Street, Baltimore,MD"
      },
      "productCharacteristic": [],
      "productRelationship": [],
      "realizingService": [],
      "realizingResource": [
         {
            "id": "9b2fa60b536520103b6bddeeff7b1233",
            "name": "Route Target"
         }
      ],
      "productPrice": [],
      "href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
      "billingAccount": "Not Specified."
   }
]

    Product Inventory Open API – GET /sn_prd_invt/product/{id}

    Ruft einen angegebenen Produktbestandsdatensatz ab.

    URL-Format

    Standard-URL: /api/sn_prd_invt/product/{id}

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    id Sys_id des abzurufenden Produktbestands. Befindet sich in der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Kunde Filtern Sie Produktbestände nach Kunden. Nur Produktangebote mit einer Kunden-sys_id oder einer externen ID, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben.

    Datentyp: Zeichenfolge
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter nicht verwendet wird, werden alle Felder zurückgegeben.

    Datentyp: Zeichenfolge
    Ort Filtern Sie Produktbestände nach Ort. In der Antwort werden nur Produktangebote zurückgegeben, deren sys_id oder externe ID mit dem Wert dieses Parameters übereinstimmt.

    Datentyp: Zeichenfolge
    status Filtern Sie Produktbestände nach Status. In der Antwort werden nur Produktbestände mit einem Status zurückgegeben, der dem Wert dieses Parameters entspricht.

    Datentyp: Zeichenfolge
    Tabelle : 9. Anforderungstextparameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

    Tabelle : 10. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Keine
    Tabelle : 11. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Content-Type Datenformat des Antworttexts. Unterstützt nur application/json.

    Statuscodes

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

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Anforderung erfolgreich verarbeitet.
    400
    Ungültige Anforderung. Dies kann einen der folgenden Gründe haben:
    • Ungültiger Pfadparameter
    • Ungültiger URI
    404 Datensatz nicht gefunden Der mit der ID verknüpfte Datensatz wurde in der Tabelle nicht gefunden.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    href Relativer Link zum Produktbestandsdatensatz.

    Datentyp: Zeichenfolge
    id Sys_id des Produktbestands aus der Tabelle „PProduktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    Name Name des Produktbestands.

    Datentyp: Zeichenfolge
    Ort Ort, der dem Produkt zugeordnet ist.

    Datentyp: Zeichenfolge
    produktMerkmal Liste der Produktmerkmale.

    Datentyp: Array

    "productCharacteristic": [
   {
      "name": "String",
      "value": "String"
   }
]
    produktMerkmal.name Name des Merkmals.

    Datentyp: Zeichenfolge
    produktMerkmal.wert Wert des Merkmals.

    Datentyp: Zeichenfolge
    productOffering Produktangebot, dem der Produktbestand zugeordnet ist.

    Datentyp: Objekt

    "productOffering": {
   "id": "String",
   "internalId": "String",
   "internalVersion": "String",
   "name": "String",
   "version": "String"
}
    productOffering.id Initial_version oder external_id des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.interneId Initial_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    productOffering.internalVersion Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.name Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.version External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktPreis Gibt ein leeres Array zurück.

    Datentyp: Array
    productRelationship Liste der zugehörigen Produkte.

    Datentyp: Array

    "productRelationship": [
   {
      "productId": "String",
      "relationshipType": "String"
   }
]
    produktBeziehung.produktId Sys_id des zugehörigen Produkts aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    productRelationship.relationshipType Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    produktSpecification.id Initial_version oder external_id der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    produktSpecification.internalId Initial_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    produktSpecification.internalVersion Version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    Produktspezifikation.Version External_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    realizationResource Ressource, die das Produkt realisiert. Die Realisierungsressource ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizationResource.id Sys_id der ausführenden Ressource. Befindet sich in der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationResource.type Typ der ausführenden Ressource.

    Gültiger Wert: child

    Datentyp: Zeichenfolge
    realappingService Service, der das Produkt realisiert. Der ausführende Service ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizationService.id Sys_id des ausführenden Service. Befindet sich in der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationService.type Typ des ausführenden Service.

    Gültiger Wert: child

    Datentyp: Zeichenfolge
    relatedPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedPartei.id Sys_id des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist. Befindet sich in den Tabellen „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer].

    Datentyp: Zeichenfolge
    relatedPartei.@referenziertTyp Typ des Kunden.

    Datentyp: Zeichenfolge
    Status Aktueller Status des Produkts.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel wird ein angegebener Produktbestand abgerufen.

    curl -X GET 'https://instance.service-now.com/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2' \
--user 'username':'password'

    Ausgabe:

    {
   "id": "037fd87ec3603010abc8b5183c40ddf2",
   "relatedParty": [
      {
         "id": "ffc68911c35420105252716b7d40dd55",
         "name": "Example Company",
         "@type": "RelatedParty",
         "@referredType": "Customer"
      },
      {
         "id": "eaf68911c35420105252716b7d40ddde",
         "name": "Sally Thomas",
         "@type": "RelatedParty",
         "@referredType": "CustomerContact"
      }
   ],
   "name": "Routing and Configuration PI0000318",
   "productSpecification": {
      "id": "aec57e981bb420106ba59acf034bcb08",
      "name": "Routing and Configuration",
      "version": "",
      "internalVersion": "1",
      "internalId": "aec57e981bb420106ba59acf034bcb08"
   },
   "status": "Active",
   "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering",
      "version": "",
      "internalVersion": "1",
      "internalId": "69017a0f536520103b6bddeeff7b127d"
   },
   "product": "ce0b52c7532520103b6bddeeff7b12f5",
   "place": {
      "id": "25ab9c4d0a0a0bb300f7dabdc0ca7c1c",
      "name": "100 South Charles Street, Baltimore,MD"
   },
   "productCharacteristic": [],
   "productRelationship": [],
   "realizingService": [],
   "realizingResource": [
      {
         "id": "9b2fa60b536520103b6bddeeff7b1233",
         "name": "Route Target"
      }
   ],
   "productPrice": [],
   "href": "/api/sn_prd_invt/product/037fd87ec3603010abc8b5183c40ddf2",
   "billingAccount": "Not Specified."
}

    Product Inventory Open API – GET /sn_prd_invt/productinventory

    Ruft eine Liste aller Produktbestände ab.

    Wichtig:
    Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Product Inventory Open API – GET /sn_prd_invt/product.

    URL-Format

    Standard-URL: api/sn_prd_invt/productinventory

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Kunde Filtern Sie Produktbestände nach Kunden. Nur Produktangebote mit einer Kunden-sys_id oder einer externen ID, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben.

    Datentyp: Zeichenfolge
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter nicht verwendet wird, werden alle Felder zurückgegeben.

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

    Standard: 20

    Höchstwert: 100

    Datentyp: Zahl
    Offset Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Standard: 0

    Datentyp: Zahl
    Ort Filtern Sie Produktbestände nach Ort. In der Antwort werden nur Produktangebote zurückgegeben, deren sys_id oder externe ID mit dem Wert dieses Parameters übereinstimmt.

    Datentyp: Zeichenfolge
    status Filtern Sie Produktbestände nach Status. In der Antwort werden nur Produktbestände mit einem Status zurückgegeben, der dem Wert dieses Parameters entspricht.

    Datentyp: Zeichenfolge
    Tabelle : 15. Anforderungstextparameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

    Tabelle : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Keine
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Inhaltsbereich Gibt den Inhaltsbereich an, der in einem paginierten Aufruf zurückgegeben wird.

    Wenn beispielsweise offset=2 und limit=3festgelegt ist, lautet der Wert der Kopfzeile Content-Rangeitems 3-5.
    Content-Type Datenformat des Antworttexts. Unterstützt nur application/json.
    Verknüpfung Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
    • zuerst
    • letzte
    • Weiter
    • previous
    X-Gesamtzahl Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

    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 Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
    206 In Antwort zurückgegebene Teilressource (mit Paginierung).
    400
    Ungültige Anforderung. Mögliche Gründe:
    • Ungültiger Pfadparameter
    • Ungültiger URI
    404 Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    id Sys_id des Produktbestands aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    Name Name des Produktbestands.

    Datentyp: Zeichenfolge
    Ort Ort, der dem Produkt zugeordnet ist.

    Datentyp: Zeichenfolge
    produktMerkmal Liste der Produktmerkmale.

    Datentyp: Array

    "productCharacteristic": [
   {
      "name": "String",
      "value": "String"
   }
]
    produktMerkmal.name Name des Merkmals.

    Datentyp: Zeichenfolge
    produktMerkmal.wert Wert des Merkmals.

    Datentyp: Zeichenfolge
    productOffering Produktangebot, dem der Produktbestand zugeordnet ist.

    Datentyp: Objekt

    "productOffering": {
   "id": "String",
   "name": "String"
}
    productOffering.id Sys_id des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.name Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    productRelationship Liste der zugehörigen Produkte.

    Datentyp: Array

    "productRelationship": [
   {
      "productId": "String",
      "relationshipType": "String"
   }
]
    produktBeziehung.produktId Sys_id des zugehörigen Produkts aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    productRelationship.relationshipType Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
      "id": "String"
}
    produktSpecification.id Sys_id der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    realizationResource Ressource wird realisiert.

    Datentyp: Objekt

    "realizingResource": {
      "id": "String",
      "type": "String"
}
    realizationResource.id Sys_id der realisierenden Ressource aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationResource.type Typ der ausführenden Ressource.

    Datentyp: Zeichenfolge
    realappingService Service wird realisiert.

    Datentyp: Objekt

    "realizingService": {
      "id": "String",
      "type": "String"
}
    realizationService.id Sys_id des implementierenden Service aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationService.type Typ des ausführenden Service.

    Datentyp: Zeichenfolge
    relatedPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array

    "relatedParty": [
   {
      "id": "String",
      "@referredType": "String"
   }
]
    relatedPartei.id Sys_id des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer].

    Datentyp: Zeichenfolge
    relatedPartei.@referenziertTyp Typ des Kunden.
    Mögliche Werte:
    • Kunde
    • customerContact
    • consumer

    Datentyp: Zeichenfolge
    Status Aktueller Status des Produkts.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel werden alle Produktbestände abgerufen.

    curl "https://instance.servicenow.com/api/sn_prd_invt/productinventory" \
--request GET \
--user 'username':'password'

    Antworttext.

    [
   {
      "id": "075072aec3a83010abc8b5183c40dd44",
      "relatedParty": [
         {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
         },
         {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
         }
      ],
      "name": "Firewall Administration PI0000300",
      "productSpecification": {
         "id": "31c5caff07266010a7955b7e0ad3006b",
         "name": "Firewall Administration"
      },
      "status": "Active",
      "productOffering": {
         "id": "",
         "name": ""
      },
      "place": {
         "id": "920cf6ac73d423002728660c4cf6a799",
         "name": "200 South James street,Atlanta, GA"
      },
      "productCharacteristic": [
         {
            "name": "Firewall Administration CPE Type",
            "valueType": "Choice",
            "value": "Physical"
         },
         {
            "name": "Configuration and Policy backup",
            "valueType": "Choice",
            "value": ""
         },
         {
            "name": "Firewall Administration CPE ID",
            "valueType": "Single Line Text",
            "value": "CPE123456789"
         },
         {
            "name": "Remote CLI troubleshoot support",
            "valueType": "Choice",
            "value": ""
         },
         {
            "name": "Firewall Administration CPE Model",
            "valueType": "Choice",
            "value": "9300 series"
         }
      ],
      "productRelationship": [],
      "realizingService": [],
      "realizingResource": [
         {
            "id": "3546463307666010a7955b7e0ad3005d",
            "name": "Cisco Firewall Management system"
         }
      ]
   },
   {
      "id": "0303a8ea74418510f877ca57242ff96d",
      "relatedParty": [
         {
            "id": "ffc68911c35420105252716b7d40dd55",
            "name": "Funco Intl",
            "@type": "RelatedParty",
            "@referredType": "Customer"
         },
         {
            "id": "eaf68911c35420105252716b7d40ddde",
            "name": "Sally Thomas",
            "@type": "RelatedParty",
            "@referredType": "CustomerContact"
         }
      ],
      "name": "SD-WAN Edge Device PI0001114",
      "productSpecification": {
         "id": "39b627aa53702010cd6dddeeff7b1202",
         "name": "SD-WAN Edge Device"
      },
      "status": "Installation Pending",
      "productOffering": {
         "id": "69017a0f536520103b6bddeeff7b127d",
         "name": "Premium SD-WAN Offering"
      },
      "place": "",
      "productCharacteristic": [],
      "productRelationship": [],
      "realizingService": [
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         },
         {
            "id": "16d79ec3532520103b6bddeeff7b12a6",
            "name": "SD WAN Optimization Service"
         },
         {
            "id": "16d79ec3532520103b6bddeeff7b12a6",
            "name": "SD WAN Optimization Service"
         },
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         },
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         },
         {
            "id": "bf65eadc1b7420106ba59acf034bcb57",
            "name": "SD-WAN Routing"
         }
      ],
      "realizingResource": [
         {
            "id": "493fa60b536520103b6bddeeff7b12b6",
            "name": "Customer Premise SD-WAN Router"
         }
      ]
   }
]

    Product Inventory Open API – GET /sn_prd_invt/productinventory/{inventoryId}

    Ruft einen Produktbestand ab.

    Wichtig:
    Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Product Inventory Open API – GET /sn_prd_invt/product/{id}.

    URL-Format

    Standard-URL: /api/sn_prd_invt/productinventory/{inventoryId}

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    inventoryId Sys_id des abzurufenden Produktbestands. Befindet sich in der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Kunde Filtern Sie Produktbestände nach Kunden. Nur Produktangebote mit einer Kunden-sys_id oder einer externen ID, die dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben.

    Datentyp: Zeichenfolge
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter nicht verwendet wird, werden alle Felder zurückgegeben.

    Datentyp: Zeichenfolge
    Ort Filtern Sie Produktbestände nach Ort. In der Antwort werden nur Produktangebote zurückgegeben, deren sys_id oder externe ID mit dem Wert dieses Parameters übereinstimmt.

    Datentyp: Zeichenfolge
    status Filtern Sie Produktbestände nach Status. In der Antwort werden nur Produktbestände mit einem Status zurückgegeben, der dem Wert dieses Parameters entspricht.

    Datentyp: Zeichenfolge
    Tabelle : 21. Anforderungstextparameter (JSON)
    Name Beschreibung
    Keine

    Kopfzeilen

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

    Tabelle : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Keine
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Content-Type Datenformat des Antworttexts. Unterstützt nur application/json.

    Statuscodes

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

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Anforderung erfolgreich verarbeitet.
    400
    Ungültige Anforderung. Dies kann einen der folgenden Gründe haben:
    • Ungültiger Pfadparameter
    • Ungültiger URI
    404 Datensatz nicht gefunden Der mit der ID verknüpfte Datensatz wurde in der Tabelle nicht gefunden.

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    id Sys_id des Produktbestands aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    Name Name des Produktbestands.

    Datentyp: Zeichenfolge
    Ort Ort, der dem Produkt zugeordnet ist.

    Datentyp: Zeichenfolge
    produktMerkmal Liste der Produktmerkmale.

    Datentyp: Array

    "productCharacteristic": [
   {
      "name": "String",
      "value": "String"
   }
]
    produktMerkmal.name Name des Merkmals.

    Datentyp: Zeichenfolge
    produktMerkmal.wert Wert des Merkmals.

    Datentyp: Zeichenfolge
    productOffering Produktangebot, dem der Produktbestand zugeordnet ist.

    Datentyp: Objekt

    "productOffering": {
   "id": "String",
   "name": "String"
}
    productOffering.id Sys_id des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.name Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    productRelationship Liste der zugehörigen Produkte.

    Datentyp: Array

    "productRelationship": [
   {
      "productId": "String",
      "relationshipType": "String"
   }
]
    produktBeziehung.produktId Sys_id des zugehörigen Produkts aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    productRelationship.relationshipType Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
      "id": "String"
}
    produktSpecification.id Sys_id der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    realizationResource Ressource wird realisiert.

    Datentyp: Objekt

    "realizingResource": {
      "id": "String",
      "type": "String"
}
    realizationResource.id Sys_id der realisierenden Ressource aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationResource.type Typ der ausführenden Ressource.

    Datentyp: Zeichenfolge
    realappingService Service wird realisiert.

    Datentyp: Objekt

    "realizingService": {
      "id": "String",
      "type": "String"
}
    realizationService.id Sys_id des implementierenden Service aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationService.type Typ des ausführenden Service.

    Datentyp: Zeichenfolge
    relatedPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array

    "relatedParty": [
   {
      "id": "String",
      "@referredType": "String"
   }
]
    relatedPartei.id Sys_id des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist. Befindet sich in den Tabellen „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer].

    Datentyp: Zeichenfolge
    relatedPartei.@referenziertTyp Typ des Kunden.
    Mögliche Werte:
    • Kunde
    • Kundenkontakt
    • Verbraucher

    Datentyp: Zeichenfolge
    Status Aktueller Status des Produkts.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel wird ein Produktbestand für ein SD-WAN-Servicepaket abgerufen.

    curl --location --request GET 'https:// instance.servicenow.com/api/sn_prd_invt/productinventory/074450fc74918d10f877ca57242ff9e3' \
--user 'username':'password'

    Ausgabe:

    {
   "id": "074450fc74918d10f877ca57242ff9e3",
   "relatedParty": [
      {
         "id": "ffc68911c35420105252716b7d40dd55",
         "name": "Funco Intl",
         "@type": "RelatedParty",
         "@referredType": "Customer"
      },
      {
         "id": "eaf68911c35420105252716b7d40ddde",
         "name": "Sally Thomas",
         "@type": "RelatedParty",
         "@referredType": "CustomerContact"
      }
   ],
   "name": "SD-WAN Service Package PI0001576",
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package"
   },
   "status": "Installation Pending",
   "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering"
   },
   "place": "",
   "productCharacteristic": [],
   "productRelationship": [
      {
         "id": "a74490fc74918d10f877ca57242ff942",
         "name": "SD-WAN Edge Device PI0001582",
         "relationshipType": "Bundles"
      },
      {
         "id": "b85414fc74918d10f877ca57242ff90e",
         "name": "SD-WAN Controller PI0001602",
         "relationshipType": "Bundles"
      },
      {
         "id": "d74490fc74918d10f877ca57242ff907",
         "name": "SD-WAN Security PI0001577",
         "relationshipType": "Bundles"
      }
   ],
   "realizingService": [],
   "realizingResource": []
}

    Product Inventory Open API – POST /sn_prd_invt/product

    Erstellt einen Produktbestandsdatensatz.

    URL-Format

    Standard-URL: /api/sn_prd_invt/product

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstextparameter (JSON)
    Name Beschreibung
    Name Erforderlich. Name des Produktbestands.

    Datentyp: Zeichenfolge
    pid Eindeutiger Bezeichner für den Produktbestand aus dem externen System.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    produktMerkmal Liste der Produktmerkmale.

    Datentyp: Array

    "productCharacteristic": [
   {
      "name": "String",
      "value": "String"
   }
]
    produktMerkmal.name Name des Merkmals.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    produktMerkmal.wert Wert des Merkmals.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    productOffering Erforderlich. Produktangebot, dem der Produktbestand zugeordnet ist.

    Datentyp: Objekt

    "productOffering": {
   "id": "String",
   "internalVersion": "String",
   "name": "String",
   "version": "String"
}
    productOffering.id Erforderlich. Initial_version oder external_id des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    productOffering.internalVersion Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.name Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    produktAngebot.version External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    productRelationship Liste der zugehörigen Produkte.

    Datentyp: Array

    "productRelationship": [
   {
      "productId": "String",
      "relationshipType": "String"
   }
]
    produktBeziehung.produktId Erforderlich, wenn der Parameter productRelationship verwendet wird. Sys_id des zugehörigen Produkts aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    productRelationship.relationshipType Typ der Beziehung. Der einzige gültige Wert ist child.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Produktspezifikation Erforderlich. Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
      "id": "String",
      "internalVersion": "String",
      "version": "String"
}
    produktSpecification.id Erforderlich. Initial_version oder external_id der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    produktSpecification.internalVersion Version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    Produktspezifikation.Version External_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    realizationResource Ressource, die das Produkt realisiert. Die Realisierungsressource ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizationResource.id Erforderlich, wenn der Parameter realizingResource verwendet wird. Sys_id der ausführenden Ressource. Befindet sich in der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationResource.type Typ der ausführenden Ressource.

    Gültiger Wert: child

    Datentyp: Zeichenfolge
    realappingService Service, der das Produkt realisiert. Der ausführende Service ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizationService.id Erforderlich, wenn der Parameter realizingService verwendet wird. Sys_id des ausführenden Service. Befindet sich in der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationService.type Typ des ausführenden Service.

    Gültiger Wert: child

    Datentyp: Zeichenfolge
    relatedPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedPartei.id Erforderlich, wenn der Parameter relatedParty verwendet wird. Sys_id des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist. Befindet sich in den Tabellen „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer].

    Datentyp: Zeichenfolge
    relatedPartei.@referenziertTyp Typ des Kunden.
    Mögliche Werte:
    • Kunde
    • customer_contact
    • consumer

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Status Aktueller Status des Produkts.
    Mögliche Werte:
    • aktiv
    • change_pending
    • inactivation_pending
    • Inaktiv
    • „installation_pending“.

    Datentyp: Zeichenfolge

    Standard: install_pending

    Header

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

    Tabelle : 28. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 29. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Content-Type Datenformat des Antworttexts. Unterstützt nur application/json.

    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
    201 Anforderung erfolgreich verarbeitet.
    400 Ungültige Anforderung. Dies kann einen der folgenden Gründe haben:
    • Leere Nutzlast.
    • Ungültige Nutzlast. Pflichtfeld fehlt:<field name>

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    href Relativer Link zum Produktbestandsdatensatz.

    Datentyp: Zeichenfolge
    id Sys_id des Produktbestands aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    Name Name des Produktbestands.

    Datentyp: Zeichenfolge
    pid Eindeutiger Bezeichner für den Produktbestand aus dem externen System.

    Datentyp: Zeichenfolge
    produktMerkmal Liste der Produktmerkmale.

    Datentyp: Array

    "productCharacteristic": [
   {
      "name": "String",
      "value": "String"
   }
]
    produktMerkmal.name Name des Merkmals.

    Datentyp: Zeichenfolge
    produktMerkmal.wert Wert des Merkmals.

    Datentyp: Zeichenfolge
    productOffering Produktangebot, dem der Produktbestand zugeordnet ist.

    Datentyp: Objekt

    "productOffering": {
   "id": "String",
   "internalId": "String",
   "internalVersion": "String",
   "name": "String",
   "version": "String"
}
    productOffering.id Initial_version oder external_id des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.interneId Initial_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    productOffering.internalVersion Version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.name Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.version External_version des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktPreis Gibt ein leeres Array zurück.

    Datentyp: Array
    productRelationship Liste der zugehörigen Produkte.

    Datentyp: Array

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    produktBeziehung.produktId Sys_id des zugehörigen Produkts aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    productRelationship.relationshipType Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    produktSpecification.id Initial_version oder external_id der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    produktSpecification.internalId Initial_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    produktSpecification.internalVersion Version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    Produktspezifikation.Version External_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    realizationResource Ressource, die das Produkt realisiert. Die Realisierungsressource ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizationResource.id Sys_id der ausführenden Ressource. Befindet sich in der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationResource.type Typ der ausführenden Ressource.

    Gültiger Wert: child

    Datentyp: Zeichenfolge
    realappingService Service, der das Produkt realisiert. Der ausführende Service ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizationService.id Sys_id des ausführenden Service. Befindet sich in der Produktbestandstabelle [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationService.type Typ des ausführenden Service.

    Gültiger Wert: child

    Datentyp: Zeichenfolge
    relatedPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array

    "relatedParty": [
  {
     "id": "String",
     "@referredType": "String"
  }
]
    relatedPartei.id Sys_id des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist. Befindet sich in den Tabellen „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer].

    Datentyp: Zeichenfolge
    relatedPartei.@referenziertTyp Typ des Kunden.
    Mögliche Werte:
    • Kunde
    • Kundenkontakt
    • Verbraucher

    Datentyp: Zeichenfolge
    Status Aktueller Status des Produkts.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel wird ein Produktbestand für eine Voice over IP-Lösung für einen Benutzer erstellt.

    curl -X POST "https://instance.service-now.com/api/sn_prd_invt/product" \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--user "username":"password" \
--data "[
   {
      "pid": "PO-456",
      "description": "inventory description",
      "isBundle": false,
      "name": "Voice Over IP Basic instance for Jean",
      "productOffering": {
         "@referredType": "ProductOffering",
         "name": "Premium SD-WAN Offering",
         "id": "69017a0f536520103b6bddeeff7b127d"
      },
      "productCharacteristic": [],
      "productRelationship": [
         {
            "productId": "fa6d13f45b5620102dff5e92dc81c77f",
            "relationshipType": "child"
         }
      ],
      "realizingService": {
         "id": "fe6d13f45b5620102dff5e92dc81c786",
         "relationshipType": "child"
      },
      "realizingResource": {
         "id": "326d13f45b5620102dff5e92dc81c78c",
         "relationshipType": "child"
      },
      "relatedParty": [
         {
            "@referredType": "CustomerContact",
            "@type": "RelatedParty",
            "name": "Sally Thomas",
            "id": "eaf68911c35420105252716b7d40ddde"
         },
         {
            "@referredType": "Customer",
            "@type": "RelatedParty",
            "name": "Funco Intl",
            "id": "ffc68911c35420105252716b7d40dd55"
         }
      ],
      "productSpecification": {
         "@referredType": "ProductSpecification",
         "@type": null,
         "name": null,
         "id": "3ee1fdb1c3331010d216b5183c40dd81",
         "internalVersion": "1"
      },
      "bundle": false
   }
]"

    Antworttext.

    {
   "pid": "PO-456",
   "description": "inventory description",
   "isBundle": false,
   "name": "Voice Over IP Basic instance for Jean",
   "productOffering": {
      "@referredType": "ProductOffering",
      "name": "Premium SD-WAN Offering",
      "id": "69017a0f536520103b6bddeeff7b127d",
      "internalVersion": "1",
      "version": null,
      "status": "published",
      "internalId": "69017a0f536520103b6bddeeff7b127d"
   },
   "productCharacteristic": [],
   "productRelationship": [
      {
         "productId": "fa6d13f45b5620102dff5e92dc81c77f",
         "relationshipType": "child"
      }
   ],
   "realizingService": {
      "id": "fe6d13f45b5620102dff5e92dc81c786",
      "relationshipType": "child"
   },
   "realizingResource": {
      "id": "326d13f45b5620102dff5e92dc81c78c",
      "relationshipType": "child"
   },
   "relatedParty": [
      {
         "@referredType": "CustomerContact",
         "@type": "RelatedParty",
         "name": "Sally Thomas",
         "id": "eaf68911c35420105252716b7d40ddde"
      },
      {
         "@referredType": "Customer",
         "@type": "RelatedParty",
         "name": "Example Company",
         "id": "ffc68911c35420105252716b7d40dd55"
      }
   ],
   "productSpecification": {
      "@referredType": "ProductSpecification",
      "@type": null,
      "name": null,
      "id": "3ee1fdb1c3331010d216b5183c40dd81",
      "internalVersion": "1",
      "version": null,
      "status": "published",
      "internalId": "3ee1fdb1c3331010d216b5183c40dd81"
   },
   "bundle": false,
   "productPrice": [],
   "id": "25b07475471789108761b955d36d439d",
   "href": "/api/sn_prd_invt/product/25b07475471789108761b955d36d439d"
}

    Product Inventory Open API – POST /sn_prd_invt/productinventory

    Erstellt einen Produktbestand.

    Wichtig:
    Ab Release Tokyo ist dieser Endpunkt veraltet. Die neue Version dieses Endpunkts ist Product Inventory Open API – POST /sn_prd_invt/product.

    URL-Format

    Standard-URL: /api/sn_prd_invt/productinventory

    Unterstützte Anforderungsparameter

    Tabelle : 31. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 33. Anforderungstextparameter (JSON)
    Name Beschreibung
    Name Erforderlich. Name des Produktbestands.

    Datentyp: Zeichenfolge
    pid Eindeutiger Bezeichner für den Produktbestand aus dem externen System.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    produktMerkmal Liste der Produktmerkmale.

    Datentyp: Array

    "productCharacteristic": [
   {
      "name": "String",
      "value": "String"
   }
]
    produktMerkmal.name Name des Merkmals.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    produktMerkmal.wert Wert des Merkmals.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    productOffering Erforderlich. Produktangebot, dem der Produktbestand zugeordnet ist.

    Datentyp: Objekt

    "productOffering": {
   "id": "String",
   "name": "String"
}
    productOffering.id Erforderlich. Sys_id des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.name Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    productRelationship Liste der zugehörigen Produkte.

    Datentyp: Array

    "productRelationship": [
   {
      "productId": "String",
      "relationshipType": "String"
   }
]
    produktBeziehung.produktId Erforderlich, wenn der Parameter productRelationship verwendet wird. Sys_id des zugehörigen Produkts aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    productRelationship.relationshipType Typ der Beziehung. Der einzige gültige Wert ist child.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Produktspezifikation Erforderlich. Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
      "id": "String"
}
    produktSpecification.id Erforderlich. Sys_id der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    realizationResource Ressource wird realisiert.

    Datentyp: Objekt

    "realizingResource": {
      "id": "String",
      "type": "String"
}
    realizationResource.id Erforderlich, wenn der Parameter realizingResource verwendet wird. Sys_id der realisierenden Ressource aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationResource.type Typ der ausführenden Ressource. Der einzige gültige Wert ist child.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    realappingService Service wird realisiert.

    Datentyp: Objekt

    "realizingService": {
      "id": "String",
      "type": "String"
}
    realizationService.id Erforderlich, wenn der Parameter realizingService verwendet wird. Sys_id des implementierenden Service aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationService.type Typ des ausführenden Service. Der einzige gültige Wert ist child.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    relatedPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array

    "relatedParty": [
   {
      "id": "String",
      "@referredType": "String"
   }
]
    relatedPartei.id Erforderlich, wenn der Parameter relatedParty verwendet wird. Sys_id des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist. Befindet sich in der Tabelle „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_Consumer].

    Datentyp: Zeichenfolge
    relatedPartei.@referenziertTyp Typ des Kunden.
    Mögliche Werte:
    • Kunde
    • customer_contact
    • consumer

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Status Aktueller Status des Produkts.
    Mögliche Werte:
    • aktiv
    • change_pending
    • inactivation_pending
    • Inaktiv
    • „installation_pending“.

    Datentyp: Zeichenfolge

    Standard: install_pending

    Header

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

    Tabelle : 34. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützt nur application/json.
    Content-Type Datenformat des Anforderungstexts. Unterstützt nur application/json.
    Tabelle : 35. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Content-Type Datenformat des Antworttexts. Unterstützt nur application/json.

    Statuscodes

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

    Tabelle : 36. Statuscodes
    Statuscode Beschreibung
    201 Anforderung erfolgreich verarbeitet.
    400 Ungültige Anforderung. Dies kann einen der folgenden Gründe haben:
    • Leere Nutzlast.
    • Ungültige Nutzlast. Pflichtfeld fehlt:<field name>

    Parameter des Antwort-Haupttexts (JSON)

    Name Beschreibung
    id Sys_id des Produktbestands aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    Name Name des Produktbestands.

    Datentyp: Zeichenfolge
    pid Eindeutiger Bezeichner für den Produktbestand aus dem externen System.

    Datentyp: Zeichenfolge
    produktMerkmal Liste der Produktmerkmale.

    Datentyp: Array

    "productCharacteristic": [
   {
      "name": "String",
      "value": "String"
   }
]
    produktMerkmal.name Name des Merkmals.

    Datentyp: Zeichenfolge
    produktMerkmal.wert Wert des Merkmals.

    Datentyp: Zeichenfolge
    productOffering Produktangebot, dem der Produktbestand zugeordnet ist.

    Datentyp: Objekt

    "productOffering": {
   "id": "String",
   "name": "String"
}
    productOffering.id Sys_id des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    produktAngebot.name Name des Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    productRelationship Liste der zugehörigen Produkte.

    Datentyp: Array

    "productRelationship": [
   {
      "productId": "String",
      "relationshipType": "String"
   }
]
    produktBeziehung.produktId Sys_id des zugehörigen Produkts aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    productRelationship.relationshipType Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
      "id": "String"
}
    produktSpecification.id Sys_id der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].

    Datentyp: Zeichenfolge
    realizationResource Ressource wird realisiert.

    Datentyp: Objekt

    "realizingResource": {
      "id": "String",
      "type": "String"
}
    realizationResource.id Sys_id der realisierenden Ressource aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationResource.type Typ der ausführenden Ressource.

    Datentyp: Zeichenfolge
    realappingService Service wird realisiert.

    Datentyp: Objekt

    "realizingService": {
      "id": "String",
      "type": "String"
}
    realizationService.id Sys_id des implementierenden Service aus der Tabelle „Produktbestand“ [sn_prd_invt_product_inventory].

    Datentyp: Zeichenfolge
    realizationService.type Typ des ausführenden Service.

    Datentyp: Zeichenfolge
    relatedPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array

    "relatedParty": [
   {
      "id": "String",
      "@referredType": "String"
   }
]
    relatedPartei.id Sys_id des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist. Befindet sich in den Tabellen „Account“ [customer_account], „Kontakt“ [customer_contact] oder „Verbraucher“ [csm_consumer].

    Datentyp: Zeichenfolge
    relatedPartei.@referenziertTyp Typ des Kunden.
    Mögliche Werte:
    • Kunde
    • Kundenkontakt
    • Verbraucher

    Datentyp: Zeichenfolge
    Status Aktueller Status des Produkts.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    In diesem Beispiel wird ein Produktbestand für eine Voice over IP-Lösung für einen Benutzer erstellt.

    curl --location --request POST “https://instance.servicenow.com/api/sn_prd_invt/productinventory” \
--header “Content-Type: application/json” \
--data-raw '[
    {
        "pid": "demoInventory",
        "description": "inventory description",
        "isBundle": false,
        "name": "Voice Over IP Basic instance for Jean",
        "productOffering": {
            "id": "69017a0f536520103b6bddeeff7b127d",
            "name": "Premium SD-WAN Offering",
            "@referredType": "ProductOffering"
        },
        "productCharacteristic": [
            {
                "name": "CPE Type",
                "valueType": "choice",
                "value": "Virtual"
            },
            {
                "name":"Routing",
                "valueType": "choice",
                "value": "Premium"
            }
        ],
        "productRelationship": [
            {
                "productId": "7e6d13f45b5620102dff5e92dc81c787",
                "relationshipType": "child"
            }
        ],
        "relatedParty": [
            {
                "id": "eaf68911c35420105252716b7d40ddde",
                "name": "Sally Thomas",
                "role": "User",
                "@type": "RelatedParty",
                "@referredType": "CustomerContact"
            },
            {
                "id": "ffc68911c35420105252716b7d40dd55",
                "name": "Funco Intl",
                "@type": "RelatedParty",
                "@referredType": "Customer"
            }
        ],
        "productSpecification": {
            "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
            "@referredType": "ProductSpecification",
            "version": "1"
        }
    }
]'
--user 'username':'password'

    Antworttext.

    {
   "pid": "demoInventory",
   "description": "inventory description",
   "isBundle": false,
   "name": "Voice Over IP Basic instance for Jean",
   "productOffering": {
      "id": "69017a0f536520103b6bddeeff7b127d",
      "name": "Premium SD-WAN Offering",
      "@referredType": "ProductOffering"
   },
   "productCharacteristic": [
      {
         "name": "CPE Type",
         "valueType": "choice",
         "value": "Virtual"
      },
      {
         "name": "Routing",
         "valueType": "choice",
         "value": "Premium"
      }
   ],
   "productRelationship": [
      {
         "productId": "7e6d13f45b5620102dff5e92dc81c787",
         "relationshipType": "child"
      }
   ],
   "relatedParty": [
      {
         "id": "eaf68911c35420105252716b7d40ddde",
         "name": "Sally Thomas",
         "role": "User",
         "@type": "RelatedParty",
         "@referredType": "CustomerContact"
      },
      {
         "id": "ffc68911c35420105252716b7d40dd55",
         "name": "Funco Intl",
         "@type": "RelatedParty",
         "@referredType": "Customer"
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "@referredType": "ProductSpecification",
      "version": "1"
   },
   "id": "3ac715c6745d8150f877ca57242ff97a"
}