Produktkatalog Open API

Open API für den Produktkatalog – DELETE /sn_tmf_api/catalogmanagement/productOffering/{id}

Löscht das angegebene Produktangebot.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productOffering/{id}

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
id	Sys_id des zu löschenden Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]

Tabelle : 2. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

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

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
Nachricht	Eine Fehler- oder Erfolgsmeldung zum Löschen oder Archivieren der Produktspezifikation.

cURL-Anforderung

Im folgenden Beispiel wird das Produktangebot mit der ID d6f8d9995b020210235d85cced81c7eb gelöscht.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb" \ 
--request DELETE\ 
--header "Accept:application/json" \ 
--user 'username':'password'

Der Antworttext gibt eine Erfolgsmeldung zum Löschen von zurück:

"The product offering (d6f8d9995b020210235d85cced81c7eb) is successfully deleted"

Open API für den Produktkatalog – DELETE /sn_tmf_api/catalogmanagement/productOfferingPrice/{id}

Deaktiviert eine Preislistenposition mit einer bestimmten sys_id, löscht sie jedoch nicht.

Um eine Preislistenposition in einen inaktiven Status zu versetzen, aktualisiert diese LÖSCHEN-Methode das Enddatum der Preislistenposition auf das heutige Datum. Eine Preislistenposition mit einem Enddatum vor dem heutigen Datum gilt ebenfalls als inaktiv. Inaktive Preislistenpositionen können in zugehörigen GET-Methoden nicht abgerufen werden.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/{id}

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
id	Sys_id der zu löschenden Preislistenposition. Tabelle: Preislistenposition [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 9. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

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

Tabelle : 11. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
Nachricht	Statuscode mit einer Nachricht über die erfolgreiche oder fehlgeschlagene Deaktivierung der Preislistenposition.

cURL-Anforderung

Das folgende Beispiel zeigt, wie Sie eine Preisliste der angegebenen sys_id, 994d... erfolgreich deaktivieren oder löschen.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
--request DELETE\
--user 'username':'password'

Antwort Die Antwort gibt den Statuscode 200 mit Details zur erfolgreichen Deaktivierung zurück.

Status: 200 OK
"The price list line (994d5d364f8b5210f899f61d20ce0b7c) is inactive successfully"

Open API für den Produktkatalog – DELETE /sn_tmf_api/catalogmanagement/productSpecification/{id}

Löscht oder archiviert die angegebene Produktspezifikation.

Beim Aufrufen dieser DELETE-Methode kann eine Produktspezifikation je nach Status entweder gelöscht oder archiviert werden:

Eine Produktspezifikation im Entwurfsstatus wurde erfolgreich gelöscht. Als Antwort gibt eine Erfolgsmeldung zurück.
Eine Produktspezifikation im Status „Archiviert“ kann nicht gelöscht werden. Die Antwort gibt eine Nachricht zurück, dass die Spezifikation bereits archiviert wurde.
Eine Produktspezifikation, die sich nicht im Entwurfsstatus befindet und anderen Produktspezifikationen oder Angeboten zugeordnet ist, wird archiviert, aber nicht gelöscht. Die Antwort gibt eine Nachricht zurück, dass die Spezifikation von einem aktiven Status in einen archivierten Status verschoben wird.
Eine Produktspezifikation, die einer aktiven Produktspezifikation oder einem aktiven Angebot zugeordnet ist, kann nicht gelöscht werden. Die Antwort gibt eine Fehlermeldung aus.

URL-Format

Standard-URL: /sn_tmf_api/catalogmanagement/productSpecification/{id}

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
id	Sys_id der zu löschenden Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

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

Tabelle : 17. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
Nachricht	Eine Fehler- oder Erfolgsmeldung zum Löschen oder Archivieren der Produktspezifikation.

cURL-Anforderung

Im folgenden Beispiel wird die Produktspezifikation mit der ID 8ef57fa05b308210235d85cced81c7d8 gelöscht.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/8ef57fa05b308210235d85cced81c7d8" \ 
--request DELETE\ 
--header "Accept:application/json" \ 
--user 'username':'password'

Der Antworttext gibt eine Erfolgs- oder Fehlermeldung zurück:

"The product specification (8ef57fa05b308210235d85cced81c7d8) is successfully deleted"

Produktkatalog – Open API: GET /sn_tmf_api/catalogmanagement/catalog

Ruft eine Liste aller Produktangebotskataloge ab.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/catalog

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 20. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Datentyp: Zeichenfolge Standard: Alle zurückgegebenen Felder.
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Standard: 20 Maximum: 100
Offset	Startindex, ab 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

Tabelle : 21. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 22. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 23. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` und `Limit=3`, ist der Wert des Content-Range -Headers `Elemente 3-5`.
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter vorheriger
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 HTTP-Antwortcodes der REST-API.

Tabelle : 24. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
description	Beschreibung des Produktangebotskatalogs. Datentyp: Zeichenfolge
id	Sys_id des Produktangebotkatalogs Datentyp: Zeichenfolge Tabelle: Produktangebotskatalog [sn_prd_pm_product_offering_catalog]
name	Name des Produktangebotskatalogs. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden alle Produktangebotskataloge abgerufen.

curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
--user 'username':'password'

Antworttext.

[
    {
        "id": "SD-WAN1344314wrfw14345",
        "name": "New Catalog",
        "description": "New Catalog"
    },
    {
        "id": "9919291ac34c20105252716b7d40dd0f",
        "name": "Enterprise Mobile Plan",
        "description": " Product Catalog for Enterprise Mobile Plan"
    }
]

Offene Produktkatalog-API – GET /sn_tmf_api/catalogmanagement/catalog/{id}

Ruft einen Produktangebotskatalog ab.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/catalog/{id}

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter
Name	Beschreibung
id	Sys_id des abzurufenden Produktangebotkatalogs. Datentyp: Zeichenfolge Tabelle: Produktangebotskatalog [sn_prd_pm_product_offering_catalog]

Tabelle : 26. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Datentyp: Zeichenfolge Standard: Alle Felder.

Tabelle : 27. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 28. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

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

Statuscodes

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

Tabelle : 30. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Kann einer der folgenden Gründe sein: Ungültiger Pfadparameter Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
description	Beschreibung des Produktangebotskatalogs. Datentyp: Zeichenfolge
id	Sys_id des Produktangebotkatalogs Datentyp: Zeichenfolge Tabelle: Produktangebotskatalog [sn_prd_pm_product_offering_catalog]
name	Name des Produktangebotskatalogs. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Produktangebotskatalog für einen Enterprise-Mobilfunktarif abgerufen.

curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog/9919291ac34c20105252716b7d40dd0f" \
--user 'username':'password'

Antworttext.

{
   "id": "9919291ac34c20105252716b7d40dd0f",
   "name": "Enterprise Mobile Plan",
   "description": " Product Catalog for Enterprise Mobile Plan"
}

Open API des Produktkatalogs – GET /sn_tmf_api/catalogmanagement/productOffering

Ruft alle Produktangebote ab.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productOffering

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 32. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: Kategorie Kanal description externalId id internalId internalVersion lastUpdate name Produktmerkmal Produktangebotspreis Produktangebotslaufzeit Produktspezifikation prodSpecCharValueUse validFor version Datentyp: Zeichenfolge Standard: Es werden alle Felder zurückgegeben.
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Standard: 20 Maximum: 100
Offset	Startindex, ab 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
Spezifikation	Filtern Sie Produktangebote nach der sys_id der Produktspezifikation. In der Antwort werden nur Produktangebote mit der angegebenen Produktspezifikation-sys_id zurückgegeben. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
state	Filtern Sie Produktangebote nach Status. In der Antwort werden nur Produktangebote im angegebenen Status zurückgegeben. Gültige Werte: archiviert Entwurf Veröffentlicht Deaktiviert Datentyp: Zeichenfolge

Tabelle : 33. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 34. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 35. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` und `Limit=3`, ist der Wert des Content-Range -Headers `Elemente 3-5`.
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter vorheriger
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 HTTP-Antwortcodes der REST-API.

Tabelle : 36. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Kategorie	Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten `"category:" [ { "id": "String", "name": "String" } ]`
kategorie.id	ID der Kategorie Datentyp: Zeichenfolge
kategorie.name	Name der Kategorie. Datentyp: Zeichenfolge
Kanal	Kanäle für den Verkauf des Produktangebots. Datentyp: Array von Objekten `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Kanalbeschreibung	Beschreibung des Kanals. Datentyp: Zeichenfolge
channel.id	Sys_id des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_distribution_channel]
Kanalname	Name des Kanals Datentyp: Zeichenfolge
description	Beschreibung des Produktangebots. Datentyp: Zeichenfolge
externalId	Externe ID des Produktangebots Datentyp: Zeichenfolge Tabelle: Im Feld external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Erforderlich. Anfangsversion oder externe ID des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalId	Anfangsversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
lastUpdate	Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
LifecycleStatus	Aktueller Lebenszyklusstatus des Produktangebots. Gültige Werte: Aktiv Entwurf Inaktiv Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
name	Name des Produktangebots Datentyp: Zeichenfolge
Produktmerkmal	Liste der Produkteigenschaften. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "value": "String" } ]`
productCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
Produktmerkmal.Wert	Wert des Merkmals. Datentyp: Zeichenfolge
Produktangebotspreis	Preisinformationen für das Produktangebot. Datentyp: Array von Objekten `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
ProduktAngebotsPreis.Preis	Preisinformationen für das Produktangebot. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag	Preisinformationen für das Produktangebot. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": "String" }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Wert	Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge
ProduktangebotPreis.PreisTyp	Art des Produktangebotspreises, einmalige oder wiederkehrende Zahlung. Gültige Werte: nicht wiederkehrend (einmal) recurring Datentyp: Zeichenfolge
Produktangebotslaufzeit	Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge
Produktspezifikation	Produktspezifikation für das Produkt. Datentyp: Objekt `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.interneID	Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.Version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
prodSpecCharValueUse	Merkmale des Produktangebots. Datentyp: Array von Objekten `"prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue	Mögliche Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.name	Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
prodSpecCharValueUse.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.valueType	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“.
validFor	Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum des Produktangebots. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum des Produktangebots. Datentyp: Zeichenfolge
version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]

cURL-Anforderung

In diesem Beispiel werden alle -Produktangebote abgerufen.

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

Antworttext:

[
   {
      "id": "24413",
      "name": "Premium SD-WAN Offering New",
      "version": "",
      "internalVersion": "1",
      "internalId": "0199f8e65b430110235d85cced81c7d2",
      "description": "Premium SD-WAN Offering",
      "lastUpdate": "2022-01-27 05:41:16",
      "validFor": {
         "startDateTime": "2021-08-05",
         "endDateTime": "2026-09-04"
      },
      "productOfferingTerm": "not_applicable",
      "productOfferingPrice": [
         {
            "priceType": "recurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "JPY",
                  "value": 984.0913
               }
            }
         },
         {
            "priceType": "nonRecurring",
            "price": {
               "taxIncludedAmount": {
                  "unit": "GBP",
                  "value": 2434
               }
            }
         }
      ],
      "productSpecification": {
         "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
         "name": "SD-WAN Service Package",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
      },
      "prodSpecCharValueUse": [
         {
            "name": "Routing",
            "description": "Routing",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:08:20"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "WAN Optimization",
            "description": "WAN Optimization",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:10:28"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "CPE Model",
            "description": "CPE Model",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:54"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "ISR",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "ASR",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Security Type",
            "description": "Security Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-30 12:51:13"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Premium",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Advance",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "a6514bd3534560102f18ddeeff7b1247",
               "name": "SD-WAN Security",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "a6514bd3534560102f18ddeeff7b1247"
            }
         },
         {
            "name": "CPE Type",
            "description": "CPE Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:11:16"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Virtual",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Physical",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "39b627aa53702010cd6dddeeff7b1202",
               "name": "SD-WAN Edge Device",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "39b627aa53702010cd6dddeeff7b1202"
            }
         },
         {
            "name": "Tenancy",
            "description": "Tenancy",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2021-12-15 21:04:24"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Advance (50 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Base (10 site)",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium (>50 sites)",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ],
            "productSpecification": {
               "id": "216663aa53702010cd6dddeeff7b12b5",
               "name": "SD-WAN Controller",
               "version": "v1",
               "internalVersion": "1",
               "internalId": "216663aa53702010cd6dddeeff7b12b5"
            }
         }
      ],
      "channel": [
         {
            "id": "e561aae4c3e710105252716b7d40dd8f",
            "name": "Web"
         }
      ],
      "category": {
         "id": "c0ed043653b02010cd6dddeeff7b1277",
         "name": "SD-WAN"
      }
   }
]

Open API für den Produktkatalog – GET /sn_tmf_api/catalogmanagement/productOffering/{id}

Ruft ein Produktangebot ab.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productOffering/{id}

Unterstützte Anforderungsparameter

Tabelle : 37. Pfadparameter
Name	Beschreibung
id	Anfangsversion des abzurufenden Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].

Tabelle : 38. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: Kategorie Kanal description externalId id internalId internalVersion lastUpdate name Produktmerkmal Produktangebotspreis Produktangebotslaufzeit Produktspezifikation prodSpecCharValueUse validFor version Datentyp: Zeichenfolge Standard: Es werden alle Felder zurückgegeben.
Spezifikation	Filtern Sie Produktangebote nach der sys_id der Produktspezifikation. In der Antwort werden nur Produktangebote mit der angegebenen Produktspezifikation-sys_id zurückgegeben. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
state	Filtern Sie Produktangebote nach Status. In der Antwort werden nur Produktangebote im angegebenen Status zurückgegeben. Gültige Werte: archiviert Entwurf Veröffentlicht Deaktiviert Datentyp: Zeichenfolge

Tabelle : 39. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 40. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 41. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 42. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Kategorie	Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten `"category:" [ { "id": "String", "name": "String" } ]`
kategorie.id	ID der Kategorie Datentyp: Zeichenfolge
kategorie.name	Name der Kategorie. Datentyp: Zeichenfolge
Kanal	Kanäle für den Verkauf des Produktangebots. Datentyp: Array von Objekten `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Kanalbeschreibung	Beschreibung des Kanals. Datentyp: Zeichenfolge
channel.id	Sys_id des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_distribution_channel]
Kanalname	Name des Kanals Datentyp: Zeichenfolge
description	Beschreibung des Produktangebots. Datentyp: Zeichenfolge
externalId	Externe ID des Produktangebots Datentyp: Zeichenfolge Tabelle: Im Feld external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Erforderlich. Anfangsversion oder externe ID des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalId	Anfangsversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
lastUpdate	Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
LifecycleStatus	Gibt den aktuellen Lebenszyklusstatus des Produktangebots an. Akzeptierte Werte: Aktiv Inaktiv Entwurf Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
name	Name des Produktangebots Datentyp: Zeichenfolge
Produktmerkmal	Liste der Produkteigenschaften. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "value": "String" } ]`
productCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
Produktmerkmal.Wert	Wert des Merkmals. Datentyp: Zeichenfolge
Produktangebotspreis	Preisinformationen für das Produktangebot. Datentyp: Array von Objekten `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
ProduktAngebotsPreis.Preis	Preisinformationen für das Produktangebot. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag	Preisinformationen für das Produktangebot. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": "String" }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Wert	Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge
ProduktangebotPreis.PreisTyp	Gibt an, ob der Produktangebotspreis eine einmalige oder wiederkehrende Zahlung ist. Gültige Werte: nicht wiederkehrend recurring Datentyp: Zeichenfolge
Produktangebotslaufzeit	Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge
Produktspezifikation	Produktspezifikation für das Produkt. Datentyp: Objekt `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.interneID	Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.Version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
prodSpecCharValueUse	Produktangebotsmerkmal. Datentyp: Array von Objekten `"prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.name	Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
prodSpecCharValueUse.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.valueType	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
validFor	Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum des Produktangebots. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum des Produktangebots. Datentyp: Zeichenfolge
version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]

