Produktbestand – API öffnen
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 ServiceNow AI 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.
- 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 TM Forum-API für Produktbestandsmanagement. Diese Implementierung basiert auf TMF637 API für Produktbestandsmanagement – REST-Spezifikation Release 19 , August 2019. Die Produktbestand Offen API ist vom TM-Forum zertifiziert.
Produktbestand – API öffnen – GET /sn_prd_invt/Product
Ruft eine Liste aller Produktbestände ab.
URL-Format
Standard-URL: api/sn_prd_invt/Product
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| 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 der zurückzugebenden 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 Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Datentyp: Zahl Standard: 0 |
| Ort | Filtern Sie Produktbestände nach Standort. Datentyp: Objekt |
| place.id | SYS_ID oder external_ID des Standorts, der dem Produktbestandsdatensatz zugeordnet ist. Tabelle: Standort [cmn_location] 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 Standard: Nicht nach Status filtern. |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltsbereich | Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn |
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
|
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung). |
| 206 | Teilressource als Antwort zurückgegeben (mit Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 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. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_Product_Inventory] |
| name | Name des Produktbestands. Datentyp: Zeichenfolge |
| Ort | Ort, der dem Produkt zugeordnet ist. Datentyp: Objekt |
| place.id | Sys_ID oder external_ID des Standorts des Produktbestands. Tabelle: Standort [cmn_location] Daten: Zeichenfolge |
| place.name | Name des Standorts, der dem Produktbestand zugeordnet ist. Tabelle: Standort [cmn_location] Daten: Zeichenfolge |
| Produktmerkmal | Liste der Produktmerkmale. Weitere Informationen zu Produktmerkmalen finden Sie unter Create a product offering category. Datentyp: Array von Objekten |
| productCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.WertTyp | Typ des Merkmalwerts. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| productOffering | Produktangebot, dem der Produktbestand zugeordnet ist. Datentyp: Objekt |
| productOffering.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] |
| Produktangebot.Version | Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktpreis | Gibt ein leeres Array zurück. Datentyp: Array |
| Produktbeziehung | Liste der zugehörigen Produkte. Datentyp: Array von Objekten |
| 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 | 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 | 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 | 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örige Partei | Liste der Parteien, die dem Ticket zugeordnet sind. Datentyp: Array von Objekten |
| 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:
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."
}
]
Produktbestand – API öffnen – GET /sn_prd_invt/Product/{ID}
Ruft einen angegebenen Produktbestandsdatensatz ab.
URL-Format
Standard-URL: /api/sn_prd_invt/Product/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID des abzurufenden Produktbestands. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_Product_Inventory] |
| 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 Standort. Datentyp: Objekt |
| place.id | SYS_ID oder external_ID des Standorts, der dem Produktbestandsdatensatz zugeordnet ist. Tabelle: Standort [cmn_location] 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 Standard: Nicht nach Status filtern. |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
| 404 | Datensatz nicht gefunden Der der ID zugeordnete Datensatz wurde in der Tabelle nicht gefunden. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Abrechnungsaccount | Abrechnungskonto des Produktbestandsdatensatzes. Datentyp: Zeichenfolge |
| 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: Objekt |
| place.id | Sys_ID oder external_ID des Standorts des Produktbestands. Tabelle: Standort [cmn_location] Daten: Zeichenfolge |
| place.name | Name des Standorts, der dem Produktbestand zugeordnet ist. Tabelle: Standort [cmn_location] Daten: Zeichenfolge |
| Produktmerkmal | Liste der Produktmerkmale. Weitere Informationen zu Produktmerkmalen finden Sie unter Create a product offering category. Datentyp: Array von Objekten |
| productCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.WertTyp | Typ des Merkmalwerts. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| productOffering | Produktangebot, dem der Produktbestand zugeordnet ist. Datentyp: Objekt |
| productOffering.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] |
| Produktangebot.Version | Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktpreis | Gibt ein leeres Array zurück. Datentyp: Array |
| Produktbeziehung | Liste der zugehörigen Produkte. Datentyp: Array von Objekten |
| 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 | 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 | 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 | 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örige Partei | Liste der Parteien, die dem Ticket zugeordnet sind. Datentyp: Array von Objekten |
| 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] |
| ZugehörigPartei.Typ | Typ der zugehörigen Partei. Wert ist immer Zugehörige Partei .Datentyp: Zeichenfolge |
| RelatedParty.@referredType | Typ des Kunden, z. B. ein Kunde oder ein Kundenkontakt. 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."
}
Produktbestand – API öffnen – GET /sn_prd_invt/productInventory ab
Ruft eine Liste aller Produktbestände ab.
URL-Format
Standard-URL: api/sn_prd_invt/productInventory
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| 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 der zurückzugebenden 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 Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Datentyp: Zahl Standard: 0 |
| Ort | Filtern Sie Produktbestände nach Standort. Datentyp: Objekt |
| place.id | SYS_ID oder external_ID des Standorts, der dem Produktbestandsdatensatz zugeordnet ist. Tabelle: Standort [cmn_location] 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 Standard: Nicht nach Bestandsstatus filtern. |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltsbereich | Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn |
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
|
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung). |
| 206 | Teilressource als Antwort zurückgegeben (mit Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 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. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_Product_Inventory] |
| name | Name des Produktbestands. Datentyp: Zeichenfolge |
| Ort | Ort, der dem Produkt zugeordnet ist. Datentyp: Objekt |
| place.id | Sys_ID oder external_ID des Standorts des Produktbestands. Tabelle: Standort [cmn_location] Daten: Zeichenfolge |
| place.name | Name des Standorts, der dem Produktbestand zugeordnet ist. Tabelle: Standort [cmn_location] Daten: Zeichenfolge |
| Produktmerkmal | Liste der Produktmerkmale. Weitere Informationen zu Produktmerkmalen finden Sie unter Create a product offering category. Datentyp: Array von Objekten |
| productCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.WertTyp | Typ des Merkmalwerts. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| productOffering | Produktangebot, dem der Produktbestand zugeordnet ist. Datentyp: Objekt |
| productOffering.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 | 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 | SYS_ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| RealizingRessource | Ressource wird realisiert. Datentyp: Objekt |
| 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 | SYS_ID des realisierenden Service. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_Product_Inventory] |
| RealizingService.type | Typ des realisierenden Service. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Parteien, die dem Ticket zugeordnet sind. Datentyp: Array von Objekten |
| 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 der zugehörigen Partei. Wert ist immer Zugehörige Partei .Datentyp: Zeichenfolge |
| ZugehörigPartei.Typ | Typ des Kunden. Mögliche Werte:
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"
}
]
}
]
Produktbestand – API öffnen – GET /sn_prd_invt/productInventory/{inventoryId}
Ruft einen Produktbestand ab.
URL-Format
Standard-URL: /api/sn_prd_invt/productInventory/{inventoryId}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| InventoryId | SYS_ID des abzurufenden Produktbestands. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_Product_Inventory] |
| 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 Standort. Datentyp: Objekt |
| place.id | SYS_ID oder external_ID des Standorts, der dem Produktbestandsdatensatz zugeordnet ist. Tabelle: Standort [cmn_location] 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 |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Keine |
| Kopfzeile | 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 .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
| 404 | Datensatz nicht gefunden Der der ID zugeordnete Datensatz wurde in der Tabelle nicht gefunden. |
Parameter des Antwort-Haupttexts (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: Objekt |
| place.id | Sys_ID oder external_ID des Standorts des Produktbestands. Tabelle: Standort [cmn_location] Daten: Zeichenfolge |
| place.name | Name des Standorts, der dem Produktbestand zugeordnet ist. Tabelle: Standort [cmn_location] Daten: Zeichenfolge |
| Produktmerkmal | Liste der Produktmerkmale. Weitere Informationen zu Produktmerkmalen finden Sie unter Create a product offering category. Datentyp: Array von Objekten |
| productCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.WertTyp | Typ des Merkmalwerts. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| productOffering | Produktangebot, dem der Produktbestand zugeordnet ist. Datentyp: Objekt |
| productOffering.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 | 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 | SYS_ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| RealizingRessource | Ressource wird realisiert. Datentyp: Objekt |
| 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 | SYS_ID des realisierenden Service. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_Product_Inventory] |
| RealizingService.type | Typ des realisierenden Service. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Parteien, die dem Ticket zugeordnet sind. Datentyp: Array von Objekten |
| 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 der zugehörigen Partei. Wert ist immer Zugehörige Partei .Datentyp: Zeichenfolge |
| ZugehörigPartei.Typ | Typ des Kunden. Mögliche Werte:
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": []
}
Produktbestand – API öffnen – POST /sn_prd_invt/Product
Erstellt einen Produktbestandsdatensatz.
URL-Format
Standard-URL: /api/sn_prd_invt/Product
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Gruppe | Kennzeichnung, die angibt, ob der Produktbestandsdatensatz Teil eines gebündelten Produkts ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| IsBundle | Kennzeichnung, die angibt, ob der Produktbestandsdatensatz Teil eines gebündelten Produkts ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| 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. Weitere Informationen zu Produktmerkmalen finden Sie unter Create a product offering category. Datentyp: Array von Objekten |
| productCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Produktmerkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Produktmerkmal.WertTyp | Typ des Merkmalwerts. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| productOffering | Erforderlich. Produktangebot, dem der Produktbestand zugeordnet ist. Datentyp: Objekt |
| productOffering.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] |
| Produktangebot.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 | 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 | 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 | 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 | 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örige Partei | Liste der Parteien, die dem Ticket zugeordnet sind. Datentyp: Array von Objekten |
| RelatedParty.@referredType | Typ des Kunden. Mögliche Werte:
Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| 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] |
| Status | Aktueller Status des Produkts. Mögliche Werte:
Datentyp: Zeichenfolge Standard: Installation_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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | 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 .
| Statuscode | Beschreibung |
|---|---|
| 201 | Anforderung erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Gruppe | Kennzeichnung, die angibt, ob der Produktbestandsdatensatz Teil eines gebündelten Produkts ist. Gültige Werte:
Datentyp: Boolesch |
| href | Relativer Link zum Produktbestandsdatensatz. Datentyp: Zeichenfolge |
| id | SYS_ID des Produktbestands. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_Product_Inventory] |
| IsBundle | Kennzeichnung, die angibt, ob der Produktbestandsdatensatz Teil eines gebündelten Produkts ist. Gültige Werte:
Datentyp: Boolesch |
| 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 | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| productOffering | Produktangebot, dem der Produktbestand zugeordnet ist. Datentyp: Objekt |
| productOffering.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] |
| Produktangebot.Version | Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktpreis | Gibt ein leeres Array zurück. Datentyp: Array |
| Produktbeziehung | Liste der zugehörigen Produkte. Datentyp: Array von Objekten |
| 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 | 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 | 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 | 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örige Partei | Liste der Parteien, die dem Ticket zugeordnet sind. Datentyp: Array von Objekten |
| RelatedParty.@referredType | Typ der zugehörigen Partei. Wert ist immer Zugehörige Partei .Datentyp: Zeichenfolge |
| ZugehörigPartei.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] |
| ZugehörigPartei.Typ | Typ des Kunden. Mögliche Werte:
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 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"
}
Produktbestand – API öffnen – POST /sn_prd_invt/productInventory
Erstellt einen Produktbestand.
URL-Format
Standard-URL: /api/sn_prd_invt/productInventory
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| IsBundle | Kennzeichnung, die angibt, ob der Produktbestandsdatensatz Teil eines gebündelten Produkts ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| 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. Weitere Informationen zu Produktmerkmalen finden Sie unter Create a product offering category. Datentyp: Array von Objekten |
| productCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Produktmerkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Produktmerkmal.WertTyp | Typ des Merkmalwerts. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| productOffering | Erforderlich. Produktangebot, dem der Produktbestand zugeordnet ist. Datentyp: Objekt |
| productOffering.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 | 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 | Erforderlich. SYS_ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| RealizingRessource | Ressource wird realisiert. Datentyp: Objekt |
| 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 | 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örige Partei | Liste der Parteien, die dem Ticket zugeordnet sind. Datentyp: Array von Objekten |
| RelatedParty.@referredType | Typ des Kunden. Mögliche Werte:
Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| 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] |
| Status | Aktueller Status des Produkts. Mögliche Werte:
Datentyp: Zeichenfolge Standard: Installation_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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | 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 .
| Statuscode | Beschreibung |
|---|---|
| 201 | Anforderung erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| id | SYS_ID des Produktbestands. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_Product_Inventory] |
| IsBundle | Kennzeichnung, die angibt, ob der Produktbestandsdatensatz Teil eines gebündelten Produkts ist. Gültige Werte:
Datentyp: Boolesch |
| 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 | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| productOffering | Produktangebot, dem der Produktbestand zugeordnet ist. Datentyp: Objekt |
| 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 | 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 |
| Produktspezifikation.ID | SYS_ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| RealizingRessource | Ressource wird realisiert. Datentyp: Objekt |
| 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 | SYS_ID des realisierenden Service. Datentyp: Zeichenfolge Tabelle: Produktbestand [sn_prd_invt_Product_Inventory] |
| RealizingService.type | Typ des realisierenden Service. Datentyp: Zeichenfolge |
| Zugehörige Partei | Liste der Parteien, die dem Ticket zugeordnet sind. Datentyp: Array von Objekten |
| ZugehörigPartei.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:
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 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"
}