Offene API für Produktbestand

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 26 Minuten Lesedauer

    • Die Produktbestand Offen Die API stellt Endpunkte zum Erstellen und Abrufen von Produktbeständen bereit.

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

    Diese API ist in der Anwendung „Produktbestand erweitert“ enthalten, die auf verfügbar ist ServiceNow Store.

    Diese API wird in bereitgestellt sn_prd_invt Namespace.

    Der aufrufende Anwender muss über die Rolle „sn_prd_invt.product_inventory_integrator“ verfügen.

    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 Produktbestand Offen API ist ein ServiceNow®Implementierung der REST-Spezifikation der API für Produktbestandsmanagement des TM-Forums. Diese Implementierung basiert auf TMF637 API-REST-Spezifikation für Produktbestandsmanagement Release 19 , August 2019. Die Produktbestand Offen API ist vom TM-Forum zertifiziert.

    TMF-Konformitätslogo

    Offene API für Produktbestand – GET /sn_prd_invt/Product ab

    Ruft eine Liste aller Produktbestände ab.

    URL-Format

    Standard-URL: api/sn_prd_invt/Product

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfad-Parameter
    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

    Standard: Nicht nach Kunde filtern.
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert.

    Datentyp: Zeichenfolge

    Standard: Alle Felder zurückgeben.
    limit Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100
    Offset Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken.

    Datentyp: Zahl

    Standard: 0
    Ort Filtern Sie Produktbestände nach Ort. In der Antwort werden nur Produktangebote mit einer Place sys_ID oder einer externen ID zurückgegeben, die dem Wert dieses Parameters entspricht.

    Datentyp: Zeichenfolge

    Standard: Nicht nach Ort filtern.
    Status Filtern Sie Produktbestände nach Status. Nur Produktbestände mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben.

    Datentyp: Zeichenfolge

    Standard: Nicht nach Status filtern.
    Tabelle : 3. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 4. Anforderungskopfzeilen.
    Header Beschreibung
    Keine
    Tabelle : 5. Antwort-Header
    Header Beschreibung
    Inhaltsbereich Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird.

    Beispiel: Wenn Offset=2 Und Grenzwert = 3 , Der Wert von Content-RangeHeader ist Elemente 3-5 .
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt application/json.
    Verknüpfen Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
    • zuerst
    • letzte
    • Weiter
    • previous
    X-Gesamtzahl Für paginierte 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Anforderung erfolgreich verarbeitet. Vollständige Ressource in Antwort zurückgegeben (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.

    Antworttext-Parameter (JSON)

    Name Beschreibung
    href Relativer Link zum Produktbestandsdatensatz.

    Datentyp: Zeichenfolge
    ID SYS_ID des Produktbestands.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    name Name des Produktbestands.

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

    Datentyp: Zeichenfolge
    Produktmerkmal Liste der Produktmerkmale.

    Datentyp: Array von Objekten

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.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"
}
    Produktangebot.ID Anfangsversion oder externe ID des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „initial_Version“ oder „external_ID“ der Tabelle „Produktangebot [sn_prd_pm_product_offering]“.
    productOffering.internalId Anfangsversion des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „internal_Version“ des Produktangebots [sn_prd_pm_product_offering]
    productOffering.internalVersion Version des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
    productOffering.name Name des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    ProductOffering.Version Externe Version des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
    ProductPrice Gibt ein leeres Array zurück.

    Datentyp: Array
    Produktbeziehung Liste der zugehörigen Produkte.

    Datentyp: Array von Objekten

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId SYS_ID des zugehörigen Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    Produktbeziehung.Beziehungstyp Typ der Beziehung .

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id Anfangsversion oder externe ID der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „internal_Version“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    productSpecification.internalId Anfangsversion der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „initial_Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    productSpecification.internalVersion Version der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    Produktspezifikation.Version Externe Version der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    RealizingRessource Ressource, die das Produkt realisiert. Die Realisierungsressource ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id SYS_ID der realisierenden Ressource.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingResource.type Typ der realisierenden Ressource.

    Gültiger Wert: Untergeordnetes Element

    Datentyp: Zeichenfolge
    RealizingService Service, der das Produkt realisiert. Der realisierende Service ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id SYS_ID des realisierenden Service.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingService.type Typ des realisierenden Service.

    Gültiger Wert: Untergeordnetes Element

    Datentyp: Zeichenfolge
    ZugehörigPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array von Objekten

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id SYS_ID des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account], Kontakt [Customer_contact] oder Verbraucher [csm_Consumer]
    RelatedParty.@referredType Typ des Kunden.
    Mögliche Werte:
    • Verbraucher
    • Kunde
    • Kundenkontakt

    Datentyp: Zeichenfolge
    Staat Aktueller Status des Produkts.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Dieses Beispiel ruft alle Produktbestände ab.

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

    Offene API für Produktbestand – GET /sn_prd_invt/Product/{ID} ab

    Ruft einen angegebenen Produktbestandsdatensatz ab.

    URL-Format

    Standard-URL: /api/sn_prd_invt/Product/{ID}

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfad-Parameter
    Name Beschreibung
    ID SYS_ID des abzurufenden Produktbestands.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    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

    Standard: Kunden nicht ausfüllen.
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert.

    Datentyp: Zeichenfolge

    Standard: Alle Felder zurückgegeben.
    Ort Filtern Sie Produktbestände nach Ort. In der Antwort werden nur Produktangebote mit einer Place sys_ID oder einer externen ID zurückgegeben, die dem Wert dieses Parameters entspricht.

    Datentyp: Zeichenfolge

    Standard: Nicht nach Ort filtern.
    Status Filtern Sie Produktbestände nach Status. Nur Produktbestände mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben.

    Datentyp: Zeichenfolge

    Standard: Nicht nach Status filtern.
    Tabelle : 9. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 10. Anforderungskopfzeilen.
    Header Beschreibung
    Keine
    Tabelle : 11. Antwort-Header
    Header Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt application/json.

    Statuscodes

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

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Anforderung erfolgreich verarbeitet.
    400
    Ungültige Anforderung. Kann einer der folgenden Gründe sein:
    • Ungültiger Pfadparameter
    • Ungültiger URI
    404 Datensatz nicht gefunden Datensatz, der der ID zugeordnet ist, wurde in der Tabelle nicht gefunden.

    Antworttext-Parameter (JSON)

    Name Beschreibung
    href Relativer Link zum Produktbestandsdatensatz.

    Datentyp: Zeichenfolge
    ID SYS_ID des Produktbestands

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    name Name des Produktbestands.

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

    Datentyp: Zeichenfolge
    Produktmerkmal Liste der Produktmerkmale.

    Datentyp: Array von Objekten

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.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"
}
    Produktangebot.ID Anfangsversion oder externe ID des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „initial_Version“ oder „external_ID“ der Tabelle „Produktangebot [sn_prd_pm_product_offering]“.
    productOffering.internalId Anfangsversion des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „internal_Version“ des Produktangebots [sn_prd_pm_product_offering]
    productOffering.internalVersion Version des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
    productOffering.name Name des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    ProductOffering.Version Externe Version des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
    ProductPrice Gibt ein leeres Array zurück.

    Datentyp: Array
    Produktbeziehung Liste der zugehörigen Produkte.

    Datentyp: Array von Objekten

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId SYS_ID des zugehörigen Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    Produktbeziehung.Beziehungstyp Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id Anfangsversion oder externe ID der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „internal_Version“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    productSpecification.internalId Anfangsversion der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „initial_Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    productSpecification.internalVersion Version der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    Produktspezifikation.Version Externe Version der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    RealizingRessource Ressource, die das Produkt realisiert. Die Realisierungsressource ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id SYS_ID der realisierenden Ressource.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingResource.type Typ der realisierenden Ressource.

    Gültiger Wert: Untergeordnetes Element

    Datentyp: Zeichenfolge
    RealizingService Service, der das Produkt realisiert. Der realisierende Service ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id SYS_ID des realisierenden Service.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingService.type Typ des realisierenden Service.

    Gültiger Wert: Untergeordnetes Element

    Datentyp: Zeichenfolge
    ZugehörigPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array von Objekten

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id SYS_ID des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account], Kontakt [Customer_contact] oder Verbraucher [csm_Consumer]
    RelatedParty.@referredType Typ des Kunden.

    Datentyp: Zeichenfolge
    Staat Aktueller Status des Produkts.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Dieses Beispiel ruft einen angegebenen Produktbestand ab.

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

    Offene API für Produktbestand – GET /sn_prd_invt/productInventory ab

    Ruft eine Liste aller Produktbestände ab.

    Wichtig:
    Beginnend mit TokyoRelease, dieser Endpunkt ist veraltet. Die neue Version dieses Endpunkts ist Offene API für Produktbestand – GET /sn_prd_invt/Product ab.

    URL-Format

    Standard-URL: api/sn_prd_invt/productInventory

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfad-Parameter
    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

    Standard: Nicht nach Kunde filtern.
    Felder Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert.

    Datentyp: Zeichenfolge

    Standard: Alle Felder werden zurückgegeben.
    limit Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs.

    Datentyp: Zahl

    Standard: 20

    Maximum: 100
    Offset Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken.

    Datentyp: Zahl

    Standard: 0
    Ort Filtern Sie Produktbestände nach Ort. In der Antwort werden nur Produktangebote mit einer Place sys_ID oder einer externen ID zurückgegeben, die dem Wert dieses Parameters entspricht.

    Datentyp: Zeichenfolge

    Standard: Nicht nach Ort filtern.
    Status Filtern Sie Produktbestände nach Status. Nur Produktbestände mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben.

    Datentyp: Zeichenfolge

    Standard: Nicht nach Bestandsstatus filtern.
    Tabelle : 15. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 16. Anforderungskopfzeilen.
    Header Beschreibung
    Keine
    Tabelle : 17. Antwort-Header
    Header Beschreibung
    Inhaltsbereich Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird.

    Beispiel: Wenn Offset=2 Und Grenzwert = 3 , Der Wert von Content-RangeHeader ist Elemente 3-5 .
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt application/json.
    Verknüpfen Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
    • zuerst
    • letzte
    • Weiter
    • previous
    X-Gesamtzahl Für paginierte 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 REST-API-HTTP-Antwortcodes .

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Anforderung erfolgreich verarbeitet. Vollständige Ressource in Antwort zurückgegeben (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.

    Antworttext-Parameter (JSON)

    Name Beschreibung
    ID SYS_ID des Produktbestands.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    name Name des Produktbestands.

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

    Datentyp: Zeichenfolge
    Produktmerkmal Liste der Produktmerkmale.

    Datentyp: Array von Objekten

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.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"
}
    Produktangebot.ID SYS_ID des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    productOffering.name Name des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    Produktbeziehung Liste der zugehörigen Produkte.

    Datentyp: Array von Objekten

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId SYS_ID des zugehörigen Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    Produktbeziehung.Beziehungstyp Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
  "id": "String"
}
    productSpecification.id SYS_ID der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
    RealizingRessource Ressource wird realisiert.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id SYS_ID der realisierenden Ressource.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingResource.type Typ der realisierenden Ressource.

    Datentyp: Zeichenfolge
    RealizingService Service wird realisiert.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id SYS_ID des realisierenden Service.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingService.type Typ des realisierenden Service.

    Datentyp: Zeichenfolge
    ZugehörigPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array von Objekten

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id SYS_ID des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account], Kontakt [Customer_contact] oder Verbraucher [csm_Consumer]
    RelatedParty.@referredType Typ des Kunden.
    Mögliche Werte:
    • consumer
    • Kunde
    • CustomerContact

    Datentyp: Zeichenfolge
    Staat Aktueller Status des Produkts.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Dieses Beispiel ruft alle Produktbestände ab.

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

    Offene API für Produktbestand – GET /sn_prd_invt/productInventory/{inventoryId} AB

    Ruft einen Produktbestand ab.

    Wichtig:
    Beginnend mit TokyoRelease, dieser Endpunkt ist veraltet. Die neue Version dieses Endpunkts ist Offene API für Produktbestand – GET /sn_prd_invt/Product/{ID} ab.

    URL-Format

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

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfad-Parameter
    Name Beschreibung
    InventoryId SYS_ID des abzurufenden Produktbestands.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    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.

    Datentyp: Zeichenfolge

    Standard: Alle Felder zurückgegeben.
    Ort Filtern Sie Produktbestände nach Ort. In der Antwort werden nur Produktangebote mit einer Place sys_ID oder einer externen ID zurückgegeben, die dem Wert dieses Parameters entspricht.

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

    Datentyp: Zeichenfolge
    Tabelle : 21. Anforderungstext-Parameter (JSON)
    Name Beschreibung
    Keine

    Header

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

    Tabelle : 22. Anforderungskopfzeilen.
    Header Beschreibung
    Keine
    Tabelle : 23. Antwort-Header
    Header Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt application/json.

    Statuscodes

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

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Anforderung erfolgreich verarbeitet.
    400 Ungültige Anforderung. Kann einer der folgenden Gründe sein:
    • Ungültiger Pfadparameter
    • Ungültiger URI
    404 Datensatz nicht gefunden Datensatz, der der ID zugeordnet ist, wurde in der Tabelle nicht gefunden.

    Antworttext-Parameter (JSON)

    Name Beschreibung
    ID SYS_ID des Produktbestands

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    name Name des Produktbestands.

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

    Datentyp: Zeichenfolge
    Produktmerkmal Liste der Produktmerkmale.

    Datentyp: Array von Objekten

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.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"
}
    Produktangebot.ID SYS_ID des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    productOffering.name Name des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    Produktbeziehung Liste der zugehörigen Produkte.

    Datentyp: Array von Objekten

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId SYS_ID des zugehörigen Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    Produktbeziehung.Beziehungstyp Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
  "id": "String"
}
    productSpecification.id SYS_ID der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
    RealizingRessource Ressource wird realisiert.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id SYS_ID der realisierenden Ressource.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingResource.type Typ der realisierenden Ressource.

    Datentyp: Zeichenfolge
    RealizingService Service wird realisiert.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id SYS_ID des realisierenden Service.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingService.type Typ des realisierenden Service.

    Datentyp: Zeichenfolge
    ZugehörigPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array von Objekten

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id SYS_ID des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account], Kontakt [Customer_contact] oder Verbraucher [csm_Consumer]
    RelatedParty.@referredType Typ des Kunden.
    Mögliche Werte:
    • Verbraucher
    • Kunde
    • Kundenkontakt

    Datentyp: Zeichenfolge
    Staat Aktueller Status des Produkts.

    Datentyp: Zeichenfolge

    Curl-Anforderung

    Dieses Beispiel ruft einen Produktbestand für ein SD-WAN-Servicepaket ab.

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

    Offene API für Produktbestand – POST /sn_prd_invt/Product

    Erstellt einen Produktbestandsdatensatz.

    URL-Format

    Standard-URL: /api/sn_prd_invt/Product

    Unterstützte Anforderungsparameter

    Tabelle : 25. Pfad-Parameter
    Name Beschreibung
    Keine
    Tabelle : 26. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 27. Anforderungstext-Parameter (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"
   }
]
    productCharacteristic.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"
}
    Produktangebot.ID Erforderlich. Initial_Version oder external_ID des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    productOffering.internalVersion Version des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
    productOffering.name Name des Produktangebots.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    ProductOffering.Version Externe Version des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
    Produktbeziehung Liste der zugehörigen Produkte.

    Datentyp: Array von Objekten

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId Erforderlich, wenn verwendet wird productRelationshipParameter. SYS_ID des zugehörigen Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    Produktbeziehung.Beziehungstyp Typ der Beziehung.

    Der einzige gültige Wert ist Untergeordnet .

    Datentyp: Zeichenfolge

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

    Datentyp: Objekt

    "productSpecification": {
  "id": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id Erforderlich. Initial_Version oder external_ID der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
    productSpecification.internalVersion Version der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    Produktspezifikation.Version Externe Version der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    RealizingRessource Ressource, die das Produkt realisiert. Die Realisierungsressource ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id Erforderlich, wenn verwendet wird realizingResourceParameter. SYS_ID der realisierenden Ressource.

    Datentyp: Zeichenfolge
    RealizingResource.type Typ der realisierenden Ressource.

    Gültiger Wert: Untergeordnetes Element

    Datentyp: Zeichenfolge
    RealizingService Service, der das Produkt realisiert. Der realisierende Service ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id Erforderlich, wenn verwendet wird realizingServiceParameter. SYS_ID des realisierenden Service.

    Datentyp: Zeichenfolge
    RealizingService.type Typ des realisierenden Service.

    Gültiger Wert: Untergeordnetes Element

    Datentyp: Zeichenfolge
    ZugehörigPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array von Objekten

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id Erforderlich, wenn verwendet wird relatedPartyParameter. SYS_ID des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account], Kontakt [Customer_contact] oder Verbraucher [csm_Consumer]
    RelatedParty.@referredType Typ des Kunden.
    Mögliche Werte:
    • consumer
    • Kunde
    • customer_contact

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Staat Aktueller Status des Produkts.
    Mögliche Werte:
    • aktiv
    • Change_Pending
    • Inaktivierung_ausstehend
    • Inaktiv
    • Installation_ausstehend

    Datentyp: Zeichenfolge

    Standard: Installation_pending

    Header

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

    Tabelle : 28. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 29. Antwort-Header
    Header Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt application/json.

    Statuscodes

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

    Tabelle : 30. Statuscodes
    Statuscode Beschreibung
    201 Anforderung erfolgreich verarbeitet.
    400 Ungültige Anforderung. Kann einer der folgenden Gründe sein:
    • Leere Nutzlast.
    • Ungültige Nutzlast. Pflichtfeld fehlt: <field name>

    Antworttext-Parameter (JSON)

    Name Beschreibung
    href Relativer Link zum Produktbestandsdatensatz.

    Datentyp: Zeichenfolge
    ID SYS_ID des Produktbestands.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    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 von Objekten

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.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"
}
    Produktangebot.ID Anfangsversion oder externe ID des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „initial_Version“ oder „external_ID“ der Tabelle „Produktangebot [sn_prd_pm_product_offering]“.
    productOffering.internalId Anfangsversion des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „internal_Version“ des Produktangebots [sn_prd_pm_product_offering]
    productOffering.internalVersion Version des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
    productOffering.name Name des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    ProductOffering.Version Externe Version des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
    ProductPrice Gibt ein leeres Array zurück.

    Datentyp: Array
    Produktbeziehung Liste der zugehörigen Produkte.

    Datentyp: Array von Objekten

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId SYS_ID des zugehörigen Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    Produktbeziehung.Beziehungstyp Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
  "id": "String",
  "internalId": "String",
  "internalVersion": "String",
  "version": "String"
}
    productSpecification.id Anfangsversion oder externe ID der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „internal_Version“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    productSpecification.internalId Anfangsversion der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „initial_Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    productSpecification.internalVersion Version der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    Produktspezifikation.Version Externe Version der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
    RealizingRessource Ressource, die das Produkt realisiert. Die Realisierungsressource ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id SYS_ID der realisierenden Ressource.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingResource.type Typ der realisierenden Ressource.

    Gültiger Wert: Untergeordnetes Element

    Datentyp: Zeichenfolge
    RealizingService Service, der das Produkt realisiert. Der realisierende Service ist ein untergeordneter Produktbestand dieses Produktbestands.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    realizingService.id SYS_ID des realisierenden Service.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingService.type Typ des realisierenden Service.

    Gültiger Wert: Untergeordnetes Element

    Datentyp: Zeichenfolge
    ZugehörigPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array von Objekten

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    RelatedParty.ID SYS_ID des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account], Kontakt [Customer_contact] oder Verbraucher [csm_Consumer]
    RelatedParty.@referredType Typ des Kunden.
    Mögliche Werte:
    • Verbraucher
    • Kunde
    • Kundenkontakt

    Datentyp: Zeichenfolge
    Staat 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 Anwender 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"
}

    Offene API für Produktbestand – POSTEN SIE /sn_prd_invt/productInventory

    Erstellt einen Produktbestand.

    Wichtig:
    Beginnend mit TokyoRelease, dieser Endpunkt ist veraltet. Die neue Version dieses Endpunkts ist Offene API für Produktbestand – POST /sn_prd_invt/Product.

    URL-Format

    Standard-URL: /api/sn_prd_invt/productInventory

    Unterstützte Anforderungsparameter

    Tabelle : 31. Pfad-Parameter
    Name Beschreibung
    Keine
    Tabelle : 32. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 33. Anforderungstext-Parameter (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"
   }
]
    productCharacteristic.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"
}
    Produktangebot.ID Erforderlich. SYS_ID des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    productOffering.name Name des Produktangebots.

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    Produktbeziehung Liste der zugehörigen Produkte.

    Datentyp: Array von Objekten

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId Erforderlich, wenn verwendet wird productRelationshipParameter. SYS_ID des zugehörigen Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    Produktbeziehung.Beziehungstyp Typ der Beziehung.

    Der einzige gültige Wert ist Untergeordnet .

    Datentyp: Zeichenfolge

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

    Datentyp: Objekt

    "productSpecification": {
  "id": "String"
}
    productSpecification.id Erforderlich. SYS_ID der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
    RealizingRessource Ressource wird realisiert.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    realizingResource.id Erforderlich, wenn verwendet wird realizingResourceParameter. SYS_ID der realisierenden Ressource.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingResource.type Typ der realisierenden Ressource.

    Der einzige gültige Wert ist Untergeordnet .

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    RealizingService Service wird realisiert.

    Datentyp: Objekt

    "realizingService": {
      "id": "String",
      "type": "String"
}
    realizingService.id Erforderlich, wenn verwendet wird realizingServiceParameter. SYS_ID des realisierenden Service.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingService.type Typ des realisierenden Service.

    Der einzige gültige Wert ist Untergeordnet .

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    ZugehörigPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array von Objekten

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    relatedParty.id Erforderlich, wenn verwendet wird relatedPartyParameter. SYS_ID des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account], Kontakt [Customer_contact] oder Verbraucher [csm_Consumer]
    RelatedParty.@referredType Typ des Kunden.
    Mögliche Werte:
    • consumer
    • Kunde
    • customer_contact

    Datentyp: Zeichenfolge

    Standard: Leere Zeichenfolge
    Staat Aktueller Status des Produkts.
    Mögliche Werte:
    • aktiv
    • Change_Pending
    • Inaktivierung_ausstehend
    • Inaktiv
    • Installation_ausstehend

    Datentyp: Zeichenfolge

    Standard: Installation_pending

    Header

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

    Tabelle : 34. Anforderungskopfzeilen.
    Header Beschreibung
    Akzeptieren Datenformat des Antworttexts. Nur unterstützt application/json.
    Inhaltstyp Datenformat des Anforderungstexts. Nur unterstützt application/json.
    Tabelle : 35. Antwort-Header
    Header Beschreibung
    Inhaltstyp Datenformat des Antworttexts. Nur unterstützt application/json.

    Statuscodes

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

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

    Antworttext-Parameter (JSON)

    Name Beschreibung
    ID SYS_ID des Produktbestands.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    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 von Objekten

    "productCharacteristic": [
  {
    "name": "String",
    "value": "String"
  }
]
    productCharacteristic.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"
}
    Produktangebot.ID SYS_ID des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    productOffering.name Name des Produktangebots.

    Datentyp: Zeichenfolge

    Tabelle: Produktangebot [sn_prd_pm_product_offering]
    Produktbeziehung Liste der zugehörigen Produkte.

    Datentyp: Array von Objekten

    "productRelationship": [
  {
    "productId": "String",
    "relationshipType": "String"
  }
]
    productRelationship.productId SYS_ID des zugehörigen Produkts.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    Produktbeziehung.Beziehungstyp Typ der Beziehung.

    Datentyp: Zeichenfolge
    Produktspezifikation Produktspezifikation für das Produkt.

    Datentyp: Objekt

    "productSpecification": {
  "id": "String"
}
    Produktspezifikation.ID SYS_ID der Produktspezifikation.

    Datentyp: Zeichenfolge

    Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
    RealizingRessource Ressource wird realisiert.

    Datentyp: Objekt

    "realizingResource": {
  "id": "String",
  "type": "String"
}
    RealizingResource.ID SYS_ID der realisierenden Ressource

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingResource.type Typ der realisierenden Ressource.

    Datentyp: Zeichenfolge
    RealizingService Service wird realisiert.

    Datentyp: Objekt

    "realizingService": {
  "id": "String",
  "type": "String"
}
    RealizingService.ID SYS_ID des realisierenden Service.

    Datentyp: Zeichenfolge

    Tabelle: Produktbestand [sn_prd_invt_product_inventory]
    RealizingService.type Typ des realisierenden Service.

    Datentyp: Zeichenfolge
    ZugehörigPartei Liste der Parteien, die dem Ticket zugeordnet sind.

    Datentyp: Array von Objekten

    "relatedParty": [
  {
    "id": "String",
    "@referredType": "String"
  }
]
    RelatedParty.ID SYS_ID des Accounts oder Kundenkontakts, der dem Ticket zugeordnet ist.

    Datentyp: Zeichenfolge

    Tabelle: Account [Customer_Account], Kontakt [Customer_contact] oder Verbraucher [csm_Consumer]
    RelatedParty.@referredType Typ des Kunden.
    Mögliche Werte:
    • Verbraucher
    • Kunde
    • Kundenkontakt

    Datentyp: Zeichenfolge
    Staat 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 Anwender 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"
}