cURL-Anforderung

In diesem Beispiel wird ein Produktangebot abgerufen.

curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering/24413" \
--user 'username':'password'

Antworttext:

{
   "id": "24413",
   "name": "Premium SD-WAN Offering New",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2022-01-27 05:41:16",
   "version": "",
   "internalVersion": "2",
   "internalId": "69017a0f536520103b6bddeeff7b127d",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "not_applicable",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v2",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-30 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "abc",
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "",
            "internalVersion": "2",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-12-15 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}

Open API für den Produktkatalog – GET /sn_tmf_api/catalogmanagement/productOfferingPrice

Ruft alle Preislistenpositionsdatensätze in der Instanz ab.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice

Unterstützte Anforderungsparameter

Tabelle : 43. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 44. Abfrageparameter
Name	Beschreibung
lastUpdate	Filtern Sie Ergebnisse nach dem Datum, an dem die Preiszeile zuletzt aktualisiert wurde. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge
name	Filtern Sie Preislistenpositionen, die zum Namen einer bestimmten Preisliste gehören. Tabelle: Preislisten [sn_csm_ Pricing_Price_list] Datentyp: Zeichenfolge
Preis.Wert	Filtern Sie Ergebnisse nach einem bestimmten Listenpreiswert. Datentyp: Zeichenfolge
priceList.id	Filtern Sie Ergebnisse, um nur eine Preisliste mit einer bestimmten sys_id zurückzugeben. Tabelle: Preislisten [sn_csm_ Pricing_Price_list] Datentyp: Zeichenfolge
PriceType	Filtern Sie Ergebnisse nach der Preisgestaltungsmethode des Produktangebots. Gültige Werte: recurring: Ermöglicht Unternehmen, wiederkehrende Preisbeträge mit einer angegebenen Häufigkeit zu berechnen. one_time: Unterstützt einmalige oder wiederkehrende Zusatzgebühren und Gebühren für ein Produktangebot. Datentyp: Zeichenfolge
productOffering.id	Filtern Sie die Preislistenzeile nach der sys_id des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_product_offering] Datentyp: Zeichenfolge
unitOfMeasure.id	Filtern Sie die Preislistenzeile nach der sys_id der Maßeinheit. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
validFor.endDateTime	Filtern Sie die Preislistenposition nach einem bestimmten Enddatum und einer bestimmten Enduhrzeit. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge
validFor.startDateTime	Filtern Sie die Preislistenposition nach einem bestimmten Startdatum und einer bestimmten Startuhrzeit. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge

Tabelle : 45. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 46. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 47. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 48. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
@type	Typ der Preislistenposition. Immer ein Wert von `ProductOfferingPrice`. Datentyp: Zeichenfolge
href	URL zum Datensatz der Preislistenposition in der Instanz. Datentyp: Zeichenfolge
id	Sys_id der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
isBündel	Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktbündels ist. Gültige Werte: wahr: Preislistenposition ist Teil eines Pakets. false: Preislistenposition ist nicht Teil eines Pakets. Datentyp: Boolesch
lastUpdate	Datum und Uhrzeit der letzten Aktualisierung der Preislistenposition. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge
LifecycleStatus	Aktueller Lebenszyklusstatus der Preislistenposition. Gültige Werte: Aktiv Entwurf Inaktiv Datentyp: Zeichenfolge
Preis	Listenpreisdetails der Preislistenposition. Datentyp: Objekt `"price": { "units": "String", "value": "String" }`
Preis.Einheiten	Währungscode des Preises. Zum Beispiel `USD` oder `EUR`. Tabelle: Währung [fx_currency] Datentyp: Zeichenfolge
Preis.Wert	Wert des Preises. Datentyp: Zeichenfolge (dargestellt durch eine Zahl)
priceList	Preislisteninformationen, die der Preislistenposition zugeordnet sind. Datentyp: Objekt `"priceList": { "id": "String", "name": "String", "@type": "String" }`
PriceList.ID	Sys_id der Preisliste in der Tabelle „Preisliste“ [sn_csm_pricing_Price_list] Datentyp: Zeichenfolge
preisliste.name	Name der Preisliste. Datentyp: Zeichenfolge
preisliste.@typ	Der Typ der Preisliste. Bei der Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Hat immer den Wert `PriceList`. Datentyp: Zeichenfolge
PriceType	Die Preismethode des Produktangebots, das dieser Preislistenposition zugeordnet ist. Mögliche Werte: recurring: Berechnet wiederkehrende Preisbeträge mit einer angegebenen Häufigkeit. Der Wert recurringChargePeriodType gibt die Häufigkeit des Ladevorgangs an. one_time: Einmalige oder wiederkehrende Zusatzkosten und Gebühren für ein Produktangebot. Datentyp: Zeichenfolge
productOffering	Produktangebot, das der Preislistenposition zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Sys_id des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Produktangebot.interneVersion	Interne Versionsnummer des Produktangebots. Beispiel: `PRDOF01024`. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Produktangebot.Name	Name des Produktangebots Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Typ des wiederkehrenden Gebührenzeitraums	Die Periodizität oder Häufigkeit des Produktangebots, das dieser Preislistenposition zugeordnet ist. Gibt einen Häufigkeitstyp zurück, wenn priceType auf `recurring`festgelegt wurde; andernfalls wird eine leere Zeichenfolge zurückgegeben. Mögliche Werte: jährlich monatlich Datentyp: Zeichenfolge
Maßeinheit	Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
Maßeinheit.Betrag	Betrag der Maßeinheit. Datentyp: Zahl
Maßeinheit.ID	Sys_id der Maßeinheit. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
Maßeinheit.Einheiten	Typ der Maßeinheit, die der Preislistenposition zugeordnet ist. Zum Beispiel `Jahr` oder `Bündel`. Datentyp: Zeichenfolge
validFor	Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Enddatum und -uhrzeit, für die die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)
validFor.startDate	Startdatum und -uhrzeit, für die die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)

cURL-Anforderung

Im folgenden Beispiel werden alle zwei Preislistenpositionen zurückgegeben, die in der Instanz vorhanden sind.

curl "http://instance.servicenow.com/api/sn_tmf_api/ catalogmanagement/productOfferingPrice " \
--request GET\
--user 'username':'password'

Antworttext.

[
  {
    "id": "2c4628ac7f4f9e50f8994fa63c86653c",
    "name": "new Price list",
    "lastUpdate": "2025-01-08 19:57:28",
    "isBundle": false,
    "lifecycleStatus": "Draft",
    "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/2c4628ac7f4f9e50f8994fa63c86653c",
    "validFor": {
      "startDateTime": "2027-03-22 22:15:58",
      "endDateTime": ""
    },
    "productOffering": {
      "id": "f2c92ac6a5260210f8774c9b4be6ce56",
      "name": "Managed Connectivity Services Supreme Bundle",
      "internalVersion": "1"
    },
    "priceType": "one_time",
    "recurringChargePeriodType": "",
    "unitOfMeasure": {
      "id": "9a7a119953020110286eddeeff7b1238",
      "amount": 1,
      "units": "Month"
    },
    "price": {
      "units": "USD",
      "value": "800"
    },
    "priceList": {
      "id": "d653246c7f4f9e50f8994fa63c86655a",
      "name": "new Price list",
      "@type": "priceList"
    },
    "@type": "ProductOfferingPrice"
  },
  {
    "id": "dfb7ec607f8f9e50f8994fa63c866569",
    "name": "new Price list",
    "lastUpdate": "2025-01-08 19:57:46",
    "isBundle": false,
    "lifecycleStatus": "Draft",
    "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569",
    "validFor": {
      "startDateTime": "2026-05-28 22:15:58",
      "endDateTime": ""
    },
    "productOffering": {
      "id": "f2c92ac6a5260210f8774c9b4be6ce56",
      "name": "Managed Connectivity Services Supreme Bundle",
      "internalVersion": "1"
    },
    "priceType": "one_time",
    "recurringChargePeriodType": "",
    "unitOfMeasure": {
      "id": "1eaa559953020110286eddeeff7b12c7",
      "amount": 1,
      "units": "Year"
    },
    "price": {
      "units": "USD",
      "value": "800"
    },
    "priceList": {
      "id": "d653246c7f4f9e50f8994fa63c86655a",
      "name": "new Price list",
      "@type": "priceList"
    },
    "@type": "ProductOfferingPrice"
  }
]

