Produktkatalog – API öffnen
Die Produktkatalog Offen Die API stellt Endpunkte zum Erstellen und Abrufen von Produktkatalogen, Produktangeboten und Produktspezifikationen bereit.
Verwenden Sie diese API, um Produktkataloginformationen zwischen externen Systemen und zu verwalten ServiceNow AI Platform. Die Produktkatalog Offen API ist ein ServiceNow® Implementierung der REST-Spezifikation der TM Forum-Produktkatalog-Management-API. Diese Implementierung basiert auf TMF620 Produktkatalog-Management API REST-Spezifikation Version 4 , April 2021.
Diese API ist in der Anwendung „Produktkatalog Advanced“ enthalten, die auf verfügbar ist ServiceNow Store.
Diese API wird in bereitgestellt sn_tmf_api Namespace.
Der aufrufende Anwender muss über die Rolle sn_prd_pm_adv.catalog_integrator verfügen.
- Merkmal [sn_prd_pm_Merkmal]
- Merkmalsoption [sn_prd_pm_characteristic_Option]
- Produktangebot [sn_prd_pm_Product_offering]
- Produktangebotskatalog [sn_prd_pm_Product_offering_catalog]
- Produktangebotsmerkmal [sn_prd_pm_Product_offering_Merkmal]
- Produktspezifikation [sn_prd_pm_Product_Specification]
- Spezifikationsbeziehung [sn_prd_pm_Specification_Relationship]
Produktkatalog – API öffnen – /sn_tmf_api/catalogManagement/productOffering/{ID} LÖSCHEN
Löscht das angegebene Produktangebot.
URL-Format
Standard-URL: /api/sn_tmf_api/catalogmanagement/productOffering/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID des zu löschenden Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
Antworttext-Parameter (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 d6f8d995b020210235d85cced81c7eb 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 Nachricht zum erfolgreichen Löschen zurück:
"The product offering (d6f8d9995b020210235d85cced81c7eb) is successfully deleted"
Produktkatalog – API öffnen – /sn_tmf_api/catalogManagement/productOfferingPrice/{ID} LÖSCHEN
Deaktiviert eine Preislistenposition mit einer bestimmten sys_ID, löscht sie aber nicht
URL-Format
Standard-URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID der zu löschenden Preislistenposition. Tabelle: Preislistenposition [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Antworttext-Parameter (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 können...
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOfferingPrice/994d5d364f8b5210f899f61d20ce0b7c" \
--request DELETE\
--user 'username':'password'
Antwort. Die Antwort gibt einen Statuscode 200 mit Details zur erfolgreichen Deaktivierung zurück.
Status: 200 OK
"The price list line (994d5d364f8b5210f899f61d20ce0b7c) is inactive successfully"
Produktkatalog – API öffnen – /sn_tmf_api/catalogManagement/ProductSpecification/{ID} LÖSCHEN
Löscht oder archiviert die angegebene Produktspezifikation.
- Eine Produktspezifikation im Entwurfsstatus wurde erfolgreich gelöscht. Die 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 zurück.
URL-Format
Standard-URL: /sn_tmf_api/catalogManagement/ProductSpecification/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | SYS_ID der zu löschenden Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt. |
Antworttext-Parameter (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 – API öffnen – 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
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Datentyp: Zeichenfolge Standard: Alle Felder zurückgegeben. |
| limit | Maximale Anzahl der zurückzugebenden Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 20 Maximum: 100 |
| Offset | Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Datentyp: Zahl Standard: 0 |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltsbereich | Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn |
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
|
| X-Gesamtzahl | Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung). |
| 206 | Teilressource als Antwort zurückgegeben (mit Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Beschreibung | Beschreibung des Produktangebotskatalogs. Wird nur zurückgegeben, wenn das Feld einen Wert enthält. Datentyp: Zeichenfolge |
| id | SYS_ID des Produktangebotskatalogs. Datentyp: Zeichenfolge Tabelle: Produktangebotskatalog [sn_prd_pm_Product_offering_catalog] |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus der Preislistenposition. Gültige Werte:
Datentyp: Zeichenfolge |
| name | Name des Produktangebotskatalogs. Datentyp: Zeichenfolge |
| status | Status des Produktangebotskatalogs. Möglicher Wert: Veröffentlicht 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": "341f4953b71a9910ff00f203ae11a9bb",
"name": "Home Internet Plan",
"lifecycleStatus": "Active",
"status": "published"
},
{
"id": "69f494792b11525047f3f3e30391bf66",
"name": "Chemical Processing",
"lifecycleStatus": "Active",
"description": " Catalog for Chemical Processing Industry",
"status": "published"
}
]
Produktkatalog – API öffnen – 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
| Name | Beschreibung |
|---|---|
| id | SYS_ID des abzurufenden Produktangebotskatalogs. Datentyp: Zeichenfolge Tabelle: Produktangebotskatalog [sn_prd_pm_Product_offering_catalog] |
| Name | Beschreibung |
|---|---|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Datentyp: Zeichenfolge Standard: Alle Felder. |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Beschreibung | Beschreibung des Produktangebotskatalogs. Datentyp: Zeichenfolge |
| id | SYS_ID des Produktangebotskatalogs. Datentyp: Zeichenfolge Tabelle: Produktangebotskatalog [sn_prd_pm_Product_offering_catalog] |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus der Preislistenposition. Gültige Werte:
Datentyp: Zeichenfolge |
| name | Name des Produktangebotskatalogs. Datentyp: Zeichenfolge |
cURL-Anforderung
In diesem Beispiel wird ein Produktangebotskatalog für einen mobilen Enterprise-Plan abgerufen.
curl --location --request GET "https://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/catalog/69f494792b11525047f3f3e30391bf66" \
--user 'username':'password'
Antworttext.
{
"id": "69f494792b11525047f3f3e30391bf66",
"name": "Chemical Processing",
"lifecycleStatus": "Active",
"description": " Catalog for Chemical Processing Industry"
}
Produktkatalog – API öffnen – GET /sn_tmf_api/catalogManagement/productOffering
Ruft alle Produktangebote oder eine Teilmenge von Produktangeboten basierend auf den angegebenen Filtereinstellungen ab.
URL-Format
Standard-URL: /api/sn_tmf_api/catalogManagement/productOffering
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder:
Datentyp: Zeichenfolge Standard: Alle Felder werden zurückgegeben. |
| limit | Maximale Anzahl der zurückzugebenden Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 20 Maximum: 100 |
| Offset | Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Datentyp: Zahl Standard: 0 |
| Spezifikation | Produktangebote nach Produktspezifikation sys_ID filtern Nur Produktangebote mit der angegebenen Produktspezifikation sys_ID werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| Status | Filtern Sie Produktangebote nach Status. Nur Produktangebote im angegebenen Status werden in der Antwort zurückgegeben. Gültige Werte:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltsbereich | Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn |
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
|
| X-Gesamtzahl | Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung). |
| 206 | Teilressource als Antwort zurückgegeben (mit Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| GebündeltGroupProductOffering | Untergeordnete Gruppen von Produktangeboten. Diese zeigen eine hierarchische Untergruppierung an. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption | Ein Nummernbereich, der die unteren und oberen Grenzwerte der Anzahl des zugehörigen Produktangebots angibt, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Objekt |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferLowerLimit | Untergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferUpperLimit | Obergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. GebündeltProduktangebot | Untergeordnete Gruppen von Produktangeboten, die dem Paket zugeordnet sind. Dasselbe Format wie bundledProductOfferingUnten angegeben. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. id | SYS_ID des Datensatzes der gebündelten Gruppe. Nützlich in Fällen, in denen das übergeordnete Produktangebot oder die übergeordnete Gruppe mehrere Gruppen enthält. Datentyp: Zeichenfolge Tabelle: Produktangebots-Beziehungsgruppe [sn_prd_pm_Product_offering_Relationship_Group] |
| GebündeltGroupProductOffering. Name | Name der Gruppe der untergeordneten Produktangebote. Datentyp: Zeichenfolge |
| GebündeltProduktangebot | Liste der Produktangebote, die im Produktangebotspaket enthalten sind. Das Produktangebotspaket erbt alle Attribute der enthaltenen Produktangebote. Datentyp: Array von Objekten |
| GebündeltProduktangebot. GebündeltProduktangebotsOption | Produktpaketoptionen wie die Standardanzahl von Produktangeboten und alle oberen und unteren Beschaffungsbeschränkungen für Produktangebote. Datentyp: Objekt |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NumberRelOfferStandard | Standardanzahl der Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots erworben werden sollen. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferLowerLimit | Untergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferUpperLimit | Obergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. ExternalID | Externe ID der Produktangebotsbeziehung . Weitere Informationen zu Produktangebotsbeziehungen finden Sie unter Create product offering relationships. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Href | Relativer Link zum zugehörigen Produktangebot. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. id | SYS_ID oder externe ID des gebündelten Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| GebündeltProduktangebot. Name | Name des Produktangebotspakets. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Version | Katalogversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Kategorie | Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten |
| Kategorie.ID | ID der Kategorie. Datentyp: Zeichenfolge |
| category.name | Name der Kategorie. Datentyp: Zeichenfolge |
| Kanal | Kanäle, die für den Verkauf des Produktangebots verwendet werden sollen. Datentyp: Array von Objekten |
| channel.description | Beschreibung des Kanals. Datentyp: Zeichenfolge |
| Kanal.ID | SYS_ID des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_Distribution_Channel] |
| channel.name | Name des Kanals. Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Produktangebots. Datentyp: Zeichenfolge |
| displayName | Anzeigename 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 | SYS_ID oder interne ID des Produktangebotsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| InternalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| IsBundle | Kennzeichnung, die angibt, ob das Produktangebot ein Paket ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Ist verkaufbar | Kennzeichnung, die angibt, ob das zugehörige Produktangebot selbst verkauft werden kann oder Teil eines Produktangebots sein muss. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus des Produktangebots. Gültige Werte:
Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| name | Name des Produktangebots. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden | Produktangebotsmerkmale. Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Name |
Name des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. Validiertfür. StartDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. Wertetyp | Datentyp von prodSpecCharValueUse.productSpecCharacteristicValue.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| Produktmerkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten |
| Produktmerkmal. Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal. Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal | Merkmalsqualität oder Unterscheidungsmerkmal eines Produktangebots. Merkmale können einen diskreten Wert annehmen, der zum Designzeitpunkt (Katalogerstellung) festgelegt ist, z. B. „Mobile Planrang“. Diese Merkmale können im Allgemeinen nicht auf Bestandsebene geändert werden. Weitere Informationen zu Produktangebotsmerkmalen finden Sie unter Create product characteristics and characteristic options. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification | Liste der Merkmalswerte, die dem Produktangebotsmerkmal zugeordnet sind. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das zugeordnete Merkmal ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert für das zugeordnete Merkmal obligatorisch ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Wert | Nummer oder Text, die dem zugehörigen Produktspezifikationsmerkmal zugewiesen ist. Zum Beispiel: Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Name | Name des zugehörigen Produktangebotsmerkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Wertetyp | Datentyp von productOfferingCharacteristic.characteristicValueSpecification.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProductOfferingPreis | Preisinformationen für das Produktangebot. Datentyp: Array von Objekten |
| ProductOfferingPreis. Preis | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProductOfferingPreis. Preis.taxIncludedAmount | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProduktangebotPreis.Preis.TaxIncludedAmount.unit | Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge |
| ProduktangebotPreis.Preis.TaxIncludedAmount.value | Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge |
| ProductOfferingPreis. Preistyp | Typ des Produktangebotspreises, einmalige oder wiederkehrende Zahlung. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProductOfferingTerm | Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge |
| Produktspezifikation | Produktspezifikation für das Produkt. Datentyp: Objekt |
| Produktspezifikation. id | SYS_ID des Produktspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktspezifikation. Interne ID | SYS_ID oder interne ID des Produktspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktspezifikation. InternalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| Produktspezifikation. Name | Name der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Namensfeld 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]. |
| status | Status des Produktangebots. Mögliche Werte:
Datentyp: Zeichenfolge |
| Validiertfür | Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt |
| Validiertfür. EndDateTime | Enddatum des Produktangebots. Datentyp: Zeichenfolge FORMAT: JJJ-MM-TT |
| ValidFor.startDateTime | Startdatum des Produktangebots. Datentyp: Zeichenfolge FORMAT: JJJ-MM-TT |
| Version | Externe Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
Das folgende Codebeispiel ruft die ersten beiden Produktangebotsdatensätze ab.
curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering?limit=2" \
--header "Accept:application/json" \
--user 'username':'password'
Antworttext:
[
{
"id": "7b012c4d41ea7910f8771355f12634a4",
"externalId": "7b012c4d41ea7910f8771355f12634a4",
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/0361dd9fd0a63110f8770dbf976be16f",
"name": "Ultimate internet - 1Gbps Plan",
"displayName": "Ultimate internet - 1Gbps Plan",
"description": "Ultimate internet - 1Gbps Plan",
"isSellable": true,
"lifecycleStatus": "Active",
"isBundle": false,
"lastUpdate": "2025-03-08 02:07:04",
"version": "",
"internalVersion": "1",
"internalId": "0361dd9fd0a63110f8770dbf976be16f",
"validFor": {
"startDateTime": "2023-11-14",
"endDateTime": ""
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
}
],
"productOfferingCharacteristic": "",
"bundledProductOffering": [],
"bundledGroupProductOffering": [],
"productSpecification": {},
"prodSpecCharValueUse": [],
"channel": "",
"category": [
{
"id": "e6f0159fd0a63110f8770dbf976be18c",
"name": "Internet"
}
],
"status": "published"
},
{
"id": "313b917843235210a82ed6085bb8f2c7",
"externalId": "313b917843235210a82ed6085bb8f2c7",
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11",
"name": "Internet bundle",
"displayName": "Internet bundle",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-04-09 15:59:09",
"version": "",
"internalVersion": "1",
"internalId": "03c99cb53bf066509b48d69a04e45a11",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"isMandatory": false,
"isDefault": false,
"value": "When in use"
}
]
},
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"isMandatory": false,
"isDefault": true,
"value": "Premium"
}
]
}
],
"bundledProductOffering": [
{
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/57c99cb53bf066509b48d69a04e45a17",
"id": "0f61dd9fd0a63110f8770dbf976be168",
"externalId": "EXT-123",
"name": "Solana Sports streaming channel",
"version": "1",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/5bc99cb53bf066509b48d69a04e45a1a",
"id": "62619d9fd0a63110f8770dbf976be180",
"externalId": "EXT-345",
"name": "Solana Movie streaming channel",
"version": "1",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2025-02-27 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "Base (10 site)",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft"
}
]
Produktkatalog – API öffnen – 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
| Name | Beschreibung |
|---|---|
| id | Anfängliche Version des abzurufenden Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Name | Beschreibung |
|---|---|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder:
Datentyp: Zeichenfolge Standard: Alle Felder werden zurückgegeben. |
| Spezifikation | Produktangebote nach Produktspezifikation sys_ID filtern Nur Produktangebote mit der angegebenen Produktspezifikation sys_ID werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| Status | Filtern Sie Produktangebote nach Status. Nur Produktangebote im angegebenen Status werden in der Antwort zurückgegeben. Gültige Werte:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 |
Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| GebündeltGroupProductOffering | Untergeordnete Gruppen von Produktangeboten. Diese zeigen eine hierarchische Untergruppierung an. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption | Ein Nummernbereich, der die unteren und oberen Grenzwerte der Anzahl des zugehörigen Produktangebots angibt, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Objekt |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferLowerLimit | Untergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferUpperLimit | Obergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. GebündeltProduktangebot | Untergeordnete Gruppen von Produktangeboten, die dem Paket zugeordnet sind. Dasselbe Format wie bundledProductOfferingUnten angegeben. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. id | SYS_ID des Datensatzes der gebündelten Gruppe. Nützlich in Fällen, in denen das übergeordnete Produktangebot oder die übergeordnete Gruppe mehrere Gruppen enthält. Datentyp: Zeichenfolge Tabelle: Produktangebots-Beziehungsgruppe [sn_prd_pm_Product_offering_Relationship_Group] |
| GebündeltGroupProductOffering. Name | Name der Gruppe der untergeordneten Produktangebote. Datentyp: Zeichenfolge |
| GebündeltProduktangebot | Liste der Produktangebote, die im Produktangebotspaket enthalten sind. Das Produktangebotspaket erbt alle Attribute der enthaltenen Produktangebote. Datentyp: Array von Objekten |
| GebündeltProduktangebot. GebündeltProduktangebotsOption | Produktpaketoptionen wie die Standardanzahl von Produktangeboten und alle oberen und unteren Beschaffungsbeschränkungen für Produktangebote. Datentyp: Objekt |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NumberRelOfferStandard | Standardanzahl der Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots erworben werden sollen. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferLowerLimit | Untergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferUpperLimit | Obergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. ExternalID | Externe ID der Produktangebotsbeziehung . Weitere Informationen zu Produktangebotsbeziehungen finden Sie unter Create product offering relationships. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Href | Relativer Link zum zugehörigen Produktangebot. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. id | SYS_ID oder externe ID des gebündelten Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| GebündeltProduktangebot. Name | Name des Produktangebotspakets. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Version | Katalogversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Kategorie | Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten |
| Kategorie.ID | SYS_ID der Kategorie. Datentyp: Zeichenfolge |
| category.name | Name der Kategorie. Datentyp: Zeichenfolge |
| Kanal | Kanäle, die für den Verkauf des Produktangebots verwendet werden sollen. Datentyp: Array von Objekten |
| Kanal. Beschreibung | Beschreibung des Kanals. Datentyp: Zeichenfolge |
| Kanal.ID | SYS_ID des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_Distribution_Channel] |
| channel.name | Name des Kanals. Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Produktangebots. Datentyp: Zeichenfolge |
| displayName | Anzeigename 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 | SYS_ID oder interne ID des Produktangebotsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| InternalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| IsBundle | Kennzeichnung, die angibt, ob das Produktangebot ein Paket ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Ist verkaufbar | Kennzeichnung, die angibt, ob das zugehörige Produktangebot selbst verkauft werden kann oder Teil eines Produktangebots sein muss. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH-mm-SS |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus des Produktangebots. Mögliche Werte:
Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| name | Name des Produktangebots. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden | Produktangebotsmerkmale. Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Name |
Name des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. Validiertfür. StartDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. Wertetyp | Datentyp von prodSpecCharValueUse.productSpecCharacteristicValue.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| Produktmerkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten |
| Produktmerkmal. Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal. Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal | Merkmalsqualität oder Unterscheidungsmerkmal eines Produktangebots. Merkmale können einen diskreten Wert annehmen, der zum Designzeitpunkt (Katalogerstellung) festgelegt ist, z. B. „Mobile Planrang“. Diese Merkmale können im Allgemeinen nicht auf Bestandsebene geändert werden. Weitere Informationen zu Produktangebotsmerkmalen finden Sie unter Create product characteristics and characteristic options. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification | Liste der Merkmalswerte, die dem Produktangebotsmerkmal zugeordnet sind. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das zugeordnete Merkmal ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert für das zugeordnete Merkmal obligatorisch ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Wert | Nummer oder Text, die dem zugehörigen Produktspezifikationsmerkmal zugewiesen ist. Zum Beispiel: Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Name | Name des zugehörigen Produktangebotsmerkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Wertetyp | Datentyp von productOfferingCharacteristic.characteristicValueSpecification.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProductOfferingPreis | Preisinformationen für das Produktangebot. Datentyp: Array von Objekten |
| ProductOfferingPreis. Preis | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProductOfferingPreis. Preis. TaxIncludedAmount | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProductOfferingPreis. Preis. TaxIncludedAmount. Einheit | Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge |
| ProductOfferingPreis. Preis. TaxIncludedAmount. Wert | Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge |
| ProductOfferingPreis. Preistyp | Gibt an, ob der Produktangebotspreis eine einmalige oder wiederkehrende Zahlung ist. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProductOfferingTerm | Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge |
| Produktspezifikation | Produktspezifikation für das Produkt. Datentyp: Objekt |
| Produktspezifikation. id | SYS_ID des Produktspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktspezifikation. Interne ID | SYS_ID oder interne ID des Produktspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktspezifikation. InternalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| Produktspezifikation. Name | Name der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Namensfeld 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]. |
| status | Status des Produktangebots. Mögliche Werte:
Datentyp: Zeichenfolge |
| Validiertfür | Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt |
| Validiertfür. EndDateTime | Enddatum des Produktangebots. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| Validiertfür. StartDateTime | Startdatum des Produktangebots. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| 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 das angegebene Produktangebot abgerufen.
curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11"
--user 'username':'password'
Antworttext:
{
"id": "313b917843235210a82ed6085bb8f2c7",
"externalId": "313b917843235210a82ed6085bb8f2c7",
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11",
"name": "Internet bundle",
"displayName": "Internet bundle",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-04-09 15:59:09",
"version": "",
"internalVersion": "1",
"internalId": "03c99cb53bf066509b48d69a04e45a11",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": 0
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"isMandatory": false,
"isDefault": false,
"value": "When in use"
}
]
},
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"isMandatory": false,
"isDefault": true,
"value": "Premium"
}
]
}
],
"bundledProductOffering": [
{
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/57c99cb53bf066509b48d69a04e45a17",
"id": "0f61dd9fd0a63110f8770dbf976be168",
"externalId": "EXT-123",
"name": "Solana Sports streaming channel",
"version": "1",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/5bc99cb53bf066509b48d69a04e45a1a",
"id": "62619d9fd0a63110f8770dbf976be180",
"externalId": "EXT-345",
"name": "Solana Movie streaming channel",
"version": "1",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2025-02-27 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "Base (10 site)",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft"
}
Produktkatalog – API öffnen – 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
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Letztes Update | Filtern Sie die Ergebnisse nach dem Datum, an dem die Preisposition 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_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_price_list] Datentyp: Zeichenfolge |
| Preistyp | Filtern Sie Ergebnisse nach der Preisgestaltungsmethode des Produktangebots. Gültige Werte:
Datentyp: Zeichenfolge |
| ProductOffering. id | Filtern Sie die Preislistenposition nach der sys_ID des Produktangebots Tabelle: Produktangebot [sn_prd_pm_Product_offering] Datentyp: Zeichenfolge |
| Maßeinheit. id | Filtern Sie die Preislistenposition nach sys_ID der Maßeinheit. Tabelle: Preislistenpositionen [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| Validiertfür. EndDateTime | Filtern Sie die Preislistenposition nach einem bestimmten Enddatum und einer bestimmten Endzeit. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge |
| Validiertfür. StartDateTime | Filtern Sie die Preislistenposition nach einem bestimmten Startdatum und einer bestimmten Startzeit. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| @TYPE | Typ der Preislistenposition. Immer ein Wert von ProduktangebotPreis .Datentyp: Zeichenfolge |
| href | URL zum Preislistenpositionsdatensatz in der Instanz. Datentyp: Zeichenfolge |
| id | SYS_ID der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| IsBundle | Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktpakets ist. Gültige Werte:
Datentyp: Boolesch |
| Letztes Update | Datum und Uhrzeit der letzten Aktualisierung der Preislistenposition. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus der Preislistenposition. Gültige Werte:
Datentyp: Zeichenfolge |
| Preis | Listenpreisdetails der Preislistenposition. Datentyp: Objekt |
| Preis.Einheiten | Währungscode des Preises. 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 |
| Preisliste.ID | SYS_ID der Preisliste in der Tabelle „Preisliste“ [sn_csm_price_list]. Datentyp: Zeichenfolge |
| priceList.name | Name der Preisliste. Datentyp: Zeichenfolge |
| Preisliste.@type | Der Typ der Preisliste. Bei Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Hat immer einen Wert von Preisliste .Datentyp: Zeichenfolge |
| Preistyp | Die Preismethode des Produktangebots, das dieser Preislistenposition zugeordnet ist. Mögliche Werte:
Datentyp: Zeichenfolge |
| productOffering | Produktangebot, das der Preislistenposition zugeordnet ist. Datentyp: Objekt |
| Produktangebot.ID | SYS_ID des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| ProductOffering. InternalVersion | Interne Versionsnummer des Produktangebots. Beispiel: PRDOF01024 . Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].Datentyp: Zeichenfolge |
| ProductOffering. Name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| RecurringChargePeriodType | Die Periodizität oder Häufigkeit des Produktangebots, das dieser Preislistenposition zugeordnet ist. Gibt einen Häufigkeitstyp zurück, wenn priceTypeWurde auf festgelegt Wiederkehrend , Andernfalls wird eine leere Zeichenfolge zurückgegeben.Mögliche Werte:
Datentyp: Zeichenfolge |
| Maßeinheit | Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt |
| EinheitenMessung.Betrag | Betrag der Maßeinheit. Datentyp: Zahl |
| EinheitenMessung.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. Beispiel: Jahr Oder Paket .Datentyp: Zeichenfolge |
| Validiertfür | Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt |
| 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
Das folgende Beispiel gibt alle zwei Preislistenpositionen zurück, 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"
}
]
Produktkatalog – API öffnen – 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
| Name | Beschreibung |
|---|---|
| id | Erforderlich. SYS_ID der abzurufenden Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Letztes Update | Filtern Sie die Ergebnisse nach dem Datum, an dem die Preisposition 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_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_price_list] Datentyp: Zeichenfolge |
| Preistyp | Filtern Sie Ergebnisse nach der Preisgestaltungsmethode des Produktangebots. Gültige Werte:
Datentyp: Zeichenfolge |
| ProductOffering. id | Filtern Sie die Preislistenposition nach der sys_ID des Produktangebots Tabelle: Produktangebot [sn_prd_pm_Product_offering] Datentyp: Zeichenfolge |
| Maßeinheit. id | Filtern Sie die Preislistenposition nach sys_ID der Maßeinheit. Tabelle: Preislistenpositionen [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| Validiertfür. EndDateTime | Filtern Sie die Preislistenposition nach einem bestimmten Enddatum und einer bestimmten Endzeit. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge |
| Validiertfür. StartDateTime | Filtern Sie die Preislistenposition nach einem bestimmten Startdatum und einer bestimmten Startzeit. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| @TYPE | Typ der Preislistenposition. Immer ein Wert von ProduktangebotPreis .Datentyp: Zeichenfolge |
| href | URL zum Preislistenpositionsdatensatz in der Instanz. Datentyp: Zeichenfolge |
| id | SYS_ID der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| IsBundle | Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktpakets ist. Gültige Werte:
Datentyp: Boolesch |
| Letztes Update | Datum und Uhrzeit der letzten Aktualisierung der Preislistenposition. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus der Preislistenposition. Gültige Werte:
Datentyp: Zeichenfolge |
| Preis | Listenpreisdetails der Preislistenposition. Datentyp: Objekt |
| Preis.Einheiten | Währungscode des Preises. 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 |
| Preisliste.ID | SYS_ID der Preisliste in der Tabelle „Preisliste“ [sn_csm_price_list]. Datentyp: Zeichenfolge |
| priceList.name | Name der Preisliste. Datentyp: Zeichenfolge |
| Preisliste.@type | Der Typ der Preisliste. Bei Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Hat immer einen Wert von Preisliste .Datentyp: Zeichenfolge |
| Preistyp | Die Preismethode des Produktangebots, das dieser Preislistenposition zugeordnet ist. Mögliche Werte:
Datentyp: Zeichenfolge |
| productOffering | Produktangebot, das der Preislistenposition zugeordnet ist. Datentyp: Objekt |
| Produktangebot.ID | SYS_ID des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| ProductOffering. InternalVersion | Interne Versionsnummer des Produktangebots. Beispiel: PRDOF01024 . Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].Datentyp: Zeichenfolge |
| ProductOffering. Name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| RecurringChargePeriodType | Die Periodizität oder Häufigkeit des Produktangebots, das dieser Preislistenposition zugeordnet ist. Gibt einen Häufigkeitstyp zurück, wenn priceTypeWurde auf festgelegt Wiederkehrend , Andernfalls wird eine leere Zeichenfolge zurückgegeben.Mögliche Werte:
Datentyp: Zeichenfolge |
| Maßeinheit | Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt |
| EinheitenMessung.Betrag | Betrag der Maßeinheit. Datentyp: Zahl |
| EinheitenMessung.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. Beispiel: Jahr Oder Paket .Datentyp: Zeichenfolge |
| Validiertfür | Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt |
| 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
Das folgende Beispiel gibt Details zum Produktangebotspreis mit der ID dfb7ec60 zurück...
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"
}
Produktkatalog – API öffnen – GET /sn_tmf_api/catalogManagement/ProductSpecification
Ruft alle Produktspezifikationsdatensätze ab.
URL-Format
Standard-URL: /api/sn_tmf_api/catalogmanagement/ProductSpecification
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder:
Datentyp: Zeichenfolge Standard: Alle Felder werden zurückgegeben. |
| limit | Maximale Anzahl der zurückzugebenden Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 20 Maximum: 100 |
| Offset | Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Datentyp: Zahl Standard: 0 |
| Status | Produktspezifikationen nach Status filtern. Nur Produktspezifikationen im angegebenen Status werden in der Antwort zurückgegeben. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltsbereich | Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn |
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
| Verknüpfung | Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse.
|
| X-Gesamtzahl | Bei paginierten Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. Vollständige Ressource als Antwort zurückgegeben (keine Paginierung). |
| 206 | Teilressource als Antwort zurückgegeben (mit Paginierung). |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Datensatz nicht gefunden In der Tabelle wurden keine Datensätze gefunden, die den Abfrageparametern entsprechen. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Beschreibung | Beschreibung der Spezifikation. Datentyp: Zeichenfolge |
| displayName | Anzeigename für die Produktspezifikation. Datentyp: Zeichenfolge |
| externalId |
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 | SYS_ID oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| internalId |
SYS_ID oder interne ID 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 Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| IsBundle | Kennzeichnung, die angibt, ob productSpecificationStellt ein einzelnes Produkt oder ein Produktpaket dar. Mögliche Werte: Datentyp: Boolesch
|
| Letztes Update | Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus der Produktspezifikation. Mögliche Werte:
Datentyp: Zeichenfolge |
| name | Name der Spezifikation. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal | Produktspezifikationsmerkmal. Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| Produktspezifikationsmerkmal. Validiertfür. StartDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Produktspezifikationsmerkmal. Wertetyp | Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Kann einen komplexen oder nicht komplexen Typ haben. Datentyp: Zeichenfolge Akzeptierte Werte:
|
| ProduktspezifikationBeziehung | Die Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten |
| ProduktspezifikationBeziehung. KompatibilitätRelationshipType | Kompatibilitätsbeziehungstyp in den erwarteten Werten der Produktspezifikation. Weitere Informationen zu Kompatibilitätsbeziehungen finden Sie unter Configuring compatibility rules for horizontal relationships. Tabelle: Kompatibel [sn_compt_mgmt_kompatibles] |
| ProductSpecificationBeziehung.ID | SYS_ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Interne ID | SYS_ID (interne ID) der Produktspezifikationsbeziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. InternalVersion | Version der Produktspezifikationsbeziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Name | Name der Produktspezifikationsbeziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. ProdSpecRelationshipOption | Kardinalität der Produktspezifikationsbeziehung. Datentyp: Objekt |
| ProduktspezifikationBeziehung. ProdSpecRelationshipOption. NumberSpecRelStandard | Standardwert der Produktspezifikation. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. ProdSpecRelationshipOption. NummernSpecRelLowerLimit | Mindestanzahl der Bestellungen, die erworben werden können. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. ProdSpecRelationshipOption. NummernSpecRelUpperLimit | Maximale Anzahl von Bestellungen, die erworben werden können. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Typ | Typ der Produktspezifikationsbeziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür | Datumsbereich, für den die Produktspezifikationsbeziehung gültig ist. Datentyp: Objekt |
| ProduktspezifikationBeziehung. Validiertfür. EndDateTime | Enddatum der Beziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür. StartDateTime | Startdatum der Beziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Version | Version der Produktspezifikationsbeziehung. Datentyp: Zeichenfolge |
| ResourceSpecification | Liste der Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| ResourceSpecification. id | SYS_ID oder externe ID der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_Specification]. |
| ResourceSpecification. Interne ID | Anfangsversion (sys_ID) des Ressourcenspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_Specification]. |
| ResourceSpecification. InternalVersion | Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ 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]. |
| ServiceSpezifikation | Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| ServiceSpezifikation. 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. Interne ID | Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. InternalVersion | Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. 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]. |
| status | Status der Produktspezifikation. Mögliche Werte:
Datentyp: Zeichenfolge |
| Validiertfür | Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt |
| Validiertfür. EndDateTime | Enddatum der Spezifikation. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| Validiertfür. StartDateTime | Startdatum der Spezifikation. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| 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 die ersten beiden Produktspezifikationsdatensätze abgerufen.
curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification?limit=2" \
--header "Accept:application/json" \
--user 'username':'password'
Antworttext:
[
{
"id": "0435b48a742e4a10f877468e695efa3c",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/0435b48a742e4a10f877468e695efa3c",
"name": "Managed PoS PS",
"displayName": "Managed PoS PS",
"version": "",
"internalVersion": "1",
"internalId": "0435b48a742e4a10f877468e695efa3c",
"description": "Managed PoS PS",
"lastUpdate": "2032-09-26 20:07:12",
"lifecycleStatus": "Active",
"isBundle": false,
"validFor": {
"startDateTime": "2032-09-26",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "4",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
},
{
"value": "2",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
},
{
"value": "1",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
}
],
"name": "Number of POS Terminals",
"description": "Number of POS Terminals",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-05-31 21:43:14"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "Gold",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
},
{
"value": "Bronze",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
},
{
"value": "Silver",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": true
}
],
"name": "Managed Service Level",
"description": "Managed Service Level",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-05-31 21:15:24"
}
}
],
"status": "published"
},
{
"id": "1a0936f840102610f87798b149fd435d",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/1a0936f840102610f87798b149fd435d",
"name": "Wi-Fi Configuration Setup Service PS",
"displayName": "Wi-Fi Configuration Setup Service PS",
"version": "",
"internalVersion": "1",
"internalId": "1a0936f840102610f87798b149fd435d",
"description": "Wi-Fi Configuration Setup Service PS",
"lastUpdate": "2025-03-13 21:01:14",
"lifecycleStatus": "Active",
"isBundle": false,
"validFor": {
"startDateTime": "2025-03-12",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [],
"resourceSpecification": [],
"productSpecCharacteristic": [],
"status": "published"
}
]
Produktkatalog – API öffnen – GET /sn_tmf_api/catalogManagement/ProductSpecification/{ID}
Ruft einen angegebenen Produktspezifikationsdatensatz ab.
URL-Format
Standard-URL: /api/sn_tmf_api/catalogManagement/ProductSpecification/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| ID | SYS_ID oder Anfangsversion der abzurufenden Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „initial_Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| Name | Beschreibung |
|---|---|
| Felder | Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder:
Datentyp: Zeichenfolge Standard: Alle Felder werden zurückgegeben. |
| Status | Produktspezifikationen nach Status filtern. Nur Produktspezifikationen im angegebenen Status werden in der Antwort zurückgegeben. Akzeptierte Werte:
Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
Kopfzeilen
Die folgenden Anforderungs- und Antwortkopfzeilen gelten nur für diese HTTP-Aktion oder für diese Aktion auf eine bestimmte Weise. Eine Liste der allgemeinen Header, die in der REST API verwendet werden, finden Sie unter Unterstützte REST-API-Header .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Beschreibung | Beschreibung der Spezifikation. Datentyp: Zeichenfolge |
| displayName | Anzeigename für die Produktspezifikation. Datentyp: Zeichenfolge |
| externalId |
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 | SYS_ID oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| internalId |
SYS_ID oder interne ID 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 Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| IsBundle | Kennzeichnung, die angibt, ob productSpecificationStellt ein einzelnes Produkt oder ein Produktpaket dar. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Datum, an dem die Produktspezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus der Produktspezifikation. Gültige Werte:
Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| name | Name der Produktspezifikation. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal | Merkmale der Produktspezifikation. Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| Produktspezifikationsmerkmal. Validiertfür. StartDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Wertetyp | Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Kann einen komplexen oder nicht komplexen Typ haben. Datentyp: Zeichenfolge Akzeptierte Werte:
|
| ProduktspezifikationBeziehung | Die Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten |
| ProduktspezifikationBeziehung. KompatibilitätRelationshipType | Kompatibilitätsbeziehungstyp in den erwarteten Werten der Produktspezifikation. Weitere Informationen zu Kompatibilitätsbeziehungen finden Sie unter Configuring compatibility rules for horizontal relationships. Tabelle: Kompatibel [sn_compt_mgmt_kompatibles] |
| ProductSpecificationBeziehung.ID | SYS_ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Interne ID | SYS_ID (interne ID) der Produktspezifikationsbeziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. InternalVersion | Version der Produktspezifikationsbeziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Name | Name der Produktspezifikationsbeziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. ProdSpecRelationshipOption | Kardinalität der Produktspezifikationsbeziehung. Datentyp: Objekt |
| ProduktspezifikationBeziehung. ProdSpecRelationshipOption. NumberSpecRelStandard | Standardwert der Produktspezifikation. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. ProdSpecRelationshipOption. NummernSpecRelLowerLimit | Mindestanzahl der Bestellungen, die erworben werden können. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. ProdSpecRelationshipOption. NummernSpecRelUpperLimit | Maximale Anzahl von Bestellungen, die erworben werden können. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Typ | Typ der Produktspezifikationsbeziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür | Datumsbereich, für den die Produktspezifikationsbeziehung gültig ist. Datentyp: Objekt |
| ProduktspezifikationBeziehung. Validiertfür. EndDateTime | Enddatum der Beziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür. StartDateTime | Startdatum der Beziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Version | Version der Produktspezifikationsbeziehung. Datentyp: Zeichenfolge |
| ResourceSpecification | Liste der Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| ResourceSpecification. id | SYS_ID oder externe ID der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_Specification]. |
| ResourceSpecification. Interne ID | Anfangsversion (sys_ID) des Ressourcenspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_Specification]. |
| ResourceSpecification. InternalVersion | Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ 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]. |
| ServiceSpezifikation | Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| ServiceSpezifikation. 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. Interne ID | Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. InternalVersion | Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. 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]. |
| status | Status der Produktspezifikation. Mögliche Werte:
Datentyp: Zeichenfolge |
| Validiertfür | Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt |
| Validiertfür. EndDateTime | Enddatum der Spezifikation. Datentyp: Zeichenfolge |
| Validiertfür. 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]. |
In diesem Beispiel wird der angegebene Produktspezifikationsdatensatz abgerufen.
curl --location --request GET "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6" \
--header "Accept:application/json" \
--user 'username':'password'
Antworttext:
{
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/497a39a7c3d312105acc9e62b540dd14",
"name": "SD-WAN Service Package",
"displayName": "SD-WAN Service Package v4",
"version": "",
"internalVersion": "4",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"description": "SD WAN Service Package",
"lastUpdate": "2029-04-15 20:05:37",
"lifecycleStatus": "Active",
"isBundle": true,
"validFor": {
"startDateTime": "2033-04-15",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [
{
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "",
"internalVersion": "2",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"type": "Service",
"compatibilityRelationshipType": "",
"validFor": {
"startDateTime": "2030-09-25",
"endDateTime": "2035-10-27"
}
},
{
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "",
"internalVersion": "2",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"type": "Service",
"compatibilityRelationshipType": "",
"validFor": {
"startDateTime": "2030-09-27",
"endDateTime": "2035-10-27"
}
},
{
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "2",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"type": "Service",
"compatibilityRelationshipType": "",
"validFor": {
"startDateTime": "2029-04-03",
"endDateTime": ""
}
}
],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "0.01",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "0.25",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "0.5",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "1",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Down Time",
"description": "Down Time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-12-13 02:36:15"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "2 hrs",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "4 hrs",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Mean Time to Restore (MTR)",
"description": "Mean Time to Restore (MTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-12-13 02:39:05"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "4 hrs",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "2 hrs",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Time to Restore (TTR)",
"description": "Time to Restore (TTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-12-13 02:37:25"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "99.50",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "99.99",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "99.00",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "99.75",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Up Time",
"description": "Up time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-12-13 02:34:30"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "5 Gbps",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "1 Gbps",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "500 Mbps",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "2 Gbps",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Bandwidth",
"description": "Bandwidth",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-12-13 02:32:11"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "Yes",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "No",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Application Encryption",
"description": "Application Encryption",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-12-13 02:29:08"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "Yes",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
},
{
"value": "No",
"validFor": {
"startDateTime": ""
},
"isDefault": false,
"isMandatory": false
}
],
"name": "Application Flow Backup",
"description": "Application Flow Backup",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-12-13 02:30:39"
}
}
],
"status": "published"
}
Produktkatalog – API öffnen – 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
| Name | Beschreibung |
|---|---|
| id | SYS_ID des zu aktualisierenden Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| GebündeltGroupProductOffering | Untergeordnete Gruppen von Produktangeboten. Diese zeigen eine hierarchische Untergruppierung an. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption | Ein Nummernbereich, der die unteren und oberen Grenzwerte der Anzahl des zugehörigen Produktangebots angibt, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Objekt |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferLowerLimit | Untergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferUpperLimit | Obergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. GebündeltProduktangebot | Untergeordnete Gruppen von Produktangeboten, die dem Paket zugeordnet sind. Dasselbe Format wie bundledProductOfferingUnten angegeben. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. id | SYS_ID des Datensatzes der gebündelten Gruppe. Nützlich in Fällen, in denen das übergeordnete Produktangebot oder die übergeordnete Gruppe mehrere Gruppen enthält. Datentyp: Zeichenfolge Tabelle: Produktangebots-Beziehungsgruppe [sn_prd_pm_Product_offering_Relationship_Group] |
| GebündeltGroupProductOffering. Name | Name der Gruppe der untergeordneten Produktangebote. Datentyp: Zeichenfolge |
| GebündeltProduktangebot | Liste der Produktangebote, die im Produktangebotspaket enthalten sind. Das Produktangebotspaket erbt alle Attribute der enthaltenen Produktangebote. Datentyp: Array von Objekten |
| GebündeltProduktangebot. GebündeltProduktangebotsOption | Produktpaketoptionen wie die Standardanzahl von Produktangeboten und alle oberen und unteren Beschaffungsbeschränkungen für Produktangebote. Datentyp: Objekt |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NumberRelOfferStandard | Standardanzahl der Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots erworben werden sollen. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferLowerLimit | Untergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferUpperLimit | Obergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. id | SYS_ID oder externe ID des gebündelten Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| GebündeltProduktangebot. ExternalID | Externe ID der Produktangebotsbeziehung . Weitere Informationen zu Produktangebotsbeziehungen finden Sie unter Create product offering relationships. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Name | Name des Produktangebotspakets. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Version | Katalogversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Kategorie | Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten Tabelle: Kategorie [sc_category] |
| Kategorie.ID | Erforderlich, wenn verwendet wird categoryParameter. ID der Kategorie. Datentyp: Zeichenfolge Tabelle: Kategorie [sc_category] |
| category.name | Name der Kategorie. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Kanal | Erforderlich. Kanäle, die für den Verkauf des Produktangebots verwendet werden sollen. Datentyp: Array von Objekten |
| channel.description | Beschreibung des Kanals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Kanal.ID | Erforderlich. SYS_ID des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_Distribution_Channel] |
| channel.name | Name des Kanals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Beschreibung | Erforderlich. Beschreibung des Produktangebots. Datentyp: Zeichenfolge |
| displayName | Anzeigename 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 | SYS_ID oder interne ID des Produktangebotsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| InternalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| IsBundle | Kennzeichnung, die angibt, ob das Produktangebot ein Paket ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Ist verkaufbar | Kennzeichnung, die angibt, ob das zugehörige Produktangebot selbst verkauft werden kann oder Teil eines Produktangebots sein muss. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS Standard: Leere Zeichenfolge |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus des Produktangebots. Mögliche Werte:
Datentyp: Zeichenfolge |
| name | Erforderlich. Name des Produktangebots. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden | Produktangebotsmerkmale. Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| prodSpecCharValueUse.name | Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. Validiertfür. StartDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. Wertetyp | Datentyp von prodSpecCharValueUse.productSpecCharacteristicValue.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| Produktmerkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten |
| productCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Produktmerkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| ProduktangebotMerkmal | Merkmalsqualität oder Unterscheidungsmerkmal eines Produktangebots. Merkmale können einen diskreten Wert annehmen, der zum Designzeitpunkt (Katalogerstellung) festgelegt ist, z. B. „Mobile Planrang“. Diese Merkmale können im Allgemeinen nicht auf Bestandsebene geändert werden. Weitere Informationen zu Produktangebotsmerkmalen finden Sie unter Create product characteristics and characteristic options. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification | Liste der Merkmalswerte, die dem Produktangebotsmerkmal zugeordnet sind. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das zugeordnete Merkmal ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert für das zugeordnete Merkmal obligatorisch ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Wert | Nummer oder Text, die dem zugehörigen Produktspezifikationsmerkmal zugewiesen ist. Zum Beispiel: Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Name | Name des zugehörigen Produktangebotsmerkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Wertetyp | Datentyp von productOfferingCharacteristic.characteristicValueSpecification.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProductOfferingPreis | Preisinformationen für das Produktangebot. Datentyp: Array von Objekten |
| ProduktAngebotPreis.Preis | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProduktangebotPreis.Preis.taxIncludedAmount | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProduktangebotPreis.Preis.taxIncludedAmount.unit | Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| ProduktangebotPreis.Preis.taxIncludedAmount.value | Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| ProduktangebotPreis.Preistyp | Typ des Produktangebotstyps. Erforderlich, wenn verwendet wird productOfferingPriceParameter. Gültige Werte:
Datentyp: Zeichenfolge |
| ProductOfferingTerm | Gültige Vertragslaufzeit für Das Produktangebot. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Produktspezifikation | Erforderlich. Produktspezifikation für das Produkt. Datentyp: Objekt |
| productSpecification.id | Erforderlich. SYS_ID oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: In den Feldern „sys_ID“ oder „external_ID“ in der Produktspezifikation [sn_prd_pm_Product_Specification] |
| Produktspezifikation. Interne ID | SYS_ID oder interne ID des Produktspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktspezifikation. InternalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| Produktspezifikation. Name | Name der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Namensfeld 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]. |
| status | Status des Produktangebots. Mögliche Werte:
Datentyp: Zeichenfolge |
| Validiertfür | Erforderlich. Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt |
| ValidFor.endDateTime | Erforderlich. Enddatum und -Uhrzeit des Produktangebots. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| ValidFor.startDateTime | Erforderlich. Startdatum und -Uhrzeit des Produktangebots. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| 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. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| GebündeltGroupProductOffering | Untergeordnete Gruppen von Produktangeboten. Diese zeigen eine hierarchische Untergruppierung an. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption | Ein Nummernbereich, der die unteren und oberen Grenzwerte der Anzahl des zugehörigen Produktangebots angibt, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Objekt |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferLowerLimit | Untergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferUpperLimit | Obergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. GebündeltProduktangebot | Untergeordnete Gruppen von Produktangeboten, die dem Paket zugeordnet sind. Dasselbe Format wie bundledProductOfferingUnten angegeben. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. id | SYS_ID des Datensatzes der gebündelten Gruppe. Nützlich in Fällen, in denen das übergeordnete Produktangebot oder die übergeordnete Gruppe mehrere Gruppen enthält. Datentyp: Zeichenfolge Tabelle: Produktangebots-Beziehungsgruppe [sn_prd_pm_Product_offering_Relationship_Group] |
| GebündeltGroupProductOffering. Name | Name der Gruppe der untergeordneten Produktangebote. Datentyp: Zeichenfolge |
| GebündeltProduktangebot | Liste der Produktangebote, die im Produktangebotspaket enthalten sind. Das Produktangebotspaket erbt alle Attribute der enthaltenen Produktangebote. Datentyp: Array von Objekten |
| GebündeltProduktangebot. GebündeltProduktangebotsOption | Produktpaketoptionen wie die Standardanzahl von Produktangeboten und alle oberen und unteren Beschaffungsbeschränkungen für Produktangebote. Datentyp: Objekt |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NumberRelOfferStandard | Standardanzahl der Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots erworben werden sollen. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferLowerLimit | Untergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferUpperLimit | Obergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. id | SYS_ID oder externe ID des gebündelten Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| GebündeltProduktangebot. ExternalID | Externe ID der Produktangebotsbeziehung . Weitere Informationen zu Produktangebotsbeziehungen finden Sie unter Create product offering relationships. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Name | Name des Produktangebotspakets. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Version | Katalogversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Kategorie | Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten |
| Kategorie.ID | ID der Kategorie. Datentyp: Zeichenfolge |
| category.name | Name der Kategorie. Datentyp: Zeichenfolge |
| Kanal | Kanäle, die für den Verkauf des Produktangebots verwendet werden sollen. Datentyp: Array von Objekten |
| channel.description | Beschreibung des Kanals. Datentyp: Zeichenfolge |
| Kanal.ID | SYS_ID des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_Distribution_Channel] |
| channel.name | Name des Kanals. Datentyp: Zeichenfolge |
| Beschreibung | Beschreibung des Produktangebots. Datentyp: Zeichenfolge |
| displayName | Anzeigename 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 | SYS_ID oder interne ID des Produktangebotsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| InternalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| IsBundle | Kennzeichnung, die angibt, ob das Produktangebot ein Paket ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Ist verkaufbar | Kennzeichnung, die angibt, ob das zugehörige Produktangebot selbst verkauft werden kann oder Teil eines Produktangebots sein muss. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| LiftcycleStatus | Aktueller Lebenszyklusstatus. Akzeptierte Werte:
Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| name | Name des Produktangebots. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden | Produktangebotsmerkmale. Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Name |
Name des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. Validiertfür. StartDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. Wertetyp | Datentyp von prodSpecCharValueUse.productSpecCharacteristicValue.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| Produktmerkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten |
| Produktmerkmal. Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal. Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal | Merkmalsqualität oder Unterscheidungsmerkmal eines Produktangebots. Merkmale können einen diskreten Wert annehmen, der zum Designzeitpunkt (Katalogerstellung) festgelegt ist, z. B. „Mobile Planrang“. Diese Merkmale können im Allgemeinen nicht auf Bestandsebene geändert werden. Weitere Informationen zu Produktangebotsmerkmalen finden Sie unter Create product characteristics and characteristic options. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification | Liste der Merkmalswerte, die dem Produktangebotsmerkmal zugeordnet sind. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das zugeordnete Merkmal ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert für das zugeordnete Merkmal obligatorisch ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Wert | Nummer oder Text, die dem zugehörigen Produktspezifikationsmerkmal zugewiesen ist. Zum Beispiel: Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Name | Name des zugehörigen Produktangebotsmerkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Wertetyp | Datentyp von productOfferingCharacteristic.characteristicValueSpecification.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProductOfferingPreis | Preisinformationen für das Produktangebot. Datentyp: Array von Objekten |
| ProductOfferingPreis. Preis | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProductOfferingPreis. Preis. TaxIncludedAmount | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProductOfferingPreis. Preis. TaxIncludedAmount.unit | Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge |
| ProductOfferingPreis. Preis. TaxIncludedAmount. Wert | Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge |
| ProductOfferingPreis. Preistyp | Produktangebotspreistyp, einmalige oder wiederkehrende Zahlung. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProductOfferingTerm | Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge |
| Produktspezifikation | Produktspezifikation für das Produkt. Datentyp: Objekt |
| Produktspezifikation. id | SYS_ID des Produktspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktspezifikation. Interne ID | SYS_ID oder interne ID des Produktspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktspezifikation. InternalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| Produktspezifikation. Status | Status der Produktspezifikation, z. B. veröffentlicht oder Entwurf. Datentyp: Zeichenfolge |
| Produktspezifikation. sys_ID | SYS_ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| Produktspezifikation. Version | Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| status | Status des Produktangebots. Mögliche Werte:
Datentyp: Zeichenfolge |
| Validiertfür | Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt |
| Validiertfür. EndDateTime | Enddatum des Produktangebots. Datentyp: Zeichenfolge |
| Validiertfür. 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]. |
Das folgende Beispiel aktualisiert das Produktangebot mit der sys_ID 313b917843235210a82ed6085bb8f2c7 mit den Informationen im Anforderungstext.
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productOffering/313b917843235210a82ed6085bb8f2c7" \
--request PATCH\
--header "Accept:application/json" \
--user 'username':'password'
--data '{
"id": "313b917843235210a82ed6085bb8f2c7",
"name": "Internet bundle",
"displayName": "Internet bundle",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-02-05 06:39:45",
"version": "",
"internalVersion": "1",
"internalId": "313b917843235210a82ed6085bb8f2c7",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "Premium",
"isMandatory": false,
"isDefault": true
}
]
},
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "When in use",
"isMandatory": false,
"isDefault": false
}
]
}
],
"bundledProductOffering": [
{
"id": "0f61dd9fd0a63110f8770dbf976be168",
"name": "Solana Sports streaming channel",
"version": "1",
"externalId": "EXT-123",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"id": "62619d9fd0a63110f8770dbf976be180",
"name": "Solana Movie streaming channel",
"version": "1",
"externalId": "EXT-123",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-12-18 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Base (10 site)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft"
}'
Antworttext:
{
"id": "313b917843235210a82ed6085bb8f2c7",
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/313b917843235210a82ed6085bb8f2c7",
"name": "Internet",
"displayName": "Internet",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-02-05 06:39:45",
"version": "",
"internalVersion": "1",
"internalId": "313b917843235210a82ed6085bb8f2c7",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "Premium",
"isMandatory": false,
"isDefault": true
}
]
},
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "When in use",
"isMandatory": false,
"isDefault": false
}
]
}
],
"bundledProductOffering": [
{
"id": "0f61dd9fd0a63110f8770dbf976be168",
"name": "Solana Sports streaming channel",
"version": "1",
"externalId": "EXT-123",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
},
{
"id": "0f61dd9fd0a63110f8770dbf976be16c",
"name": "Solana TV shows streaming channel",
"version": "1",
"externalId": "EXT-456",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"name": "Internet",
"version": "1",
"externalId": "EXT-678",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "3"
}
},
{
"id": "313b917843235210a82ed6085bb8f2c7",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"id": "1161a4f8436b1210a82ed6085bb8f216",
"name": "Internet",
"version": "1",
"externalId": "EXT-910",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-12-18 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Advance (50 site)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Base (10 site)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft"
}
Produktkatalog – API öffnen – PATCH /sn_tmf_api/catalogManagement/productOfferingPrice/{ID}
Aktualisiert einen Preislistenpositionsdatensatz mit einer bestimmten sys_ID in der Tabelle „Preislistenposition“ [sn_csm_price_list_line].
URL-Format
Standard-URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice/{ID}
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| id | Erforderlich. SYS_ID der abzurufenden Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| @TYPE | Erforderlich. Typ der Preislistenposition. Immer ein Wert von ProduktangebotPreis .Datentyp: Zeichenfolge |
| externalId | Die externe ID der Preislistenposition. Datentyp: Zeichenfolge |
| IsBundle | Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktpakets ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Erforderlich. Datum, an dem die Preisposition zuletzt aktualisiert wurde. Format: JJJJ-MM-TT Datentyp: Zeichenfolge |
| Lebenszyklusstatus | Erforderlich. Aktueller Lebenszyklusstatus der Produktlistenposition. Gültige Werte:
Datentyp: Zeichenfolge Standard: Entwurf |
| name | Erforderlich. Name für die Preislistenposition. Datentyp: Zeichenfolge |
| Preis | Erforderlich. Listenpreisdetails der Preislistenposition. Datentyp: Objekt |
| Preis.Einheit | Erforderlich. Währungscode der Preislistenposition. Beispiel: USD Oder EUR .Tabelle: Tabelle „Währung“ [fx_currency]. Datentyp: Zeichenfolge |
| Preis.Wert | Erforderlich. Wert des Preises. Datentyp: Zeichenfolge (dargestellt durch eine Zahl. Beispiel: |
| priceList | Erforderlich. Preislisteninformationen, die der Preislistenposition zugeordnet sind. Datentyp: Objekt |
| Preisliste.ID | Erforderlich. SYS_ID der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| priceList.name | Name der Preislistenposition. Datentyp: Zeichenfolge |
| Preisliste.@type | Der Typ der Preislistenposition. Bei Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Wert ist immer Preisliste .Datentyp: Zeichenfolge |
| Preistyp | Erforderlich. Filtern Sie die Preislistenposition nach der Preismethode des Produktangebots. Gültige Werte:
Datentyp: Zeichenfolge Standard: Wiederkehrend |
| productOffering | Erforderlich. Produktangebot der Preislistenposition. Datentyp: Objekt |
| ProductOffering. id | Erforderlich. SYS_ID des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_Product_offering] Datentyp: Zeichenfolge |
| ProductOffering. InternalVersion | Interne Versionsnummer des Produktangebots. Datentyp: Zeichenfolge (dargestellt durch eine Zahl. Beispiel: |
| ProductOffering. Name | Name des Produktangebots. Datentyp: Zeichenfolge |
| RecurringChargePeriodType | Erforderlich, wenn priceTypeIst wiederkehrend. Zusagebedingungen, die bei der Erstellung des Produktangebots ausgewählt werden. Gültige Werte:
Datentyp: Zeichenfolge |
| Maßeinheit | Erforderlich. Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt |
| 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. Beispiel: Jeweils Oder Paket .Datentyp: Zeichenfolge |
| Validiertfür | Erforderlich. Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| id | SYS_ID der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| href | URL zum Preislistenpositionsdatensatz in der Instanz. Datentyp: Zeichenfolge |
| Letztes Update | Datum und Uhrzeit der letzten Aktualisierung der Preislistenposition. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge |
| Validiertfür | Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt |
| 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) |
| IsBundle | Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktpakets ist. Gültige Werte:
Datentyp: Boolesch |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus der Preislistenposition. Gültige Werte:
Datentyp: Zeichenfolge |
| productOffering | Produktangebot, das der Preislistenposition zugeordnet ist. Datentyp: Objekt |
| Produktangebot.ID | SYS_ID des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| ProductOffering. InternalVersion | Interne Versionsnummer des Produktangebots. Beispiel: PRDOF01024 . Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].Datentyp: Zeichenfolge |
| ProductOffering. Name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| Preistyp | Die Preismethode des Produktangebots, das dieser Preislistenposition zugeordnet ist. Mögliche Werte:
Datentyp: Zeichenfolge |
| RecurringChargePeriodType | Die Periodizität oder Häufigkeit des Produktangebots, das dieser Preislistenposition zugeordnet ist. Gibt einen Häufigkeitstyp zurück, wenn priceTypeWurde auf festgelegt Wiederkehrend , Andernfalls wird eine leere Zeichenfolge zurückgegeben.Mögliche Werte:
Datentyp: Zeichenfolge |
| Maßeinheit | Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt |
| EinheitenMessung.Betrag | Betrag der Maßeinheit. Datentyp: Zahl |
| EinheitenMessung.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. Beispiel: Jahr Oder Paket .Datentyp: Zeichenfolge |
| Preis | Listenpreisdetails der Preislistenposition. Datentyp: Objekt |
| Preis.Einheiten | Währungscode des Preises. 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 |
| Preisliste.ID | SYS_ID der Preisliste in der Tabelle „Preisliste“ [sn_csm_price_list]. Datentyp: Zeichenfolge |
| priceList.name | Name der Preisliste. Datentyp: Zeichenfolge |
| Preisliste.@type | Der Typ der Preisliste. Bei Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Hat immer einen Wert von Preisliste .Datentyp: Zeichenfolge |
| @TYPE | Immer ein Wert von ProduktangebotPreis . Bei Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse.Datentyp: Zeichenfolge |
| Status | Der Status der Preisliste, die dieser Preislistenposition zugeordnet ist. Datentyp: Zeichenfolge |
| externalId | Die externe ID dieser Preislistenposition. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Beispiel aktualisiert die Daten, wann der Produktangebotspreis mit der ID 3ddd0... Ist gültig für.
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"
}
Produktkatalog – API öffnen – 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
| Name | Beschreibung |
|---|---|
| id | SYS_ID des zu aktualisierenden Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktspezifikation [sn_prd_pm_Product_Specification] |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Beschreibung | 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 | SYS_ID oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| internalId | Erforderlich. SYS_ID oder interne ID 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 Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| IsBundle | Kennzeichnung, die angibt, ob productSpecificationStellt ein einzelnes Produkt oder ein Produktpaket dar. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| name | Erforderlich. Name der Spezifikation. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal | Spezifikationsmerkmal. Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Name | Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| Produktspezifikationsmerkmal. Validiertfür. EndDateTime | Enddatum und -Uhrzeit des Merkmals. Format: JJJJ-MM-TT HH:mm:SS. Beispiel: Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Validiertfür. StartDateTime | Startdatum und -Uhrzeit des Merkmals. Format: JJJJ-MM-TT HH:mm:SS. Beispiel: Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Wertetyp | Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Kann einen komplexen oder nicht komplexen Typ haben. Datentyp: Zeichenfolge Akzeptierte Werte:
Standardwert: Leere Zeichenfolge |
| ProduktspezifikationBeziehung | Details der Beziehungen der Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten |
| ProduktspezifikationBeziehung. id | ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Typ | Erforderlich, wenn verwendet wird productSpecificationRelationshipParameter. Typ der Beziehung. Gültige Werte:
Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür | Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt |
| ProduktspezifikationBeziehung. Validiertfür. EndDateTime | Enddatum der Beziehung. Format: JJJJ-MM-TT HH:mm:SS. Beispiel: Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür. StartDateTime | Startdatum der Beziehung. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| ResourceSpecification | Erforderlich. Details der Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| 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. Interne ID | Anfangsversion (sys_ID) des Ressourcenspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_Specification]. |
| ResourceSpecification. InternalVersion | Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ 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]. |
| ServiceSpezifikation | Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| ServiceSpezifikation. 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. Interne ID | Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. InternalVersion | Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. 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]. |
| Validiertfür | Erforderlich. Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt |
| Validiertfür. EndDateTime | Enddatum und -Uhrzeit der Spezifikation. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: Datentyp: Zeichenfolge |
| Validiertfür. StartDateTime | Startdatum und -Uhrzeit der Spezifikation. FORMAT: JJJJ-MM-TT 00:00:00. Beispiel: 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Anforderung erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Beschreibung | Beschreibung der Spezifikation. Datentyp: Zeichenfolge |
| href | Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge |
| id | SYS_ID oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| internalId | Erforderlich. SYS_ID oder interne ID 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 Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| Letztes Update | Datum, an dem die Spezifikation zuletzt aktualisiert wurde. FORMAT: JJJJ-MM-TT 00:00:00. Datentyp: Zeichenfolge |
| name | Name der Spezifikation. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal | Merkmale der Spezifikation. Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| Produktspezifikationsmerkmal. Validiertfür. EndDateTime | Enddatum und -Uhrzeit des Merkmals. FORMAT: JJJJ-MM-TT 00:00:00. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Validiertfür. StartDateTime | Startdatum und -Uhrzeit des Merkmals. FORMAT: JJJJ-MM-TT 00:00:00. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Wertetyp | Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Kann einen komplexen oder nicht komplexen Typ haben. Datentyp: Zeichenfolge Akzeptierte Werte:
|
| ProduktspezifikationBeziehung | Die Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten |
| ProduktspezifikationBeziehung. id | SYS_ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Typ | Typ der Beziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür | Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt |
| ProduktspezifikationBeziehung. Validiertfür. EndDateTime | Enddatum und Typ der Beziehung. Format: JJJJ-MM-TT Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür. StartDateTime | Startdatum und Typ der Beziehung. Format: JJJJ-MM-TT Datentyp: Zeichenfolge |
| ResourceSpecification | Liste der Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| ResourceSpecification. id | SYS_ID oder externe ID der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_Specification]. |
| ResourceSpecification. Interne ID | Anfangsversion (sys_ID) des Ressourcenspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_Specification]. |
| ResourceSpecification. InternalVersion | Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ 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]. |
| ServiceSpezifikation | Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| ServiceSpezifikation. 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. Interne ID | Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. InternalVersion | Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. 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]. |
| Validiertfür | Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt |
| Validiertfür. EndDateTime | Enddatum und -Uhrzeit der Spezifikation. Format: JJJJ-MM-TT HH:mm:SS. Datentyp: Zeichenfolge |
| Validiertfür. StartDateTime | Startdatum und -Uhrzeit der Spezifikation. Format: JJJJ-MM-TT HH:mm:SS. Datentyp: Zeichenfolge |
| Version | Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
Das folgende Beispiel aktualisiert die Produktspezifikations-ID d6f8d995b020210235d85cced81c7eb mit den im Anforderungstext angegebenen Informationen.
curl "http://instance.servicenow.com/api/sn_tmf_api/catalogmanagement/productSpecification/d6f8d9995b020210235d85cced81c7eb" \
--request PATCH\
--header "Accept:application/json" \
--user 'username':'password'
--data '{
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"displayName": "SD-WAN Service Package v3",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"description": "SD WAN Service Package",
"lastUpdate": "2027-10-11 06:58:12",
"isBundle": true,
"validFor": {
"startDateTime": "2029-02-05",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [
{
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"type": "Service",
"validFor": {
"startDateTime": "2025-01-24",
"endDateTime": ""
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "1",
"numberSpecRelUpperLimit": "1"
}
},
{
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "",
"internalVersion": "2",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-05",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "2",
"numberSpecRelUpperLimit": "4"
}
},
{
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "",
"internalVersion": "2",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-03",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "4",
"numberSpecRelUpperLimit": "20"
}
}
],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "1",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.25",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.01",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.5",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Down Time",
"description": "Down Time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:36:15"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "500 Mbps",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "5 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Bandwidth",
"description": "Bandwidth",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:32:11"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "4 hrs",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 hr",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Time to Restore (TTR)",
"description": "Time to Restore (TTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:37:25"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "4 hrs",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Mean Time to Restore (MTR)",
"description": "Mean Time to Restore (MTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:39:05"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Flow Backup",
"description": "Application Flow Backup",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:30:39"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "99.00",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.50",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.75",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.99",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Up Time",
"description": "Up time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:34:30"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Encryption",
"description": "Application Encryption",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:29:08"
}
}
],
"status": "published"
}'
Antworttext:
{
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"displayName": "SD-WAN Service Package v3",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"description": "SD WAN Service Package",
"lastUpdate": "2027-10-11 06:58:12",
"isBundle": true,
"validFor": {
"startDateTime": "2029-02-05",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [
{
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"type": "Service",
"validFor": {
"startDateTime": "2025-01-24",
"endDateTime": ""
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "1",
"numberSpecRelUpperLimit": "1"
}
},
{
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "",
"internalVersion": "2",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-05",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "2",
"numberSpecRelUpperLimit": "4"
}
},
{
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "",
"internalVersion": "2",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-03",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "4",
"numberSpecRelUpperLimit": "20"
}
}
],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "1",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.25",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.01",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.5",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Down Time",
"description": "Down Time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:36:15"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "500 Mbps",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "5 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Bandwidth",
"description": "Bandwidth",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:32:11"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "4 hrs",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 hr",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Time to Restore (TTR)",
"description": "Time to Restore (TTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:37:25"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "4 hrs",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Mean Time to Restore (MTR)",
"description": "Mean Time to Restore (MTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:39:05"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Flow Backup",
"description": "Application Flow Backup",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:30:39"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "99.00",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.50",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.75",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.99",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Up Time",
"description": "Up time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:34:30"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Encryption",
"description": "Application Encryption",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:29:08"
}
}
],
"status": "published"
}'
Produktkatalog – API öffnen – POST /sn_tmf_api/catalogmanagement/catalog
Erstellt einen Produktangebotskatalog.
URL-Format
Standard-URL: /api/sn_tmf_api/catalogmanagement/catalog
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Beschreibung | 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| Kopfzeile | Beschreibung |
|---|---|
| Inhaltstyp | Datenformat des Antworttexts. Nur unterstützt application/json. |
Statuscodes
Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST API verwendet werden, finden Sie unter REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 201 | Anforderung erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Dies kann einer der folgenden Gründe sein:
|
Parameter des Antwort-Haupttexts (JSON)
| Name | Beschreibung |
|---|---|
| Beschreibung | Beschreibung des Produktangebotskatalogs. Datentyp: Zeichenfolge |
| id | SYS_ID des Produktangebotskatalogs 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 – API öffnen – POST /sn_tmf_api/catalogManagement/productOffering
Erstellt ein Produktangebot und zugehörige Produktangebotspakete.
URL-Format
Standard-URL: /api/sn_tmf_api/catalogManagement/productOffering
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| GebündeltGroupProductOffering | Untergeordnete Gruppen von Produktangeboten. Diese zeigen eine hierarchische Untergruppierung an. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption | Ein Nummernbereich, der die unteren und oberen Grenzwerte der Anzahl des zugehörigen Produktangebots angibt, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Objekt |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferLowerLimit | Untergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferUpperLimit | Obergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. GebündeltProduktangebot | Untergeordnete Gruppen von Produktangeboten, die dem Paket zugeordnet sind. Dasselbe Format wie bundledProductOfferingUnten angegeben. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. id | SYS_ID des Datensatzes der gebündelten Gruppe. Nützlich in Fällen, in denen das übergeordnete Produktangebot oder die übergeordnete Gruppe mehrere Gruppen enthält. Datentyp: Zeichenfolge Tabelle: Produktangebots-Beziehungsgruppe [sn_prd_pm_Product_offering_Relationship_Group] |
| GebündeltGroupProductOffering. Name | Name der Gruppe der untergeordneten Produktangebote. Datentyp: Zeichenfolge |
| GebündeltProduktangebot | Liste der Produktangebote, die im Produktangebotspaket enthalten sind. Das Produktangebotspaket erbt alle Attribute der enthaltenen Produktangebote. Datentyp: Array von Objekten |
| GebündeltProduktangebot. GebündeltProduktangebotsOption | Produktpaketoptionen wie die Standardanzahl von Produktangeboten und alle oberen und unteren Beschaffungsbeschränkungen für Produktangebote. Datentyp: Objekt |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NumberRelOfferStandard | Standardanzahl der Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots erworben werden sollen. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferLowerLimit | Untergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferUpperLimit | Obergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. ExternalID | Externe ID der Produktangebotsbeziehung . Weitere Informationen zu Produktangebotsbeziehungen finden Sie unter Create product offering relationships. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. id | SYS_ID oder externe ID des gebündelten Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| GebündeltProduktangebot. Name | Name des Produktangebotspakets. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Version | Katalogversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Kategorie | Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten |
| Kategorie.ID | Erforderlich, wenn verwendet wird categoryParameter. ID der Kategorie. Datentyp: Zeichenfolge Tabelle: Kategorie [sc_category] |
| category.name | Name der Kategorie. Datentyp: Zeichenfolge Tabelle: Kategorie [sc_category] |
| Kanal | Erforderlich. Kanäle, die für den Verkauf des Produktangebots verwendet werden sollen. Datentyp: Array von Objekten |
| channel.description | Beschreibung des Kanals. Datentyp: Zeichenfolge |
| Kanal.ID | Erforderlich. SYS_ID des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_Distribution_Channel] |
| channel.name | Name des Kanals. Datentyp: Zeichenfolge |
| Beschreibung | Erforderlich. Beschreibung des Produktangebots. Datentyp: Zeichenfolge |
| displayName | Anzeigename 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 | SYS_ID oder interne ID des Produktangebotsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| InternalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| IsBundle | Kennzeichnung, die angibt, ob das Produktangebot ein Paket ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Ist verkaufbar | Kennzeichnung, die angibt, ob das zugehörige Produktangebot selbst verkauft werden kann oder Teil eines Produktangebots sein muss. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus. Gültige Werte:
Datentyp: Zeichenfolge |
| name | Erforderlich. Name des Produktangebots. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden | Produktangebotsmerkmale. Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Name |
Name des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. Validiertfür. StartDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. Wertetyp | Datentyp von prodSpecCharValueUse.productSpecCharacteristicValue.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| Produktmerkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten |
| productCharacteristic.name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal.Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal | Merkmalsqualität oder Unterscheidungsmerkmal eines Produktangebots. Merkmale können einen diskreten Wert annehmen, der zum Designzeitpunkt (Katalogerstellung) festgelegt ist, z. B. „Mobile Planrang“. Diese Merkmale können im Allgemeinen nicht auf Bestandsebene geändert werden. Weitere Informationen zu Produktangebotsmerkmalen finden Sie unter Create product characteristics and characteristic options. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification | Liste der Merkmalswerte, die dem Produktangebotsmerkmal zugeordnet sind. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das zugeordnete Merkmal ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert für das zugeordnete Merkmal obligatorisch ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Wert | Nummer oder Text, die dem zugehörigen Produktspezifikationsmerkmal zugewiesen ist. Zum Beispiel: Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Name | Name des zugehörigen Produktangebotsmerkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Wertetyp | Datentyp von productOfferingCharacteristic.characteristicValueSpecification.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProductOfferingPreis | Preisinformationen für das Produktangebot. Datentyp: Array von Objekten |
| ProduktAngebotPreis.Preis | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProduktangebotPreis.Preis.taxIncludedAmount | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProduktangebotPreis.Preis.taxIncludedAmount.unit | Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge Format: ISO 4217 |
| ProduktangebotPreis.Preis.taxIncludedAmount.value | Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge |
| ProduktangebotPreis.Preistyp | Erforderlich, wenn verwendet wird productOfferingPriceParameter. Produktangebotspreistyp, einmalige oder wiederkehrende Zahlung. Gültige Werte:
Datentyp: Zeichenfolge |
| ProductOfferingTerm | Gültige Vertragslaufzeit für das Produktangebot, z. B. 12 Monate, 24 Monate oder Not_applicable. Datentyp: Zeichenfolge |
| Produktspezifikation | Erforderlich. Produktspezifikation für das Produkt. Datentyp: Objekt |
| 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. Interne ID | SYS_ID oder interne ID des Produktspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktspezifikation. InternalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| Produktspezifikation. Name | Name der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Namensfeld 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]. |
| Validiertfür | Erforderlich. Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt |
| ValidFor.endDateTime | Enddatum des Produktangebots. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| ValidFor.startDateTime | Startdatum des Produktangebots. Datentyp: Zeichenfolge Format: JJJJ-MM-TT |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Content-Type | Datenformat des Anforderungstexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| GebündeltGroupProductOffering | Untergeordnete Gruppen von Produktangeboten. Diese zeigen eine hierarchische Untergruppierung an. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption | Ein Nummernbereich, der die unteren und oberen Grenzwerte der Anzahl des zugehörigen Produktangebots angibt, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Objekt |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferLowerLimit | Untergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. BundledGroupProductOfferingOption. NummerRelOfferUpperLimit | Obergrenze für ein Produktangebot, das als Teil des zugehörigen gebündelten Produktangebots erworben werden kann. Datentyp: Zeichenfolge |
| GebündeltGroupProductOffering. GebündeltProduktangebot | Untergeordnete Gruppen von Produktangeboten, die dem Paket zugeordnet sind. Dasselbe Format wie bundledProductOfferingUnten angegeben. Datentyp: Array von Objekten |
| GebündeltGroupProductOffering. id | SYS_ID des Datensatzes der gebündelten Gruppe. Nützlich in Fällen, in denen das übergeordnete Produktangebot oder die übergeordnete Gruppe mehrere Gruppen enthält. Datentyp: Zeichenfolge Tabelle: Produktangebots-Beziehungsgruppe [sn_prd_pm_Product_offering_Relationship_Group] |
| GebündeltGroupProductOffering. Name | Name der Gruppe der untergeordneten Produktangebote. Datentyp: Zeichenfolge |
| GebündeltProduktangebot | Liste der Produktangebote, die im Produktangebotspaket enthalten sind. Das Produktangebotspaket erbt alle Attribute der enthaltenen Produktangebote. Datentyp: Array von Objekten |
| GebündeltProduktangebot. GebündeltProduktangebotsOption | Produktpaketoptionen wie die Standardanzahl von Produktangeboten und alle oberen und unteren Beschaffungsbeschränkungen für Produktangebote. Datentyp: Objekt |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NumberRelOfferStandard | Standardanzahl der Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots erworben werden sollen. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferLowerLimit | Untergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. GebündeltProduktangebotsOption. NummerRelOfferUpperLimit | Obergrenze der Anzahl der zugehörigen Produktangebote, die als Teil des zugehörigen gebündelten Produktangebots bezogen werden können. Datentyp: Zeichenfolge Mögliche Werte: 0 bis ungebunden. |
| GebündeltProduktangebot. ExternalID | Externe ID der Produktangebotsbeziehung . Weitere Informationen zu Produktangebotsbeziehungen finden Sie unter Create product offering relationships. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Href | Relativer Link zum zugehörigen Produktangebot. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. id | SYS_ID oder externe ID des gebündelten Produktangebots. Datentyp: Zeichenfolge Tabelle: Produktangebot [sn_prd_pm_Product_offering] |
| GebündeltProduktangebot. Name | Name des Produktangebotspakets. Datentyp: Zeichenfolge |
| GebündeltProduktangebot. Version | Katalogversion des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Kategorie | Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten |
| Kategorie.ID | ID der Kategorie. Datentyp: Zeichenfolge |
| category.name | Name der Kategorie. Datentyp: Zeichenfolge |
| Kanal | Kanäle, die für den Verkauf des Produktangebots verwendet werden sollen. Datentyp: Array von Objekten |
| Kanal. Beschreibung | Beschreibung des Kanals. Datentyp: Zeichenfolge |
| Kanal.ID | SYS_ID des Kanals. Datentyp: Zeichenfolge Tabelle: Verteilungskanal [sn_prd_pm_Distribution_Channel] |
| channel.name | Name des Kanals. Datentyp: Zeichenfolge |
| Beschreibung | 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 | SYS_ID oder interne ID des Produktangebotsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| InternalVersion | Version des Produktangebots. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Produktangebot“ [sn_prd_pm_Product_Offering]. |
| IsBundle | Kennzeichnung, die angibt, ob das Produktangebot ein Paket ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Ist verkaufbar | Kennzeichnung, die angibt, ob das zugehörige Produktangebot selbst verkauft werden kann oder Teil eines Produktangebots sein muss. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus des Produktangebots. Gültige Werte:
Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| name | Name des Produktangebots. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden | Produktangebotsmerkmale. Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Name |
Name des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| ProdSpecCharValueVerwenden. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| ProdSpecCharValueVerwenden. Validiertfür. StartDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProdSpecCharValueVerwenden. Wertetyp | Datentyp von prodSpecCharValueUse.productSpecCharacteristicValue.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| Produktmerkmal | Liste der Produktmerkmale. Datentyp: Array von Objekten |
| Produktmerkmal. Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktmerkmal. Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal | Merkmalsqualität oder Unterscheidungsmerkmal eines Produktangebots. Merkmale können einen diskreten Wert annehmen, der zum Designzeitpunkt (Katalogerstellung) festgelegt ist, z. B. „Mobile Planrang“. Diese Merkmale können im Allgemeinen nicht auf Bestandsebene geändert werden. Weitere Informationen zu Produktangebotsmerkmalen finden Sie unter Create product characteristics and characteristic options. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification | Liste der Merkmalswerte, die dem Produktangebotsmerkmal zugeordnet sind. Datentyp: Array von Objekten |
| ProduktangebotMerkmal. CharakteristicValueSpecification. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das zugeordnete Merkmal ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert für das zugeordnete Merkmal obligatorisch ist. Mögliche Werte:
Datentyp: Boolesch Standardwert: false |
| ProduktangebotMerkmal. CharakteristicValueSpecification. Wert | Nummer oder Text, die dem zugehörigen Produktspezifikationsmerkmal zugewiesen ist. Zum Beispiel: Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Name | Name des zugehörigen Produktangebotsmerkmals. Datentyp: Zeichenfolge |
| ProduktangebotMerkmal. Wertetyp | Datentyp von productOfferingCharacteristic.characteristicValueSpecification.valueParameter. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProductOfferingPreis | Preisinformationen für das Produktangebot. Datentyp: Array von Objekten |
| ProductOfferingPreis. Preis | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProductOfferingPreis. Preis. TaxIncludedAmount | Preisinformationen für das Produktangebot. Datentyp: Objekt |
| ProductOfferingPreis. Preis. TaxIncludedAmount.unit | Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge |
| ProductOfferingPreis. Preis. TaxIncludedAmount. Wert | Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge |
| ProductOfferingPreis. Preistyp | Produktangebotspreistyp, einmalige oder wiederkehrende Zahlung. Mögliche Werte:
Datentyp: Zeichenfolge |
| ProductOfferingTerm | Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge |
| Produktspezifikation | Produktspezifikation für das Produkt. Datentyp: Objekt |
| Produktspezifikation. id | SYS_ID des Produktspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktspezifikation. Interne ID | SYS_ID oder interne ID des Produktspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. |
| Produktspezifikation. InternalVersion | Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ 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]. |
| status | Status des Produktangebots. Mögliche Werte:
Datentyp: Zeichenfolge |
| Validiertfür | Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt |
| Validiertfür. EndDateTime | Enddatum des Produktangebots. Datentyp: Zeichenfolge |
| Validiertfür. 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]. |
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" \
--header "Accept:application/json" \
--data-raw '{
"id": "313b917843235210a82ed6085bb8f2c7",
"name": "Internet bundle",
"displayName": "Internet bundle",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-02-05 06:39:45",
"version": "",
"internalVersion": "1",
"internalId": "313b917843235210a82ed6085bb8f2c7",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "Premium",
"isMandatory": false,
"isDefault": true
}
]
},
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "When in use",
"isMandatory": false,
"isDefault": false
}
]
}
],
"bundledProductOffering": [
{
"id": "0f61dd9fd0a63110f8770dbf976be168",
"name": "Solana Sports streaming channel",
"version": "1",
"externalId": "EXT-123",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"id": "62619d9fd0a63110f8770dbf976be180",
"name": "Solana Movie streaming channel",
"version": "1",
"externalId": "EXT-345",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-12-18 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Base (10 site)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft"
}'
--user 'username':'password'
Antworttext:
{
"id": "313b917843235210a82ed6085bb8f2c7",
"name": "Internet bundle",
"displayName": "Internet bundle",
"description": "Internet bundle",
"isSellable": false,
"lifecycleStatus": "Draft",
"isBundle": true,
"lastUpdate": "2025-04-09 15:59:09",
"version": "",
"internalVersion": "1",
"validFor": {
"startDateTime": "2028-12-15",
"endDateTime": "2034-01-14"
},
"productOfferingTerm": "not_applicable",
"productOfferingPrice": [
{
"priceType": "recurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
},
{
"priceType": "nonRecurring",
"price": {
"taxIncludedAmount": {
"unit": "USD",
"value": "0"
}
}
}
],
"productOfferingCharacteristic": [
{
"name": "Firewall Security",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "Premium",
"isMandatory": false,
"isDefault": true
}
]
},
{
"name": "Connectivity need",
"valueType": "choice",
"characteristicValueSpecification": [
{
"value": "When in use",
"isMandatory": false,
"isDefault": false
}
]
}
],
"bundledProductOffering": [
{
"id": "0f61dd9fd0a63110f8770dbf976be168",
"name": "Solana Sports streaming channel",
"version": "1",
"externalId": "EXT-123",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOffering": [
{
"id": "063b957843235210a82ed6085bb8f205",
"name": "Streaming Channel",
"bundledProductOffering": [
{
"id": "62619d9fd0a63110f8770dbf976be180",
"name": "Solana Movie streaming channel",
"version": "1",
"externalId": "EXT-345",
"bundledProductOfferingOption": {
"numberRelOfferDefault": "1",
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"bundledGroupProductOfferingOption": {
"numberRelOfferLowerLimit": "1",
"numberRelOfferUpperLimit": "1"
}
}
],
"productSpecification": {
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6"
},
"prodSpecCharValueUse": [
{
"name": "Tenancy",
"description": "Tenancy",
"valueType": "choice",
"validFor": {
"startDatetime": "2024-12-18 21:04:24"
},
"productSpecCharacteristicValue": [
{
"value": "Premium (>50 sites)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Base (10 site)",
"isDefault": false,
"isMandatory": false,
"validFor": {
"startDateTime": ""
}
}
],
"productSpecification": {
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5"
}
}
],
"channel": [
{
"id": "58ad5522c3702010df4773ce3640ddb2",
"name": "Agent Assist"
}
],
"category": [
{
"id": "13e305a143b631105029d1529ab8f267",
"name": "SD-WAN_all_offers"
}
],
"status": "draft",
"externalId": "313b917843235210a82ed6085bb8f2c7",
"internalId": "03c99cb53bf066509b48d69a04e45a11",
"href": "/api/sn_tmf_api/catalogmanagement/productOffering/03c99cb53bf066509b48d69a04e45a11"
}
Produktkatalog – API öffnen – POST /sn_tmf_api/catalogManagement/productOfferingPrice
Erstellt einen neuen Preislistenpositionsdatensatz in der Tabelle „Preislistenposition“ [sn_csm_price_list_line].
URL-Format
Standard-URL: /api/sn_tmf_api/catalogmanagement/productOfferingPrice
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| @TYPE | Erforderlich. Typ der Preislistenposition. Immer ein Wert von ProduktangebotPreis .Datentyp: Zeichenfolge |
| externalId | Die externe ID der Preislistenposition. Datentyp: Zeichenfolge |
| IsBundle | Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktpakets ist. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Erforderlich. Datum, an dem die Preisposition zuletzt aktualisiert wurde. Format: JJJJ-MM-TT Datentyp: Zeichenfolge |
| Lebenszyklusstatus | Erforderlich. Aktueller Lebenszyklusstatus der Produktlistenposition. Gültige Werte:
Datentyp: Zeichenfolge Standard: Entwurf |
| name | Erforderlich. Name für die Preislistenposition. Datentyp: Zeichenfolge |
| Preis | Erforderlich. Listenpreisdetails der Preislistenposition. Datentyp: Objekt |
| Preis.Einheit | Erforderlich. Währungscode der Preislistenposition. Beispiel: USD Oder EUR .Tabelle: Tabelle „Währung“ [fx_currency]. Datentyp: Zeichenfolge |
| Preis.Wert | Erforderlich. Wert des Preises. Datentyp: Zeichenfolge (dargestellt durch eine Zahl. Beispiel: |
| priceList | Erforderlich. Preislisteninformationen, die der Preislistenposition zugeordnet sind. Datentyp: Objekt |
| Preisliste.ID | Erforderlich. SYS_ID der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| priceList.name | Name der Preislistenposition. Datentyp: Zeichenfolge |
| Preisliste.@type | Der Typ der Preislistenposition. Bei Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Wert ist immer Preisliste .Datentyp: Zeichenfolge |
| Preistyp | Erforderlich. Filtern Sie die Preislistenposition nach der Preismethode des Produktangebots. Gültige Werte:
Datentyp: Zeichenfolge Standard: Wiederkehrend |
| productOffering | Erforderlich. Produktangebot der Preislistenposition. Datentyp: Objekt |
| ProductOffering. id | Erforderlich. SYS_ID des Produktangebots. Tabelle: Produktangebot [sn_prd_pm_Product_offering] Datentyp: Zeichenfolge |
| ProductOffering. InternalVersion | Interne Versionsnummer des Produktangebots. Datentyp: Zeichenfolge (dargestellt durch eine Zahl. Beispiel: |
| ProductOffering. Name | Name des Produktangebots. Datentyp: Zeichenfolge |
| RecurringChargePeriodType | Erforderlich, wenn priceTypeIst wiederkehrend. Zusagebedingungen, die bei der Erstellung des Produktangebots ausgewählt werden. Gültige Werte:
Datentyp: Zeichenfolge |
| Maßeinheit | Erforderlich. Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt |
| 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. Beispiel: Jeweils Oder Paket .Datentyp: Zeichenfolge |
| Validiertfür | Erforderlich. Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt |
| 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
Antworttext-Parameter (JSON oder XML)
| Name | Beschreibung |
|---|---|
| id | SYS_ID der Preislistenposition. Tabelle: Preislistenpositionen [sn_csm_pricing_price_list_line] Datentyp: Zeichenfolge |
| href | URL zum Preislistenpositionsdatensatz in der Instanz. Datentyp: Zeichenfolge |
| Letztes Update | Datum und Uhrzeit der letzten Aktualisierung der Preislistenposition. Format: JJJJ-MM-TT HH:mm:ss Datentyp: Zeichenfolge |
| Validiertfür | Die Dauer, für die die Preislistenposition gültig ist. Datentyp: Objekt |
| 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) |
| IsBundle | Kennzeichnung, die angibt, ob die Preislistenposition Teil eines einzelnen Produkts oder eines Produktpakets ist. Gültige Werte:
Datentyp: Boolesch |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus der Preislistenposition. Gültige Werte:
Datentyp: Zeichenfolge |
| productOffering | Produktangebot, das der Preislistenposition zugeordnet ist. Datentyp: Objekt |
| Produktangebot.ID | SYS_ID des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| ProductOffering. InternalVersion | Interne Versionsnummer des Produktangebots. Beispiel: PRDOF01024 . Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering].Datentyp: Zeichenfolge |
| ProductOffering. Name | Name des Produktangebots. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_Product_offering]. Datentyp: Zeichenfolge |
| Preistyp | Die Preismethode des Produktangebots, das dieser Preislistenposition zugeordnet ist. Mögliche Werte:
Datentyp: Zeichenfolge |
| RecurringChargePeriodType | Die Periodizität oder Häufigkeit des Produktangebots, das dieser Preislistenposition zugeordnet ist. Gibt einen Häufigkeitstyp zurück, wenn priceTypeWurde auf festgelegt Wiederkehrend , Andernfalls wird eine leere Zeichenfolge zurückgegeben.Mögliche Werte:
Datentyp: Zeichenfolge |
| Maßeinheit | Details zur Maßeinheit, die der Preislistenposition zugeordnet ist. Datentyp: Objekt |
| EinheitenMessung.Betrag | Betrag der Maßeinheit. Datentyp: Zahl |
| EinheitenMessung.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. Beispiel: Jahr Oder Paket .Datentyp: Zeichenfolge |
| Preis | Listenpreisdetails der Preislistenposition. Datentyp: Objekt |
| Preis.Einheiten | Währungscode des Preises. 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 |
| Preisliste.ID | SYS_ID der Preisliste in der Tabelle „Preisliste“ [sn_csm_price_list]. Datentyp: Zeichenfolge |
| priceList.name | Name der Preisliste. Datentyp: Zeichenfolge |
| Preisliste.@type | Der Typ der Preisliste. Bei Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse. Hat immer einen Wert von Preisliste .Datentyp: Zeichenfolge |
| @TYPE | Immer ein Wert von ProduktangebotPreis . Bei Unterklassifizierung definiert dies den erweiterbaren Namen der Unterklasse.Datentyp: Zeichenfolge |
| Status | Der Status der Preisliste, die dieser Preislistenposition zugeordnet ist. Datentyp: Zeichenfolge |
| externalId | Die externe ID dieser Preislistenposition. Datentyp: Zeichenfolge |
cURL-Anforderung
Das folgende Beispiel erstellt einen neuen Preislistenpositionsdatensatz gemäß den im Anforderungstext angegebenen Daten und fügt ihn in die Tabelle „Preislistenposition“ [sn_csm_pricing_price_list_line] ein.
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 Preislistenpositionsdatensatz wird eine eindeutige ID zugewiesen. Der Antworttext gibt diese Informationen zusammen mit einer URL an den neuen Datensatz mit zurück hrefAntwortparameter.
{
"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 – API öffnen – POST /sn_tmf_api/catalogManagement/ProductSpecification
Erstellt einen Produktspezifikationsdatensatz mit den angegebenen Werten.
URL-Format
Standard-URL: /api/sn_tmf_api/catalogmanagement/ProductSpecification
Unterstützte Anforderungsparameter
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Keine |
| Name | Beschreibung |
|---|---|
| Beschreibung | Erforderlich. Beschreibung der Spezifikation. Datentyp: Zeichenfolge |
| externalId | Eindeutiger Bezeichner für die Produktspezifikation aus dem externen System. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| id | Erforderlich. SYS_ID oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: In der initial_Version oder external_ID der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| internalId | Erforderlich. SYS_ID oder interne ID 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 Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| Letztes Update | Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS. Beispiel: Standard: Leere Zeichenfolge |
| name | Erforderlich. Name der Spezifikation. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal | Spezifikationsmerkmal. Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| Produktspezifikationsmerkmal. Name | Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue | Erforderlich. Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Wert | Erforderlich. Wert des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| Produktspezifikationsmerkmal. Validiertfür. EndDateTime | Enddatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS. Beispiel: Standard: Leere Zeichenfolge |
| Produktspezifikationsmerkmal. Validiertfür. StartDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS. Beispiel: Standard: Leere Zeichenfolge |
| Produktspezifikationsmerkmal. Wertetyp | Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Kann einen komplexen oder nicht komplexen Typ haben. Datentyp: Zeichenfolge Akzeptierte Werte:
Standard: Leere Zeichenfolge |
| ProduktspezifikationBeziehung | Die Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array |
| ProduktspezifikationBeziehung. id | ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| ProduktspezifikationBeziehung. Typ | Erforderlich, wenn verwendet wird productSpecificationRelationshipParameter. Typ der Beziehung. Gültige Werte:
Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür | Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt |
| ProduktspezifikationBeziehung. Validiertfür. EndDateTime | Enddatum der Beziehung. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS. Beispiel: Standard: Leere Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür. StartDateTime | Startdatum der Beziehung. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS. Beispiel: Standard: Leere Zeichenfolge |
| ResourceSpecification | Erforderlich. Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| 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. Interne ID | Anfangsversion (sys_ID) des Ressourcenspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_Specification]. |
| ResourceSpecification. InternalVersion | Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ 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]. |
| ServiceSpezifikation | Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| ServiceSpezifikation. 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. Interne ID | Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. InternalVersion | Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. 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]. |
| Validiertfür | Erforderlich. Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt |
| Validiertfür. EndDateTime | Enddatum der Spezifikation. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS. Beispiel: Standard: Leere Zeichenfolge |
| Validiertfür. StartDateTime | Startdatum der Spezifikation. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS. Beispiel: 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 .
| Kopfzeile | Beschreibung |
|---|---|
| Akzeptieren | Datenformat des Antworttexts. Unterstützt nur application/json. |
| Inhaltstyp | Datenformat des Antworttexts. Unterstützt nur application/json. |
| 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 REST API-HTTP-Antwortcodes .
| Statuscode | Beschreibung |
|---|---|
| 201 | Anforderung erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Mögliche Gründe:
|
Parameter des Antwort-Haupttexts
| Name | Beschreibung |
|---|---|
| Beschreibung | Beschreibung der Spezifikation. Datentyp: Zeichenfolge |
| href | Relativer Link zum Ressourcendatensatz. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| id | SYS_ID oder externe ID der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| internalId | Erforderlich. SYS_ID oder interne ID 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 Feld „Version“ der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
| IsBundle | Kennzeichnung, die angibt, ob productSpecificationStellt ein einzelnes Produkt oder ein Produktpaket dar. Gültige Werte:
Datentyp: Boolesch Standardwert: false |
| Letztes Update | Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| LebenszyklusStatus | Aktueller Lebenszyklusstatus der Produktspezifikation. Mögliche Werte:
Datentyp: Zeichenfolge Standard: Leere Zeichenfolge |
| name | Name der Spezifikation. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal | Spezifikationsmerkmal. Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. Beschreibung | Beschreibung des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Name | Name des Merkmals. Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue |
Liste der möglichen Werte des Merkmals.
Datentyp: Array von Objekten |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. IsStandard | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert der Standardwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Ist obligatorisch | Kennzeichnung, die angibt, ob der zugeordnete Merkmalswert ein Pflichtwert für das Merkmal ist. Mögliche Werte:
Standardwert: false |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür | Datum und Uhrzeit der Gültigkeit des Merkmals. Datentyp: Objekt |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Validiertfür. StartDateTime | Startdatum und -Uhrzeit, zu der der Merkmalswert gültig ist. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Produktspezifikationsmerkmal. ProduktSpecMerkmalValue. Wert |
Wert des Merkmals.
Datentyp: Zeichenfolge |
| Produktspezifikationsmerkmal. Validiertfür | Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt |
| Produktspezifikationsmerkmal. Validiertfür. EndDateTime | Enddatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Produktspezifikationsmerkmal. Validiertfür. StartDateTime | Startdatum des Merkmals. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Produktspezifikationsmerkmal. Wertetyp | Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Kann einen komplexen oder nicht komplexen Typ haben. Datentyp: Zeichenfolge Akzeptierte Werte:
|
| ProduktspezifikationBeziehung | Die Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten |
| ProduktspezifikationBeziehung. id | SYS_ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Typ | Typ der Beziehung. Datentyp: Zeichenfolge |
| ProduktspezifikationBeziehung. Validiertfür | Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt |
| ProduktspezifikationBeziehung. Validiertfür. EndDateTime | Enddatum der Beziehung. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ProduktspezifikationBeziehung. Validiertfür. StartDateTime | Startdatum der Beziehung. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| ResourceSpecification | Liste der Ressourcenspezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| ResourceSpecification. id | SYS_ID oder externe ID der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „sys_ID“ oder „external_ID“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_Specification]. |
| ResourceSpecification. Interne ID | Anfangsversion (sys_ID) des Ressourcenspezifikationsdatensatzes. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_Specification]. |
| ResourceSpecification. InternalVersion | Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ 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]. |
| ServiceSpezifikation | Liste der Servicespezifikationen im Zusammenhang mit dieser Produktspezifikation. Datentyp: Array von Objekten |
| ServiceSpezifikation. 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. Interne ID | Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld initial_Version der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. InternalVersion | Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_Service_Specification]. |
| ServiceSpezifikation. 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]. |
| Validiertfür | Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt |
| Validiertfür. EndDateTime | Enddatum der Spezifikation. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Validiertfür. StartDateTime | Startdatum der Spezifikation. Datentyp: Zeichenfolge Format: JJJJ-MM-TT HH:mm:SS |
| Version | Externe Version der Produktspezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Produktspezifikation“ [sn_prd_pm_Product_Specification]. |
In diesem Beispiel wird ein Produktspezifikationsdatensatz mit den angegebenen Werten erstellt.
curl --location --request POST "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/productSpecification" \
--header "Content-Type: application/json" \
--data-raw '{
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"displayName": "SD-WAN Service Package v3",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"description": "SD WAN Service Package",
"lastUpdate": "2027-10-11 06:58:12",
"isBundle": true,
"validFor": {
"startDateTime": "2029-02-05",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [
{
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"type": "Service",
"validFor": {
"startDateTime": "2025-01-24",
"endDateTime": ""
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "1",
"numberSpecRelUpperLimit": "1"
}
},
{
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "",
"internalVersion": "2",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-05",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "2",
"numberSpecRelUpperLimit": "4"
}
},
{
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "",
"internalVersion": "2",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-03",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "4",
"numberSpecRelUpperLimit": "20"
}
}
],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "1",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.25",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.01",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.5",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Down Time",
"description": "Down Time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:36:15"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "500 Mbps",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "5 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Bandwidth",
"description": "Bandwidth",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:32:11"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "4 hrs",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 hr",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Time to Restore (TTR)",
"description": "Time to Restore (TTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:37:25"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "4 hrs",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Mean Time to Restore (MTR)",
"description": "Mean Time to Restore (MTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:39:05"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Flow Backup",
"description": "Application Flow Backup",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:30:39"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "99.00",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.50",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.75",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.99",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Up Time",
"description": "Up time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:34:30"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Encryption",
"description": "Application Encryption",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:29:08"
}
}
],
"status": "published"
}'
--user 'username':'password'
Antworttext.
{
"id": "cfe5ef6a53702010cd6dddeeff7b12f6",
"href": "/api/sn_tmf_api/catalogmanagement/productSpecification/cfe5ef6a53702010cd6dddeeff7b12f6",
"name": "SD-WAN Service Package",
"displayName": "SD-WAN Service Package v3",
"version": "",
"internalVersion": "3",
"internalId": "cfe5ef6a53702010cd6dddeeff7b12f6",
"description": "SD WAN Service Package",
"lastUpdate": "2027-10-11 06:58:12",
"isBundle": true,
"validFor": {
"startDateTime": "2029-02-05",
"endDateTime": ""
},
"serviceSpecification": [],
"productSpecificationRelationship": [
{
"id": "216663aa53702010cd6dddeeff7b12b5",
"name": "SD-WAN Controller",
"version": "",
"internalVersion": "1",
"internalId": "216663aa53702010cd6dddeeff7b12b5",
"type": "Service",
"validFor": {
"startDateTime": "2025-01-24",
"endDateTime": ""
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "1",
"numberSpecRelUpperLimit": "1"
}
},
{
"id": "39b627aa53702010cd6dddeeff7b1202",
"name": "SD-WAN Edge Device",
"version": "",
"internalVersion": "2",
"internalId": "39b627aa53702010cd6dddeeff7b1202",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-05",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "2",
"numberSpecRelUpperLimit": "4"
}
},
{
"id": "a6514bd3534560102f18ddeeff7b1247",
"name": "SD-WAN Security",
"version": "",
"internalVersion": "2",
"internalId": "a6514bd3534560102f18ddeeff7b1247",
"type": "Service",
"validFor": {
"startDateTime": "2026-06-03",
"endDateTime": "2031-07-05"
},
"relationshipType": "bundles",
"ProdSpecRelationshipOption": {
"numberSpecRelLowerLimit": "1",
"numberSpecRelDefault": "4",
"numberSpecRelUpperLimit": "20"
}
}
],
"resourceSpecification": [],
"productSpecCharacteristic": [
{
"productSpecCharacteristicValue": [
{
"value": "1",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.25",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.01",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "0.5",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Down Time",
"description": "Down Time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:36:15"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "500 Mbps",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "5 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 Gbps",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Bandwidth",
"description": "Bandwidth",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:32:11"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "4 hrs",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "1 hr",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Time to Restore (TTR)",
"description": "Time to Restore (TTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:37:25"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "1 hr",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "2 hrs",
"isMandatory":true,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
},
{
"value": "4 hrs",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Mean Time to Restore (MTR)",
"description": "Mean Time to Restore (MTR)",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:39:05"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Flow Backup",
"description": "Application Flow Backup",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:30:39"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "99.00",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.50",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.75",
"validFor": {
"startDateTime": ""
}
},
{
"value": "99.99",
"validFor": {
"startDateTime": ""
}
}
],
"name": "Up Time",
"description": "Up time",
"valueType": "choice",
"validFor": {
"startDatetime": "2027-10-11 02:34:30"
}
},
{
"productSpecCharacteristicValue": [
{
"value": "No",
"isMandatory":true,
"isDefault":true,
"validFor": {
"startDateTime": ""
}
},
{
"value": "Yes",
"isMandatory":false,
"isDefault":false,
"validFor": {
"startDateTime": ""
}
}
],
"name": "Application Encryption",
"description": "Application Encryption",
"valueType": "yes_no",
"validFor": {
"startDatetime": "2027-10-11 02:29:08"
}
}
],
"status": "published"
}'