Open API für den Produktkatalog – GET /sn_tmf_api/catalogmanagement/productOfferingPrice/{id}

Ruft Details zu einer bestimmten Preislistenposition ab.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/{id}

Unterstützte Anforderungsparameter

Tabelle : 49. Pfadparameter
Name	Beschreibung
id	Erforderlich. Sys_id der abzurufenden Preislistenzeile. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge

Tabelle : 50. Abfrageparameter
Name	Beschreibung
lastUpdate	Filtern Sie Ergebnisse nach dem Datum, an dem die Preiszeile zuletzt aktualisiert wurde. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge
name	Filtern Sie Preislistenpositionen, die zum Namen einer bestimmten Preisliste gehören. Tabelle: Preislisten [sn_csm_ Pricing_Price_list] Datentyp: Zeichenfolge
Preis.Wert	Filtern Sie Ergebnisse nach einem bestimmten Listenpreiswert. Datentyp: Zeichenfolge
priceList.id	Filtern Sie Ergebnisse, um nur eine Preisliste mit einer bestimmten sys_id zurückzugeben. Tabelle: Preislisten [sn_csm_ Pricing_Price_list] Datentyp: Zeichenfolge
PriceType	Filtern Sie Ergebnisse nach der Preisgestaltungsmethode des Produktangebots. Gültige Werte: recurring: Ermöglicht Unternehmen, wiederkehrende Preisbeträge mit einer angegebenen Häufigkeit zu berechnen. one_time: Unterstützt einmalige oder wiederkehrende Zusatzgebühren und Gebühren für ein Produktangebot. Datentyp: Zeichenfolge
productOffering.id	Filtern Sie die Preislistenzeile nach der sys_id des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_product_offering] Datentyp: Zeichenfolge
unitOfMeasure.id	Filtern Sie die Preislistenzeile nach der sys_id der Maßeinheit. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
validFor.endDateTime	Filtern Sie die Preislistenposition nach einem bestimmten Enddatum und einer bestimmten Enduhrzeit. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge
validFor.startDateTime	Filtern Sie die Preislistenposition nach einem bestimmten Startdatum und einer bestimmten Startuhrzeit. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge

Tabelle : 51. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 52. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 53. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 54. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
@type	Typ der Preislistenposition. Immer ein Wert von `ProductOfferingPrice`. Datentyp: Zeichenfolge
href	URL zum Datensatz der Preislistenposition in der Instanz. Datentyp: Zeichenfolge
id	Sys_id der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
isBündel	Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktbündels ist. Gültige Werte: wahr: Preislistenposition ist Teil eines Pakets. false: Preislistenposition ist nicht Teil eines Pakets. Datentyp: Boolesch
lastUpdate	Datum und Uhrzeit der letzten Aktualisierung der Preislistenposition. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge
LifecycleStatus	Aktueller Lebenszyklusstatus der Preislistenposition. Gültige Werte: Aktiv Entwurf Inaktiv Datentyp: Zeichenfolge
Preis	Listenpreisdetails der Preislistenposition. Datentyp: Objekt `"price": { "units": "String", "value": "String" }`
Preis.Einheiten	Währungscode des Preises. Zum Beispiel `USD` oder `EUR`. Tabelle: Währung [fx_currency] Datentyp: Zeichenfolge
Preis.Wert	Wert des Preises. Datentyp: Zeichenfolge (dargestellt durch eine Zahl)
priceList	Preislisteninformationen, die der Preislistenposition zugeordnet sind. Datentyp: Objekt `"priceList": { "id": "String", "name": "String", "@type": "String" }`
PriceList.ID	Sys_id der Preisliste in der Tabelle „Preisliste“ [sn_csm_pricing_Price_list] Datentyp: Zeichenfolge
preisliste.name	Name der Preisliste. Datentyp: Zeichenfolge
preisliste.@typ	Der Typ der Preisliste. Bei der Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Hat immer den Wert `PriceList`. Datentyp: Zeichenfolge
PriceType	Die Preismethode des Produktangebots, das dieser Preislistenposition zugeordnet ist. Mögliche Werte: recurring: Berechnet wiederkehrende Preisbeträge mit einer angegebenen Häufigkeit. Der Wert recurringChargePeriodType gibt die Häufigkeit des Ladevorgangs an. one_time: Einmalige oder wiederkehrende Zusatzkosten und Gebühren für ein Produktangebot. Datentyp: Zeichenfolge
productOffering	Produktangebot, das der Preislistenposition zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Sys_id des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Produktangebot.interneVersion	Interne Versionsnummer des Produktangebots. Beispiel: `PRDOF01024`. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Produktangebot.Name	Name des Produktangebots Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Typ des wiederkehrenden Gebührenzeitraums	Die Periodizität oder Häufigkeit des Produktangebots, das dieser Preislistenposition zugeordnet ist. Gibt einen Häufigkeitstyp zurück, wenn priceType auf `recurring`festgelegt wurde; andernfalls wird eine leere Zeichenfolge zurückgegeben. Mögliche Werte: jährlich monatlich Datentyp: Zeichenfolge
Maßeinheit	Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
Maßeinheit.Betrag	Betrag der Maßeinheit. Datentyp: Zahl
Maßeinheit.ID	Sys_id der Maßeinheit. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
Maßeinheit.Einheiten	Typ der Maßeinheit, die der Preislistenposition zugeordnet ist. Zum Beispiel `Jahr` oder `Bündel`. Datentyp: Zeichenfolge
validFor	Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Enddatum und -uhrzeit, für die die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)
validFor.startDate	Startdatum und -uhrzeit, für die die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)

cURL-Anforderung

Im folgenden Beispiel werden Details des Produktangebotspreises mit der ID dfb7ec60 zurückgegeben …

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569" \
--request GET\
--user 'username':'password'

Antwort

{
  "id": "dfb7ec607f8f9e50f8994fa63c866569",
  "name": "new Price list",
  "lastUpdate": "2025-01-08 19:57:46",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/dfb7ec607f8f9e50f8994fa63c866569",
  "validFor": {
    "startDateTime": "2026-05-28 22:15:58",
    "endDateTime": ""
  },
  "productOffering": {
    "id": "f2c92ac6a5260210f8774c9b4be6ce56",
    "name": "Managed Connectivity Services Supreme Bundle",
    "internalVersion": "1"
  },
  "priceType": "one_time",
  "recurringChargePeriodType": "",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "units": "USD",
    "value": "800"
  },
  "priceList": {
    "id": "d653246c7f4f9e50f8994fa63c86655a",
    "name": "new Price list",
    "@type": "priceList"
  },
  "@type": "ProductOfferingPrice"
}

Offene Produktkatalog-API – GET /sn_tmf_api/catalogmanagement/productSpecification

Ruft alle Produktspezifikationen ab.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productSpecification

Unterstützte Anforderungsparameter

Tabelle : 55. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 56. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: description externalId id internalId internalVersion lastUpdate name produktSpecFeature productSpecificationRelationship resourceSpecification serviceSpecification validFor version Datentyp: Zeichenfolge Standard: Es werden alle Felder zurückgegeben.
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Datentyp: Zahl Standard: 20 Maximum: 100
Offset	Startindex, ab 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
state	Produktspezifikationen nach Status filtern. In der Antwort werden nur Produktspezifikationen im angegebenen Status zurückgegeben. Akzeptierte Werte: archiviert Entwurf Veröffentlicht Deaktiviert Datentyp: Zeichenfolge

Tabelle : 57. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 58. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 59. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` und `Limit=3`, ist der Wert des Content-Range -Headers `Elemente 3-5`.
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter vorheriger
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 HTTP-Antwortcodes der REST-API.

Tabelle : 60. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet. Vollständige Ressource, die als Antwort zurückgegeben wird (keine Paginierung).
206	Teilressource, die als Antwort zurückgegeben wird (mit Paginierung).
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
description	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externalId	Erforderlich. Externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_id der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Anfangsversion oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder external_id der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalId	Erforderlich. Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
isBündel	Kennzeichnung, die angibt, ob productSpecification für ein einzelnes Produkt oder ein Bündel von Produkten steht. Gültige Werte: „wahr“: Die Produktspezifikation ist ein Produktpaket und enthält mehrere Produkte. „falsch“: Die Produktspezifikation enthält ein einzelnes Produkt. Datentyp: Boolesch Standardwert: false
lastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
LifecycleStatus	Aktueller Lebenszyklusstatus der Produktspezifikation. Akzeptierte Werte: Aktiv Inaktiv Entwurf Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
name	Name der Spezifikation. Datentyp: Zeichenfolge
produktSpecFeature	Spezifikationsmerkmal. Datentyp: Array von Objekten `"productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]`
produktSpezifikationsmerkmal.beschreibung	Beschreibung des Merkmals. Datentyp: Zeichenfolge
productSpecCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
produktspezifikationsmerkmal.produktspezifikationsmerkmalwert	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "value": "String" } ]`
Produktspezifikationsmerkmal.Produktspezifikationsmerkmalswert.Wert	Wert des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacterific.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
produktSpecCharacterific.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacterific.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
produktSpezifikationsmerkmal.wertTyp	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
productSpecificationRelationship	Die Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten `"productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]`
productSpecificationRelationship.id	ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge
productSpecificationRelationship.type	Typ der Beziehung. Datentyp: Zeichenfolge
productSpecificationRelationship.validFor	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
productSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge
productSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge
resourceSpecification	Liste der Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Anfangsversion oder externe ID der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_id“ oder „external_id“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.internalId	Anfangsversion der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpezifikation.interneVersion	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Ressourcenspezifikation [sn_prd_pm_resource_specification]
resourceSpecification.version	Externe Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
serviceSpecification	Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
serviceSpecification.id	Anfangsversion oder externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneID	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_service_specification]
serviceSpezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
validFor	Datumsbereich, für den diese Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]

cURL-Anforderung

In diesem Beispiel werden alle Produktspezifikationen abgerufen.

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

Antworttext:

[
   {
      "id": "0c47f2257441c110f877ca57242ff9bd",
      "name": "SD-WAN My Device",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "0c47f2257441c110f877ca57242ff9bd",
      "description": "This is my product specification ...",
      "lastUpdate": "2022-01-14 17:57:23",
      "validFor": {
         "startDateTime": "2022-01-11",
         "endDateTime": "2027-01-10"
      },
      "serviceSpecification": [
         {
            "id": "e23ae2d01bb420106ba59acf034bcb56",
            "name": "IP Sec Tunnel",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "e23ae2d01bb420106ba59acf034bcb56"
         }
      ],
      "productSpecificationRelationship": [
         {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "1",
            "type": "Service",
            "validFor": {
               "startDateTime": "2022-01-11",
               "endDateTime": "2027-02-12"
            }
         }
      ],
      "resourceSpecification": [
         {
            "id": "493fa60b536520103b6bddeeff7b12b6",
            "name": "Customer Premise SD-WAN Router",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "493fa60b536520103b6bddeeff7b12b6"
         }
      ],
      "productSpecCharacteristic": [
         {
            "name": "New characteristic",
            "description": "This product has new spec characteristic.",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-13 06:47:43"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "TestValue",
                  "validFor": {
                     "startDateTime": "2022-01-11"
                  }
               }
            ]
         }
      ]
   }
]

Offene Produktkatalog-API – GET /sn_tmf_api/catalogmanagement/productSpecification/{id}

Ruft eine angegebene Produktspezifikation ab.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productSpecification/{id}

Unterstützte Anforderungsparameter

Tabelle : 61. Pfadparameter
Name	Beschreibung
Spezifikations-ID	Die initiale Version der abzurufenden Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]

Tabelle : 62. Abfrageparameter
Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: description externalId id internalId internalVersion lastUpdate name produktSpecFeature productSpecificationRelationship resourceSpecification serviceSpecification validFor version Datentyp: Zeichenfolge Standard: Es werden alle Felder zurückgegeben.
state	Produktspezifikationen nach Status filtern. In der Antwort werden nur Produktspezifikationen im angegebenen Status zurückgegeben. Akzeptierte Werte: archiviert Entwurf Veröffentlicht Deaktiviert Datentyp: Zeichenfolge

Tabelle : 63. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 64. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 65. Antwortkopfzeilen
Kopfzeile	Beschreibung
Content-Type	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 66. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
description	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externalId	Erforderlich. Externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_id der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Anfangsversion oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder external_id der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalId	Erforderlich. Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
isBündel	Kennzeichnung, die angibt, ob productSpecification für ein einzelnes Produkt oder ein Bündel von Produkten steht. Gültige Werte: „wahr“: Die Produktspezifikation ist ein Produktbündel und enthält mehrere Produkte. „falsch“: Die Produktspezifikation enthält ein einzelnes Produkt. Datentyp: Boolesch Standardwert: false
lastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
LifecycleStatus	Aktueller Lebenszyklusstatus der Produktspezifikation. Gültige Werte: Aktiv Entwurf Inaktiv Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
name	Name der Spezifikation. Datentyp: Zeichenfolge
produktSpecFeature	Spezifikationsmerkmale. Datentyp: Array von Objekten `"productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]`
produktSpezifikationsmerkmal.beschreibung	Beschreibung des Merkmals. Datentyp: Zeichenfolge
productSpecCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
produktspezifikationsmerkmal.produktspezifikationsmerkmalwert	Mögliche Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "value": "String" } ]`
Produktspezifikationsmerkmal.Produktspezifikationsmerkmalswert.Wert	Wert des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacterific.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
produktSpecCharacterific.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacterific.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
produktSpezifikationsmerkmal.wertTyp	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
productSpecificationRelationship	Die Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten `"productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]`
productSpecificationRelationship.id	ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge
productSpecificationRelationship.type	Typ der Beziehung. Datentyp: Zeichenfolge
productSpecificationRelationship.validFor	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
productSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge
productSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge
resourceSpecification	Liste der Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Anfangsversion oder externe ID der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_id“ oder „external_id“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.internalId	Anfangsversion der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpezifikation.interneVersion	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Ressourcenspezifikation [sn_prd_pm_resource_specification]
resourceSpecification.version	Externe Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
serviceSpecification	Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
serviceSpecification.id	Anfangsversion oder externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneID	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_service_specification]
serviceSpezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
validFor	Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]

cURL-Anforderung

In diesem Beispiel wird eine Produktspezifikation abgerufen.

curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification/0c47f2257441c110f877ca57242ff9bd" \
--user 'username':'password'

Antworttext:

{
   "id": "0c47f2257441c110f877ca57242ff9bd",
   "name": "SD-WAN My Device",
   "version": "v1",
   "internalVersion": "1",
   "internalId": "0c47f2257441c110f877ca57242ff9bd",
   "description": "This is my product specification ...",
   "lastUpdate": "2022-01-14 17:57:23",
   "validFor": {
      "startDateTime": "2022-01-11",
      "endDateTime": "2027-01-10"
   },
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "version": "v1",
         "internalVersion": "1",
         "internalId": " a6514bd3534560102f18ddeeff7b1247",
         "type": "Service",
         "validFor": {
            "startDateTime": "2022-01-11",
            "endDateTime": "2027-02-12"
         }
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
   ],
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-13 06:47:43"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "TestValue",
               "validFor": {
                  "startDateTime": "2022-01-11"
               }
            }
         ]
      }
   ]
}

Open API für den Produktkatalog – PATCH /sn_tmf_api/catalogmanagement/productOffering/{id}

Aktualisiert das angegebene Produktangebot.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productOffering/{id}

Unterstützte Anforderungsparameter

Tabelle : 67. Pfadparameter
Name	Beschreibung
id	Sys_id des zu aktualisierenden Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_product_offering]

Tabelle : 68. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 69. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Kategorie	Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten `"category:" [ { "id": "String", "name": "String" } ]` Tabelle: Kategorie [sc_category]
kategorie.id	Erforderlich, wenn der Parameter category verwendet wird. ID der Kategorie Datentyp: Zeichenfolge Tabelle: Kategorie [sc_category]
kategorie.name	Name der Kategorie. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Kanal	Erforderlich. Kanäle für den Verkauf des Produktangebots. Datentyp: Array von Objekten `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Kanalbeschreibung	Beschreibung des Kanals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
channel.id	Erforderlich. Sys_id des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_distribution_channel]
Kanalname	Name des Kanals Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
description	Erforderlich. Beschreibung des Produktangebots. Datentyp: Zeichenfolge
externalId	Externe ID des Produktangebots Datentyp: Zeichenfolge Tabelle: Im Feld external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
id	Erforderlich. Anfangsversion oder externe ID des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalId	Anfangsversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
lastUpdate	Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00 Standard: Leere Zeichenfolge
name	Erforderlich. Name des Produktangebots Datentyp: Zeichenfolge
Produktmerkmal	Liste der Produkteigenschaften. Datentyp: Array von Objekten `"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
Produktangebotspreis	Preisinformationen für das Produktangebot. Datentyp: Array von Objekten `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
ProduktAngebotsPreis.Preis	Preisinformationen für das Produktangebot. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag	Preisinformationen für das Produktangebot. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": "String" }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Wert	Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ProduktangebotPreis.PreisTyp	Typ des Produktangebotstyps. Erforderlich, wenn der Parameter productOfferingPrice verwendet wird. Gültige Werte: nicht wiederkehrend (einmal) recurring Datentyp: Zeichenfolge
Produktangebotslaufzeit	Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Produktspezifikation	Erforderlich. Produktspezifikation für das Produkt. Datentyp: Objekt `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Erforderlich. Initial_version oder external_id der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]
Produktspezifikation.interneID	Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.Version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
prodSpecCharValueUse	Merkmale des Produktangebots. Datentyp: Array von Objekten `"prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.productSpecCharacteristValue.validFor	Datum und Uhrzeit, wann das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "startDateTime": "String" }`
prodSpecCharValueUse.productSpecCharacteristValue.validFor.startDateTime	Startdatum und -uhrzeit, zu der das Merkmal gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00
prodSpecCharValueUse.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
prodSpecCharValueUse.validFor.endDateTime	Enddatum und -uhrzeit des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00
prodSpecCharValueUse.validFor.startDateTime	Startdatum und -uhrzeit des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00
prodSpecCharValueUse.valueType	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
validFor	Erforderlich. Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Erforderlich. Enddatum und -uhrzeit des Produktangebots. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00
validFor.startDateTime	Erforderlich. Startdatum und -uhrzeit des Produktangebots. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00
version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]

Parameter des Antwort-Haupttexts (JSON)

Header

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

Tabelle : 70. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 71. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Statuscodes

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

Tabelle : 72. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
Kategorie	Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten `"category:" [ { "id": "String", "name": "String" } ]`
kategorie.id	ID der Kategorie Datentyp: Zeichenfolge
kategorie.name	Name der Kategorie. Datentyp: Zeichenfolge
Kanal	Kanäle für den Verkauf des Produktangebots. Datentyp: Array von Objekten `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Kanalbeschreibung	Beschreibung des Kanals. Datentyp: Zeichenfolge
channel.id	Sys_id des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_distribution_channel]
Kanalname	Name des Kanals Datentyp: Zeichenfolge
description	Beschreibung des Produktangebots. Datentyp: Zeichenfolge
externalId	Externe ID des Produktangebots Datentyp: Zeichenfolge Tabelle: Im Feld external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Erforderlich. Anfangsversion oder externe ID des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalId	Anfangsversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
lastUpdate	Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
hebenzyklusStatus	Aktueller Lebenszyklusstatus. Akzeptierte Werte: Aktiv Entwurf Inaktiv Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
name	Name des Produktangebots Datentyp: Zeichenfolge
Produktmerkmal	Liste der Produkteigenschaften. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "value": "String" } ]`
Produktmerkmal.Name	Name des Merkmals. Datentyp: Zeichenfolge
Produktmerkmal.Wert	Wert des Merkmals. Datentyp: Zeichenfolge
Produktangebotspreis	Preisinformationen für das Produktangebot. Datentyp: Array von Objekten `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
ProduktAngebotsPreis.Preis	Preisinformationen für das Produktangebot. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag	Preisinformationen für das Produktangebot. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": "String" }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Wert	Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge
ProduktangebotPreis.PreisTyp	Preistyp des Produktangebots, einmalige oder wiederkehrende Zahlung. Mögliche Werte: nicht wiederkehrend (einmal) recurring Datentyp: Zeichenfolge
Produktangebotslaufzeit	Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge
Produktspezifikation	Produktspezifikation für das Produkt. Datentyp: Objekt `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.interneID	Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.Version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
prodSpecCharValueUse	Merkmale des Produktangebots. Datentyp: Array von Objekten `"prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.productSpecCharacteristValue.validFor	Datum und Uhrzeit, wann das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "startDateTime": "String" }`
prodSpecCharValueUse.productSpecCharacteristValue.validFor.startDateTime	Startdatum und -uhrzeit, zu der das Merkmal gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00
prodSpecCharValueUse.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.name	Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
prodSpecCharValueUse.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.valueType	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
validFor	Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum des Produktangebots. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum des Produktangebots. Datentyp: Zeichenfolge
version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]

cURL-Anforderung

Im folgenden Beispiel wird das Produktangebot mit der ID d6f8d9995b020210235d85cced81c7eb mit den im Anforderungstext bereitgestellten Informationen aktualisiert.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb" \ 
--request PATCH\ 
--header "Accept:application/json" \ 
--user 'username':'password'
--data '{
  "name": "Offering 1",
  "displayName": "Offering 1",
  "description": "Offering 1 desc",
  "lastUpdate": "2024-04-01 16:05:19",
  "version": "Offering 1 EXTV",
  "validFor": {
    "startDateTime": "2028-02-29",
    "endDateTime": "2033-03-30"
  },
  "productOfferingTerm": "12_months",
  "productOfferingPrice": [
    {
      "priceType": "recurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": 632.1483
        }
      }
    },
    {
      "priceType": "nonRecurring",
      "price": {
        "taxIncludedAmount": {
          "unit": "USD",
          "value": 1264.2966
        }
      }
    }
  ],
  "productSpecification": {
    "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
    "name": "SD-WAN Service Package",
    "internalVersion": "3"
  },
  "prodSpecCharValueUse": [
    {
      "name": "Bandwidth",
      "description": "Bandwidth",
      "valueType": "choice",
      "validFor": {
        "startDatetime": "2026-12-06 02:32:11"
      },
      "productSpecCharacteristicValue": [
        {
          "value": "1 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "5 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "2 Gbps",
          "validFor": {
            "startDateTime": ""
          }
        },
        {
          "value": "500 Mbps",
          "validFor": {
            "startDateTime": ""
          }
        }
      ],
      "productSpecification": {
        "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
        "name": "SD-WAN Service Package",
        "internalVersion": "3"
      }
    }
  ],
  "channel": [
    {
      "id": "e561aae4c3e710105252716b7d40dd8f",
      "name": "Web"
    }
  ],
  "category": [
    {
      "id": "13e305a143b631105029d1529ab8f267",
      "name": "SD-WAN_all_offers"
    }
  ]
}'

Antworttext:

{
  "result": {
    "name": "Offering 1",
    "displayName": "Offering 1",
    "description": "Offering 1 desc",
    "lastUpdate": "2024-04-01 16:05:19",
    "version": "Offering 1 EXTV",
    "validFor": {
      "startDateTime": "2028-02-29",
      "endDateTime": "2033-03-30"
    },
    "productOfferingTerm": "12_months",
    "productOfferingPrice": [
      {
        "priceType": "recurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 632.1483
          }
        }
      },
      {
        "priceType": "nonRecurring",
        "price": {
          "taxIncludedAmount": {
            "unit": "USD",
            "value": 1264.2966
          }
        }
      }
    ],
    "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "internalVersion": "3",
      "sys_id": "79fa17da775131108e191e599a5a997b",
      "version": "",
      "status": "published",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
    },
    "prodSpecCharValueUse": [
      {
        "name": "Bandwidth",
        "description": "Bandwidth",
        "valueType": "choice",
        "validFor": {
          "startDatetime": "2026-12-06 02:32:11"
        },
        "productSpecCharacteristicValue": [
          {
            "value": "1 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "5 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "2 Gbps",
            "validFor": {
              "startDateTime": ""
            }
          },
          {
            "value": "500 Mbps",
            "validFor": {
              "startDateTime": ""
            }
          }
        ],
        "productSpecification": {
          "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
          "name": "SD-WAN Service Package",
          "internalVersion": "3",
          "version": "",
          "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
        }
      }
    ],
    "channel": [
      {
        "id": "e561aae4c3e710105252716b7d40dd8f",
        "name": "Web"
      }
    ],
    "category": [
      {
        "id": "13e305a143b631105029d1529ab8f267",
        "name": "SD-WAN_all_offers"
      }
    ],
    "href": "/api/sn_tmf_api/catalogmanagement/productOffering/d6f8d9995b020210235d85cced81c7eb"
  }
}

Open API für den Produktkatalog – PATCH /sn_tmf_api/catalogmanagement/productOfferingPrice/{id}

Aktualisiert einen Preislistenpositionsdatensatz mit einer bestimmten sys_id in der Tabelle „Preislistenposition“ [sn_csm_pricing_Price_list_line].

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/{id}

Unterstützte Anforderungsparameter

Tabelle : 73. Pfadparameter
Name	Beschreibung
id	Erforderlich. Sys_id der abzurufenden Preislistenzeile. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge

Tabelle : 74. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 75. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
@type	Erforderlich. Typ der Preislistenposition. Immer ein Wert von `ProductOfferingPrice`. Datentyp: Zeichenfolge
externalId	Die externe ID der Preislistenposition. Datentyp: Zeichenfolge
isBündel	Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktbündels ist. Gültige Werte: wahr: Preislistenposition ist Teil eines Pakets. false: Preislistenposition ist nicht Teil eines Pakets. Datentyp: Boolesch Standardwert: false
lastUpdate	Erforderlich. Datum, an dem die Preiszeile zuletzt aktualisiert wurde. Format: JJJJ-MM-TT Datentyp: Zeichenfolge
LifeCycleStatus	Erforderlich. Aktueller Lebenszyklusstatus der Produktlistenposition. Gültige Werte: aktiv Entwurf Inaktiv Datentyp: Zeichenfolge Standard: Entwurf
name	Erforderlich. Name für die Preislistenposition. Datentyp: Zeichenfolge
Preis	Erforderlich. Listenpreisdetails der Preislistenposition. Datentyp: Objekt `"price": { "unit": "String", "value": "String" }`
Preis.Einheit	Erforderlich. Währungscode der Preislistenposition. Zum Beispiel `USD` oder `EUR`. Tabelle: Währungstabelle [fx_currency]. Datentyp: Zeichenfolge
Preis.Wert	Erforderlich. Wert des Preises. Datentyp: Zeichenfolge (dargestellt durch eine Zahl). Beispiel: `„800“`.)
priceList	Erforderlich. Preislisteninformationen, die der Preislistenposition zugeordnet sind. Datentyp: Objekt `"priceList": { "id": "String", "name": "String", "@type": "String" }`
PriceList.ID	Erforderlich. Sys_id der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
priceList.name	Name der Preislistenposition. Datentyp: Zeichenfolge
preisliste.@typ	Der Typ der Preislistenposition. Bei der Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Wert ist immer `PriceList`. Datentyp: Zeichenfolge
PriceType	Erforderlich. Filtern Sie die Preislistenzeile nach der Preismethode des Produktangebots. Gültige Werte: recurring: Berechnet wiederkehrende Preisbeträge mit einer angegebenen Häufigkeit. Die Häufigkeit wird im Parameter recurringChargePeriodType festgelegt. one_time: Unterstützt einmalige oder wiederkehrende Zusatzgebühren und Gebühren für ein Produktangebot. Datentyp: Zeichenfolge Standard: wiederkehrend
productOffering	Erforderlich. Produktangebot der Preislistenposition. Datentyp: Objekt `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Erforderlich. Sys_id des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_product_offering] Datentyp: Zeichenfolge
Produktangebot.interneVersion	Interne Versionsnummer des Produktangebots. Datentyp: Zeichenfolge (dargestellt durch eine Zahl). Beispiel: `„1“`.)
productOffering.name	Name des Produktangebots Datentyp: Zeichenfolge
Typ des wiederkehrenden Gebührenzeitraums	Erforderlich, wenn priceType wiederkehrend ist. Verpflichtungsbedingungen, die beim Erstellen des Produktangebots ausgewählt wurden. Gültige Werte: jährlich monatlich Datentyp: Zeichenfolge
Maßeinheit	Erforderlich. Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
Maßeinheit.Betrag	Betrag der Maßeinheit. Datentyp: Zahl
Maßeinheit.ID	Erforderlich. Sys_id der Maßeinheit in der Tabelle „Preispositionsliste“. Tabelle: Preislistenposition [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
Maßeinheit.Einheiten	Typ der Maßeinheit, die der Preislistenposition zugeordnet ist. Zum Beispiel `einzeln` oder `bündeln`. Datentyp: Zeichenfolge
validFor	Erforderlich. Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Enddatum, für das die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)
validFor.endDateTime	Enddatum und -uhrzeit, für die die Preislistenposition gültig ist. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge (glide_date)
validFor.startDate	Startdatum, für das die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)
validFor.startDateTime	Startdatum und -uhrzeit, für die die Preislistenposition gültig ist. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge (glide_date)

Kopfzeilen

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

Tabelle : 76. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 77. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 78. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
id	Sys_id der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
href	URL zum Datensatz der Preislistenposition in der Instanz. Datentyp: Zeichenfolge
lastUpdate	Datum und Uhrzeit der letzten Aktualisierung der Preislistenposition. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge
validFor	Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Enddatum und -uhrzeit, für die die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)
validFor.startDate	Startdatum und -uhrzeit, für die die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)
isBündel	Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktbündels ist. Gültige Werte: wahr: Preislistenposition ist Teil eines Pakets. false: Preislistenposition ist nicht Teil eines Pakets. Datentyp: Boolesch
LifecycleStatus	Aktueller Lebenszyklusstatus der Preislistenposition. Gültige Werte: Aktiv Entwurf Inaktiv Datentyp: Zeichenfolge
productOffering	Produktangebot, das der Preislistenposition zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Sys_id des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Produktangebot.interneVersion	Interne Versionsnummer des Produktangebots. Beispiel: `PRDOF01024`. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Produktangebot.Name	Name des Produktangebots Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
PriceType	Die Preismethode des Produktangebots, das dieser Preislistenposition zugeordnet ist. Mögliche Werte: recurring: Berechnet wiederkehrende Preisbeträge mit einer angegebenen Häufigkeit. Der Wert recurringChargePeriodType gibt die Häufigkeit des Ladevorgangs an. one_time: Einmalige oder wiederkehrende Zusatzkosten und Gebühren für ein Produktangebot. Datentyp: Zeichenfolge
Typ des wiederkehrenden Gebührenzeitraums	Die Periodizität oder Häufigkeit des Produktangebots, das dieser Preislistenposition zugeordnet ist. Gibt einen Häufigkeitstyp zurück, wenn priceType auf `recurring`festgelegt wurde; andernfalls wird eine leere Zeichenfolge zurückgegeben. Mögliche Werte: jährlich monatlich Datentyp: Zeichenfolge
Maßeinheit	Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
Maßeinheit.Betrag	Betrag der Maßeinheit. Datentyp: Zahl
Maßeinheit.ID	Sys_id der Maßeinheit. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
Maßeinheit.Einheiten	Typ der Maßeinheit, die der Preislistenposition zugeordnet ist. Zum Beispiel `Jahr` oder `Bündel`. Datentyp: Zeichenfolge
Preis	Listenpreisdetails der Preislistenposition. Datentyp: Objekt `"price": { "units": "String", "value": "String" }`
Preis.Einheiten	Währungscode des Preises. Zum Beispiel `USD` oder `EUR`. Tabelle: Währung [fx_currency] Datentyp: Zeichenfolge
Preis.Wert	Wert des Preises. Datentyp: Zeichenfolge (dargestellt durch eine Zahl)
priceList	Preislisteninformationen, die der Preislistenposition zugeordnet sind. Datentyp: Objekt `"priceList": { "id": "String", "name": "String", "@type": "String" }`
PriceList.ID	Sys_id der Preisliste in der Tabelle „Preisliste“ [sn_csm_pricing_Price_list] Datentyp: Zeichenfolge
preisliste.name	Name der Preisliste. Datentyp: Zeichenfolge
preisliste.@typ	Der Typ der Preisliste. Bei der Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Hat immer den Wert `PriceList`. Datentyp: Zeichenfolge
@type	Immer ein Wert von `ProductOfferingPrice`. Bei der Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Datentyp: Zeichenfolge
state	Status der Preisliste, die dieser Preislistenposition zugeordnet ist. Datentyp: Zeichenfolge
externalId	Die externe ID dieser Preislistenposition. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Beispiel werden die Daten aktualisiert, an denen der Produktangebotspreis mit der ID 3ddd0... für gültig ist.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
--request patch\
--user 'username':'password'
--data {
  "validFor": {
    "endDateTime": "2024-06-25 15:15:58"
  }
}

Antworttext:

{
  "validFor": {
    "endDateTime": "2024-06-25 15:15:58"
  },
  "id": "994d5d364f8b5210f899f61d20ce0b7c",
  "name": "new Price list",
  "lastUpdate": "2025-01-16 00:15:32",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c",
  "lifecycleStatus": "Draft"
}

Open API für den Produktkatalog – PATCH /sn_tmf_api/catalogmanagement/productSpecification/{id}

Aktualisiert die angegebene Produktspezifikation.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productSpecification/{id}

Unterstützte Anforderungsparameter

Tabelle : 79. Pfadparameter
Name	Beschreibung
id	Sys_id des zu aktualisierenden Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_product_specification]

Tabelle : 80. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 81. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
description	Erforderlich. Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externalId	Erforderlich. Externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_id der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
id	Anfangsversion oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder external_id der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalId	Erforderlich. Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
isBündel	Kennzeichnung, die angibt, ob productSpecification für ein einzelnes Produkt oder ein Bündel von Produkten steht. Gültige Werte: „wahr“: Die Produktspezifikation ist ein Produktbündel und enthält mehrere Produkte. „falsch“: Die Produktspezifikation enthält ein einzelnes Produkt. Datentyp: Boolesch Standardwert: false
lastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
name	Erforderlich. Name der Spezifikation. Datentyp: Zeichenfolge
produktSpecFeature	Spezifikationsmerkmal. Datentyp: Array von Objekten `"productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]`
produktSpezifikationsmerkmal.beschreibung	Beschreibung des Merkmals. Datentyp: Zeichenfolge
productSpecCharacteristic.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.productSpecCharacteristValue	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.productSpecCharacteristValue.validFor	Datum und Uhrzeit, wann das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "startDateTime": "String" }`
prodSpecCharValueUse.productSpecCharacteristValue.validFor.startDateTime	Startdatum und -uhrzeit, zu der das Merkmal gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00
produktSpecCharacterific.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
produktSpecCharacterific.validFor.endDateTime	Enddatum und -uhrzeit des Merkmals. Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Datentyp: Zeichenfolge
produktSpecCharacterific.validFor.startDateTime	Startdatum und -uhrzeit des Merkmals. Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Datentyp: Zeichenfolge
produktSpezifikationsmerkmal.wertTyp	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
productSpecificationRelationship	Details der Beziehungen der Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten `"productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]`
productSpecificationRelationship.id	ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge
productSpecificationRelationship.type	Erforderlich, wenn der Parameter productSpecificationRelationship verwendet wird. Typ der Beziehung. Gültige Werte: Pakete Bestehend aus Datentyp: Zeichenfolge
productSpecificationRelationship.validFor	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
productSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Datentyp: Zeichenfolge
productSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Datentyp: Zeichenfolge
resourceSpecification	Erforderlich. Details der Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Erforderlich. Anfangsversion oder externe ID der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_id“ oder „external_id“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.internalId	Anfangsversion der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpezifikation.interneVersion	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Ressourcenspezifikation [sn_prd_pm_resource_specification]
resourceSpecification.version	Externe Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
serviceSpecification	Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
serviceSpecification.id	Anfangsversion oder externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneID	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_service_specification]
serviceSpezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
validFor	Erforderlich. Datumsbereich, für den diese Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum und -uhrzeit der Spezifikation. Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum und -uhrzeit der Spezifikation. Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Datentyp: Zeichenfolge
version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]

Header

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

Tabelle : 82. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 83. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 84. Statuscodes
Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt:<field name>
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
description	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge
id	Anfangsversion oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder external_id der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalId	Erforderlich. Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
lastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Format: JJJJ-MM-TT 00:00:00. Datentyp: Zeichenfolge
name	Name der Spezifikation. Datentyp: Zeichenfolge
produktSpecFeature	Merkmale der Spezifikation. Datentyp: Array von Objekten `"productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]`
produktSpezifikationsmerkmal.beschreibung	Beschreibung des Merkmals. Datentyp: Zeichenfolge
produktSpezifikationsmerkmal.name	Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.productSpecCharacteristValue	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "validFor": {Object}, "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.productSpecCharacteristValue.validFor	Datum und Uhrzeit, wann das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "startDateTime": "String" }`
prodSpecCharValueUse.productSpecCharacteristValue.validFor.startDateTime	Startdatum und -uhrzeit, zu der das Merkmal gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00
produktSpecCharacterific.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
produktSpecCharacterific.validFor.endDateTime	Enddatum und -uhrzeit des Merkmals. Format: JJJJ-MM-TT 00:00:00. Datentyp: Zeichenfolge
produktSpecCharacterific.validFor.startDateTime	Startdatum und -uhrzeit des Merkmals. Format: JJJJ-MM-TT 00:00:00. Datentyp: Zeichenfolge
produktSpezifikationsmerkmal.wertTyp	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
productSpecificationRelationship	Die Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten `"productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": {Object} } ]`
productSpecificationRelationship.id	Sys_id der zugehörigen Spezifikation. Datentyp: Zeichenfolge
productSpecificationRelationship.type	Typ der Beziehung. Datentyp: Zeichenfolge
productSpecificationRelationship.validFor	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
productSpecificationRelationship.validFor.endDateTime	Enddatum und Typ der Beziehung. Format: JJJJ-MM-TT 00:00:00. Datentyp: Zeichenfolge
productSpecificationRelationship.validFor.startDateTime	Startdatum und Typ der Beziehung. Format: JJJJ-MM-TT 00:00:00. Datentyp: Zeichenfolge
resourceSpecification	Liste der Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Anfangsversion oder externe ID der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_id“ oder „external_id“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.internalId	Anfangsversion der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpezifikation.interneVersion	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Ressourcenspezifikation [sn_prd_pm_resource_specification]
resourceSpecification.version	Externe Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
serviceSpecification	Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
serviceSpecification.id	Anfangsversion oder externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneID	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_service_specification]
serviceSpezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
validFor	Datumsbereich, für den diese Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum und -uhrzeit der Spezifikation. Format: JJJJ-MM-TT 00:00:00. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum und -uhrzeit der Spezifikation. Format: JJJJ-MM-TT 00:00:00. Datentyp: Zeichenfolge
version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]

cURL-Anforderung

Im folgenden Beispiel wird die Produktspezifikations-ID d6f8d9995b020210235d85cced81c7eb mit den im Anforderungstext angegebenen Informationen aktualisiert.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/d6f8d9995b020210235d85cced81c7eb" \ 
--request PATCH\ 
--header "Accept:application/json" \ 
--user 'username':'password'
--data '{
  "id": "1001",
  "name": "SD-WAN 0322 test",
  "description": "This is my product specification ...",
  "validFor": {
    "startDateTime": "2017-06-19T00:00",
    "endDateTime": "2018-01-13T00:00"
  },
  "productSpecCharacteristic": [
    {
      "name": "New characteristic",
      "description": "This product has new spec characteristic.",
      "valueType": "label",
      "validFor": {
        "startDateTime": "2017-06-20T00:00"
      }
    }
  ],
  "serviceSpecification": [
    {
      "id": "e23ae2d01bb420106ba59acf034bcb56",
      "name": "IP Sec Tunnel",
      "internalVersion": "2"
    }
  ],
  "productSpecificationRelationship": [
    {
      "id": "a6514bd3534560102f18ddeeff7b1247",
      "name": "SD-WAN Security",
      "internalVersion": "2",
      "type": "bundles",
      "validFor": {
        "startDateTime": "2017-06-16T00:00"
      }
    }
  ],
  "resourceSpecification": [
    {
      "id": "493fa60b536520103b6bddeeff7b12b6",
      "name": "Customer Premise SD-WAN Router"
    }
  ],
  "@type": "ProductSpecification"
}

Antworttext:

{
  "result": {
    "id": "1001",
    "name": "SD-WAN 0322 test",
    "description": "This is my product specification ...",
    "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
    },
    "productSpecCharacteristic": [
      {
        "name": "New characteristic",
        "description": "This product has new spec characteristic.",
        "valueType": "label",
        "validFor": {
          "startDateTime": "2017-06-20T00:00"
        }
      }
    ],
    "serviceSpecification": [
      {
        "id": "e23ae2d01bb420106ba59acf034bcb56",
        "name": "IP Sec Tunnel",
        "internalVersion": "2",
        "sys_id": "dd8354205b550210235d85cced81c7cd",
        "version": "",
        "status": "published",
        "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
    ],
    "productSpecificationRelationship": [
      {
        "id": "a6514bd3534560102f18ddeeff7b1247",
        "name": "SD-WAN Security",
        "internalVersion": "2",
        "type": "bundles",
        "validFor": {
          "startDateTime": "2017-06-16T00:00"
        },
        "sys_id": "7a491dd3776301108b2a1e599a5a99d3",
        "version": "",
        "status": "published",
        "internalId": "a6514bd3534560102f18ddeeff7b1247"
      }
    ],
    "resourceSpecification": [
      {
        "id": "493fa60b536520103b6bddeeff7b12b6",
        "name": "Customer Premise SD-WAN Router",
        "sys_id": "493fa60b536520103b6bddeeff7b12b6",
        "internalVersion": "1",
        "version": "",
        "status": "published",
        "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
    ],
    "@type": "ProductSpecification",
    "href": "/api/sn_tmf_api/catalogmanagement/productSpecification/3d140fe85be1c210235d85cced81c73a"
  }
}

Product Catalog Open API – POST /sn_tmf_api/catalogmanagement/catalog

Erstellt einen Produktangebotskatalog.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/catalog

Unterstützte Anforderungsparameter

Tabelle : 85. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 86. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 87. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
description	Beschreibung des Produktangebotskatalogs. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
externalId	Eindeutiger Bezeichner für den Produktangebotskatalog aus dem externen System. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
name	Erforderlich. Name des Produktangebotskatalogs. Datentyp: Zeichenfolge

Header

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

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

Tabelle : 89. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 90. 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>

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
description	Beschreibung des Produktangebotskatalogs. Datentyp: Zeichenfolge
id	Sys_id des Produktangebotkatalogs Datentyp: Zeichenfolge Tabelle: Produktangebotskatalog [sn_prd_pm_product_offering_catalog]
name	Name des Produktangebotskatalogs. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Produktangebotskatalog erstellt.

curl --location --request POST "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog" \
--header "Content-Type: application/json" \
--data-raw '{
    "id": "testId",
    "name": "Catalog",
    "description": "Description"
}'
--user 'username':'password'

Antworttext:

{
   "id": "45715d02c3510110bc0526083c40dd6b",
   "description": "Description",
   "name": "Catalog1"
}

Produktkatalog – Open API – POST /sn_tmf_api/catalogmanagement/productOffering

Erstellt ein Produktangebot.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productOffering

Unterstützte Anforderungsparameter

Tabelle : 91. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 92. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 93. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
Kategorie	Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten `"category:" [ { "id": "String", "name": "String" } ]` Tabelle: Kategorie [sc_category]
kategorie.id	Erforderlich, wenn der Parameter category verwendet wird. ID der Kategorie Datentyp: Zeichenfolge
kategorie.name	Name der Kategorie. Datentyp: Zeichenfolge
Kanal	Erforderlich. Kanäle für den Verkauf des Produktangebots. Datentyp: Array von Objekten `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Kanalbeschreibung	Beschreibung des Kanals. Datentyp: Zeichenfolge
channel.id	Erforderlich. Sys_id des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_distribution_channel]
Kanalname	Name des Kanals Datentyp: Zeichenfolge
description	Erforderlich. Beschreibung des Produktangebots. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner für das Produktangebot aus dem externen System. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge
id	Erforderlich. Anfangsversion oder externe ID des Produktangebots. Datentyp: Zeichenfolge Tabelle: In den Feldern initial_version oder external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalId	Anfangsversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
lastUpdate	Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
LifecycleStatus	Aktueller Lebenszyklusstatus. Gültige Werte: Aktiv Entwurf Inaktiv Datentyp: Zeichenfolge
name	Erforderlich. Name des Produktangebots Datentyp: Zeichenfolge
Produktmerkmal	Liste der Produkteigenschaften. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "value": "String" } ]`
productCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
Produktmerkmal.Wert	Wert des Merkmals. Datentyp: Zeichenfolge
Produktangebotspreis	Preisinformationen für das Produktangebot. Datentyp: Array von Objekten `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
ProduktAngebotsPreis.Preis	Preisinformationen für das Produktangebot. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag	Preisinformationen für das Produktangebot. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": "String" }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Wert	Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge
ProduktangebotPreis.PreisTyp	Erforderlich, wenn der Parameter productOfferingPrice verwendet wird. Preistyp des Produktangebots, einmalige oder wiederkehrende Zahlung. Gültige Werte: nicht wiederkehrend (einmal) recurring Datentyp: Zeichenfolge
Produktangebotslaufzeit	Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge
Produktspezifikation	Erforderlich. Produktspezifikation für das Produkt. Datentyp: Objekt `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Erforderlich. Anfangsversion oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder externa_id der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
Produktspezifikation.interneID	Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.Version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
prodSpecCharValueUse	Merkmale des Produktangebots. Datentyp: Array von Objekten `"prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue	Erforderlich. Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue.value	Erforderlich. Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
prodSpecCharValueUse.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.valueType	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
validFor	Erforderlich. Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum des Produktangebots. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum des Produktangebots. Datentyp: Zeichenfolge
version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]

Header

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

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

Tabelle : 95. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 96. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt:<field name>

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
Kategorie	Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten `"category:" [ { "id": "String", "name": "String" } ]`
kategorie.id	ID der Kategorie Datentyp: Zeichenfolge
kategorie.name	Name der Kategorie. Datentyp: Zeichenfolge
Kanal	Kanäle für den Verkauf des Produktangebots. Datentyp: Array von Objekten `"channel:" [ { "description": "String", "id": "String", "name": "String" } ]`
Kanalbeschreibung	Beschreibung des Kanals. Datentyp: Zeichenfolge
channel.id	Sys_id des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_distribution_channel]
Kanalname	Name des Kanals Datentyp: Zeichenfolge
description	Beschreibung des Produktangebots. Datentyp: Zeichenfolge
externalId	Externe ID des Produktangebots Datentyp: Zeichenfolge Tabelle: Im Feld external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Erforderlich. Anfangsversion oder externe ID des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder external_id der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalId	Anfangsversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
internalVersion	Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
lastUpdate	Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
LifecycleStatus	Aktueller Lebenszyklusstatus des Produktangebots. Gültige Werte: Aktiv Entwurf Inaktiv Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
name	Name des Produktangebots Datentyp: Zeichenfolge
Produktmerkmal	Liste der Produkteigenschaften. Datentyp: Array von Objekten `"productCharacteristic": [ { "name": "String", "value": "String" } ]`
Produktmerkmal.Name	Name des Merkmals. Datentyp: Zeichenfolge
Produktmerkmal.Wert	Wert des Merkmals. Datentyp: Zeichenfolge
Produktangebotspreis	Preisinformationen für das Produktangebot. Datentyp: Array von Objekten `"productOfferingPrice": [ { "price": {Object}, "priceType": "String" } ]`
ProduktAngebotsPreis.Preis	Preisinformationen für das Produktangebot. Datentyp: Objekt `"price": { "taxIncludedAmount": {Object} }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag	Preisinformationen für das Produktangebot. Datentyp: Objekt `"taxIncludedAmount": { "unit": "String", "value": "String" }`
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Einheit	Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge
ProduktAngebotsPreis.Preis.SteuerEnthaltenerBetrag.Wert	Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge
ProduktangebotPreis.PreisTyp	Preistyp des Produktangebots, einmalige oder wiederkehrende Zahlung. Mögliche Werte: nicht wiederkehrend (einmal) recurring Datentyp: Zeichenfolge
Produktangebotslaufzeit	Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge
Produktspezifikation	Produktspezifikation für das Produkt. Datentyp: Objekt `"productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }`
productSpecification.id	Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.interneID	Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.interneVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].
Produktspezifikation.Version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]
prodSpecCharValueUse	Merkmale des Produktangebots. Datentyp: Array von Objekten `"prodSpecCharValueUse": [ { "productSpecCharacteristicValue": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "value": "String" } ]`
prodSpecCharValueUse.productSpecCharacteristValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.name	Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
prodSpecCharValueUse.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.valueType	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
validFor	Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum des Produktangebots. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum des Produktangebots. Datentyp: Zeichenfolge
version	Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]

cURL-Anforderung

In diesem Beispiel wird ein Produktangebot erstellt.

curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering" \
--header "Content-Type: application/json" \
--data-raw '{
   "id": "d52a756b5bde0110235d85cced81c7ab",
   "name": "Premium SD-WAN Offering New",
   "version": "",
   "internalVersion": "2",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2021-08-16 04:55:52",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "24_months",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913488140197
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": "v1",
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      },
      {
         "name": "CPE Id",
         "description": "CPE Id",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2021-08-15 17:50:26"
         },
         "productSpecCharacteristicValue": [],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-23 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": "v1",
            "internalVersion": "1",
            "internalId": " a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": "v1",
            "internalVersion": "1",
            "internalId": " 39b627aa53702010cd6dddeeff7b1202"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   }
}'
--user 'username':'password'

Antworttext:

{
   "id": "d52a756b5bde0110235d85cced81c7ab",
   "name": "Premium SD-WAN Offering New",
   "version": null,
   "internalVersion": "5",
   "description": "Premium SD-WAN Offering",
   "lastUpdate": "2021-08-16 04:55:52",
   "validFor": {
      "startDateTime": "2021-08-05",
      "endDateTime": "2026-09-04"
   },
   "productOfferingTerm": "24_months",
   "productOfferingPrice": [
      {
         "priceType": "recurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "JPY",
               "value": 984.0913488140197
            }
         }
      },
      {
         "priceType": "nonRecurring",
         "price": {
            "taxIncludedAmount": {
               "unit": "GBP",
               "value": 2434
            }
         }
      }
   ],
   "productSpecification": {
      "id": "cfe5ef6a53702010cd6dddeeff7b12f6",
      "name": "SD-WAN Service Package",
      "version": null,
      "internalVersion": "1",
      "internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
   },
   "prodSpecCharValueUse": [
      {
         "name": "Tenancy",
         "description": "Tenancy",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:04:24"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium (>50 sites)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance (50 site)",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base (10 site)",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "216663aa53702010cd6dddeeff7b12b5",
            "name": "SD-WAN Controller",
            "version": null,
            "internalVersion": "1",
            "internalId": "216663aa53702010cd6dddeeff7b12b5"
         }
      },
      {
         "name": "CPE Id",
         "description": "CPE Id",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2021-08-15 17:50:26"
         },
         "productSpecCharacteristicValue": [],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Routing",
         "description": "Routing",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:08:20"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "WAN Optimization",
         "description": "WAN Optimization",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:10:28"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "CPE Model",
         "description": "CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:54"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "ISR",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "ASR",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      },
      {
         "name": "Security Type",
         "description": "Security Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-23 12:51:13"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Base",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Advance",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "a6514bd3534560102f18ddeeff7b1247",
            "name": "SD-WAN Security",
            "version": null,
            "internalVersion": "1",
            "internalId": "a6514bd3534560102f18ddeeff7b1247"
         }
      },
      {
         "name": "CPE Type",
         "description": "CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2021-07-08 21:11:16"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ],
         "productSpecification": {
            "id": "39b627aa53702010cd6dddeeff7b1202",
            "name": "SD-WAN Edge Device",
            "version": null,
            "internalVersion": "1",
            "internalId": "39b627aa53702010cd6dddeeff7b1202"
         }
      }
   ],
   "channel": [
      {
         "id": "e561aae4c3e710105252716b7d40dd8f",
         "name": "Web"
      }
   ],
   "category": {
      "id": "c0ed043653b02010cd6dddeeff7b1277",
      "name": "SD-WAN"
   },
   "internalId": "fbc1c0a25b030110235d85cced81c724",
   "externalId": "d52a756b5bde0110235d85cced81c7ab"
}

Produktkatalog – Open API – POST /sn_tmf_api/catalogmanagement/productOfferingPrice

Erstellt einen neuen Preislistenpositionsdatensatz in der Tabelle „Preislistenposition“ [sn_csm_pricing_Price_list_line].

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice

Unterstützte Anforderungsparameter

Tabelle : 97. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 98. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 99. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
@type	Erforderlich. Typ der Preislistenposition. Immer ein Wert von `ProductOfferingPrice`. Datentyp: Zeichenfolge
externalId	Die externe ID der Preislistenposition. Datentyp: Zeichenfolge
isBündel	Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktbündels ist. Gültige Werte: wahr: Preislistenposition ist Teil eines Pakets. false: Preislistenposition ist nicht Teil eines Pakets. Datentyp: Boolesch Standardwert: false
lastUpdate	Erforderlich. Datum, an dem die Preiszeile zuletzt aktualisiert wurde. Format: JJJJ-MM-TT Datentyp: Zeichenfolge
LifeCycleStatus	Erforderlich. Aktueller Lebenszyklusstatus der Produktlistenposition. Gültige Werte: aktiv Entwurf Inaktiv Datentyp: Zeichenfolge Standard: Entwurf
name	Erforderlich. Name für die Preislistenposition. Datentyp: Zeichenfolge
Preis	Erforderlich. Listenpreisdetails der Preislistenposition. Datentyp: Objekt `"price": { "unit": "String", "value": "String" }`
Preis.Einheit	Erforderlich. Währungscode der Preislistenposition. Zum Beispiel `USD` oder `EUR`. Tabelle: Währungstabelle [fx_currency]. Datentyp: Zeichenfolge
Preis.Wert	Erforderlich. Wert des Preises. Datentyp: Zeichenfolge (dargestellt durch eine Zahl). Beispiel: `„800“`.)
priceList	Erforderlich. Preislisteninformationen, die der Preislistenposition zugeordnet sind. Datentyp: Objekt `"priceList": { "id": "String", "name": "String", "@type": "String" }`
PriceList.ID	Erforderlich. Sys_id der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
priceList.name	Name der Preislistenposition. Datentyp: Zeichenfolge
preisliste.@typ	Der Typ der Preislistenposition. Bei der Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Wert ist immer `PriceList`. Datentyp: Zeichenfolge
PriceType	Erforderlich. Filtern Sie die Preislistenzeile nach der Preismethode des Produktangebots. Gültige Werte: recurring: Berechnet wiederkehrende Preisbeträge mit einer angegebenen Häufigkeit. Die Häufigkeit wird im Parameter recurringChargePeriodType festgelegt. one_time: Unterstützt einmalige oder wiederkehrende Zusatzgebühren und Gebühren für ein Produktangebot. Datentyp: Zeichenfolge Standard: wiederkehrend
productOffering	Erforderlich. Produktangebot der Preislistenposition. Datentyp: Objekt `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Erforderlich. Sys_id des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_product_offering] Datentyp: Zeichenfolge
Produktangebot.interneVersion	Interne Versionsnummer des Produktangebots. Datentyp: Zeichenfolge (dargestellt durch eine Zahl). Beispiel: `„1“`.)
productOffering.name	Name des Produktangebots Datentyp: Zeichenfolge
Typ des wiederkehrenden Gebührenzeitraums	Erforderlich, wenn priceType wiederkehrend ist. Verpflichtungsbedingungen, die beim Erstellen des Produktangebots ausgewählt wurden. Gültige Werte: jährlich monatlich Datentyp: Zeichenfolge
Maßeinheit	Erforderlich. Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
Maßeinheit.Betrag	Betrag der Maßeinheit. Datentyp: Zahl
Maßeinheit.ID	Erforderlich. Sys_id der Maßeinheit in der Tabelle „Preispositionsliste“. Tabelle: Preislistenposition [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
Maßeinheit.Einheiten	Typ der Maßeinheit, die der Preislistenposition zugeordnet ist. Zum Beispiel `einzeln` oder `bündeln`. Datentyp: Zeichenfolge
validFor	Erforderlich. Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Enddatum, für das die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)
validFor.endDateTime	Enddatum und -uhrzeit, für die die Preislistenposition gültig ist. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge (glide_date)
validFor.startDate	Startdatum, für das die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)
validFor.startDateTime	Startdatum und -uhrzeit, für die die Preislistenposition gültig ist. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge (glide_date)

Kopfzeilen

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

Tabelle : 100. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.

Tabelle : 101. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 102. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.

Parameter des Antworttexts (JSON oder XML)


Name	Beschreibung
id	Sys_id der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
href	URL zum Datensatz der Preislistenposition in der Instanz. Datentyp: Zeichenfolge
lastUpdate	Datum und Uhrzeit der letzten Aktualisierung der Preislistenposition. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge
validFor	Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt `"validFor": { "endDate": "String", "startDate": "String" }`
validFor.endDate	Enddatum und -uhrzeit, für die die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)
validFor.startDate	Startdatum und -uhrzeit, für die die Preislistenposition gültig ist. Datentyp: Zeichenfolge (glide_date_time)
isBündel	Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktbündels ist. Gültige Werte: wahr: Preislistenposition ist Teil eines Pakets. false: Preislistenposition ist nicht Teil eines Pakets. Datentyp: Boolesch
LifecycleStatus	Aktueller Lebenszyklusstatus der Preislistenposition. Gültige Werte: Aktiv Entwurf Inaktiv Datentyp: Zeichenfolge
productOffering	Produktangebot, das der Preislistenposition zugeordnet ist. Datentyp: Objekt `"productOffering": { "id": "String", "name": "String", "internalVersion": "String" }`
productOffering.id	Sys_id des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Produktangebot.interneVersion	Interne Versionsnummer des Produktangebots. Beispiel: `PRDOF01024`. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Produktangebot.Name	Name des Produktangebots Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
PriceType	Die Preismethode des Produktangebots, das dieser Preislistenposition zugeordnet ist. Mögliche Werte: recurring: Berechnet wiederkehrende Preisbeträge mit einer angegebenen Häufigkeit. Der Wert recurringChargePeriodType gibt die Häufigkeit des Ladevorgangs an. one_time: Einmalige oder wiederkehrende Zusatzkosten und Gebühren für ein Produktangebot. Datentyp: Zeichenfolge
Typ des wiederkehrenden Gebührenzeitraums	Die Periodizität oder Häufigkeit des Produktangebots, das dieser Preislistenposition zugeordnet ist. Gibt einen Häufigkeitstyp zurück, wenn priceType auf `recurring`festgelegt wurde; andernfalls wird eine leere Zeichenfolge zurückgegeben. Mögliche Werte: jährlich monatlich Datentyp: Zeichenfolge
Maßeinheit	Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt `"unitOfMeasure": { "id": "String", "amount": Number, "units": "String" }`
Maßeinheit.Betrag	Betrag der Maßeinheit. Datentyp: Zahl
Maßeinheit.ID	Sys_id der Maßeinheit. Tabelle: Preislistenpositionen [sn_csm_ Pricing_Price_list_line] Datentyp: Zeichenfolge
Maßeinheit.Einheiten	Typ der Maßeinheit, die der Preislistenposition zugeordnet ist. Zum Beispiel `Jahr` oder `Bündel`. Datentyp: Zeichenfolge
Preis	Listenpreisdetails der Preislistenposition. Datentyp: Objekt `"price": { "units": "String", "value": "String" }`
Preis.Einheiten	Währungscode des Preises. Zum Beispiel `USD` oder `EUR`. Tabelle: Währung [fx_currency] Datentyp: Zeichenfolge
Preis.Wert	Wert des Preises. Datentyp: Zeichenfolge (dargestellt durch eine Zahl)
priceList	Preislisteninformationen, die der Preislistenposition zugeordnet sind. Datentyp: Objekt `"priceList": { "id": "String", "name": "String", "@type": "String" }`
PriceList.ID	Sys_id der Preisliste in der Tabelle „Preisliste“ [sn_csm_pricing_Price_list] Datentyp: Zeichenfolge
preisliste.name	Name der Preisliste. Datentyp: Zeichenfolge
preisliste.@typ	Der Typ der Preisliste. Bei der Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Hat immer den Wert `PriceList`. Datentyp: Zeichenfolge
@type	Immer ein Wert von `ProductOfferingPrice`. Bei der Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Datentyp: Zeichenfolge
state	Status der Preisliste, die dieser Preislistenposition zugeordnet ist. Datentyp: Zeichenfolge
externalId	Die externe ID dieser Preislistenposition. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Beispiel wird gemäß den im Anforderungstext angegebenen Daten ein neuer Preislistenpositionsdatensatz erstellt und in die Tabelle „Preislistenposition“ [sn_csm_pricing_Price_list_line] eingefügt.

curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice " \
--request POST\
--user 'username':'password'
--data {
  "name": "new Price list",
  "validFor": {
    "startDateTime": "2024-05-28 15:15:58",
    "endDateTime": "2025-06-28 15:15:58"
  },
  "priceType": "recurring",
  "recurringChargePeriodType": "monthly",
  "lastUpdate": "2023-09-23 00:00:00",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "unit": "USD",
    "value": "800"
  },
  "productOffering": {
    "id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
    "name": "Maintenance Fee",
    "internalVersion": "1"
  },
  "priceList": {
    "name": "new price list",
    "@type": "priceList"
  },
  "externalId": "test123",
  "@type": "ProductOfferingPrice"
}

Antworttext. Diesem neuen Datensatz für die Preislistenposition wird eine eindeutige ID zugewiesen. Der Antworttext gibt diese Informationen zusammen mit einer URL zum neuen Datensatz unter Verwendung des Antwortparameters href zurück.

{
  "name": "new Price list",
  "validFor": {
    "startDateTime": "2024-05-28 15:15:58",
    "endDateTime": "2025-06-28 15:15:58"
  },
  "priceType": "recurring",
  "recurringChargePeriodType": "monthly",
  "lastUpdate": "2023-09-23 00:00:00",
  "isBundle": false,
  "lifecycleStatus": "Draft",
  "unitOfMeasure": {
    "id": "1eaa559953020110286eddeeff7b12c7",
    "amount": 1,
    "units": "Year"
  },
  "price": {
    "unit": "USD",
    "value": "800"
  },
  "productOffering": {
    "id": "9e3dd57a4fcb5210f899f61d20ce0bf2",
    "name": "Maintenance Fee",
    "internalVersion": "1"
  },
  "priceList": {
    "id": "194d5d364f8b5210f899f61d20ce0b7a",
    "name": "new Price list",
    "@type": "priceList"
  },
  "externalId": "test123",
  "@type": "ProductOfferingPrice",
  "id": "994d5d364f8b5210f899f61d20ce0b7c",
  "state": "draft",
  "href": "/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c"
}

Produktkatalog – Open API – POST /sn_tmf_api/catalogmanagement/productSpecification

Erstellt eine Produktspezifikation.

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/productSpecification

Unterstützte Anforderungsparameter

Tabelle : 103. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 104. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 105. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
description	Erforderlich. Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externalId	Eindeutiger Bezeichner für die Produktspezifikation aus dem externen System. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Erforderlich. Anfangsversion oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: In initial_version oder external_id der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification].
internalId	Erforderlich. Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
lastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Standard: Leere Zeichenfolge
name	Erforderlich. Name der Spezifikation. Datentyp: Zeichenfolge
produktSpecFeature	Spezifikationsmerkmal. Datentyp: Array von Objekten `"productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]`
produktSpezifikationsmerkmal.beschreibung	Beschreibung des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
productSpecCharacteristic.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
produktspezifikationsmerkmal.produktspezifikationsmerkmalwert	Erforderlich. Mögliche Werte des Merkmals. Datentyp: Array `"productSpecCharacteristicValue": [ { "value": "String" } ]`
Produktspezifikationsmerkmal.Produktspezifikationsmerkmalwert.Wert	Erforderlich. Wert des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacterific.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
produktSpecCharacterific.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Standard: Leere Zeichenfolge
produktSpecCharacterific.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Standard: Leere Zeichenfolge
produktSpezifikationsmerkmal.wertTyp	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
productSpecificationRelationship	Die Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array `"productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]`
productSpecificationRelationship.id	ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
productSpecificationRelationship.type	Erforderlich, wenn der Parameter productSpecificationRelationship verwendet wird. Typ der Beziehung. Gültige Werte: Pakete Bestehend aus Datentyp: Zeichenfolge
productSpecificationRelationship.validFor	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
productSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Standard: Leere Zeichenfolge
productSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Standard: Leere Zeichenfolge
resourceSpecification	Erforderlich. Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Erforderlich. Anfangsversion oder externe ID der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_id“ oder „external_id“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.internalId	Anfangsversion der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpezifikation.interneVersion	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Ressourcenspezifikation [sn_prd_pm_resource_specification]
resourceSpecification.version	Externe Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
serviceSpecification	Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
serviceSpecification.id	Anfangsversion oder externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneID	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_service_specification]
serviceSpezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
validFor	Erforderlich. Datumsbereich, für den diese Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Standard: Leere Zeichenfolge
validFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00. Beispiel: `2025-01-31 09:35:43`. Standard: Leere Zeichenfolge
version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]

Header

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

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

Tabelle : 107. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 108. Statuscodes
Statuscode	Beschreibung
201	Anforderung erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt:<field name>

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
description	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
href	Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Anfangsversion oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version oder external_id der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalId	Erforderlich. Anfangsversion der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
internalVersion	Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]
isBündel	Kennzeichnung, die angibt, ob productSpecification für ein einzelnes Produkt oder ein Bündel von Produkten steht. Gültige Werte: „wahr“: Die Produktspezifikation ist ein Produktbündel und enthält mehrere Produkte. „falsch“: Die Produktspezifikation enthält ein einzelnes Produkt. Datentyp: Boolesch Standardwert: false
lastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00.
LifecycleStatus	Aktueller Lebenszyklusstatus der Produktspezifikation. Mögliche Werte: Aktiv Entwurf Inaktiv Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
name	Name der Spezifikation. Datentyp: Zeichenfolge
produktSpecFeature	Spezifikationsmerkmal. Datentyp: Array von Objekten `"productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": [Array], "validFor": {Object}, "valueType": "String" } ]`
produktSpezifikationsmerkmal.beschreibung	Beschreibung des Merkmals. Datentyp: Zeichenfolge
produktSpezifikationsmerkmal.name	Name des Merkmals. Datentyp: Zeichenfolge
produktspezifikationsmerkmal.produktspezifikationsmerkmalwert	Mögliche Werte des Merkmals. Datentyp: Array von Objekten `"productSpecCharacteristicValue": [ { "value": "String" } ]`
Produktspezifikationsmerkmal.Produktspezifikationsmerkmalwert.Wert	Wert des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacterific.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
produktSpecCharacterific.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00.
produktSpecCharacterific.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00.
produktSpezifikationsmerkmal.wertTyp	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
productSpecificationRelationship	Die Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten `"productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]`
productSpecificationRelationship.id	Sys_id der zugehörigen Spezifikation. Datentyp: Zeichenfolge
productSpecificationRelationship.type	Typ der Beziehung. Datentyp: Zeichenfolge
productSpecificationRelationship.validFor	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
productSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00.
productSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00.
resourceSpecification	Liste der Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Anfangsversion oder externe ID der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_id“ oder „external_id“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.internalId	Anfangsversion der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpezifikation.interneVersion	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Ressourcenspezifikation [sn_prd_pm_resource_specification]
resourceSpecification.version	Externe Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]
serviceSpecification	Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten `"serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
serviceSpecification.id	Anfangsversion oder externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneID	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_version der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpezifikation.interneVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Versionsfeld der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
serviceSpecification.name	Name der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_service_specification]
serviceSpezifikation.version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
validFor	Datumsbereich, für den diese Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00.
validFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge Format: JJJJ-MM-TT 00:00:00.
version	Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_version der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]

cURL-Anforderung

In diesem Beispiel wird eine Produktspezifikation erstellt.

curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification" \
--header "Content-Type: application/json" \
--data-raw '{
   "name": "SD-WAN My Device",
   "description": "This is my product specification ...",
   "internalId": "1c3c9a325bc34110235d85cced81c7d5",
   "isBundle": false,
   "lastUpdate": "2017-06-17T00:00",
   "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
   },
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "label",
         "validFor": {
            "startDateTime": "2017-06-20T00:00"
         },
         "productSpecCharacteristicValue": [
            {
               "validFor": {
                  "startDateTime": "2017-06-17T00:00"
               },
               "value": "TestValue"
            }
         ]
      }
   ],
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "type": "bundles",
         "validFor": {
            "startDateTime": "2017-06-16T00:00"
         }
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router"
      }
   ]
}'
--user 'username':'password'

Antworttext.

{
   "id": "exter123",
   "name": "SD-WAN My Device",
   "version": "v1",
   "internalId": "63c3d946745d8150f877ca57242ff918",
   "description": "This is my product specification ...",
   "isBundle": false,
   "lastUpdate": "2017-06-17T00:00",
   "validFor": {
      "startDateTime": "2017-06-19T00:00",
      "endDateTime": "2018-01-13T00:00"
   },
   "productSpecCharacteristic": [
      {
         "name": "New characteristic",
         "description": "This product has new spec characteristic.",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-06-20T00:00"
         },
         "productSpecCharacteristicValue": [
            {
               "validFor": {
                  "startDateTime": "2017-06-17T00:00"
               },
               "value": "TestValue"
            }
         ]
      }
   ],
   "serviceSpecification": [
      {
         "id": "e23ae2d01bb420106ba59acf034bcb56",
         "name": "IP Sec Tunnel",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "e23ae2d01bb420106ba59acf034bcb56"
      }
   ],
   "productSpecificationRelationship": [
      {
         "id": "a6514bd3534560102f18ddeeff7b1247",
         "name": "SD-WAN Security",
         "type": "bundles",
         "validFor": {
            "startDateTime": "2017-06-16T00:00"
         },
         "valid": true,
         "version": "v1",
         "internalVersion": "1",
         "internalId": "a6514bd3534560102f18ddeeff7b1247"
      }
   ],
   "resourceSpecification": [
      {
         "id": "493fa60b536520103b6bddeeff7b12b6",
         "name": "Customer Premise SD-WAN Router",
         "version": "v1",
         "internalVersion": "1",
         "internalId": "493fa60b536520103b6bddeeff7b12b6"
      }
   ]
}