Product Catalog Open API

Die Product Catalog Open API bietet Endpunkte zum Erstellen und Abrufen von Produktkatalogen, Produktangeboten und Produktspezifikationen.

Verwenden Sie diese API, um Produktkataloginformationen zwischen externen Systemen und Now Platformzu verwalten. Die Product Catalog Open API ist eine ServiceNow® Implementierung der REST-Spezifikation der Product Catalog-Management-API des TM Forums. Diese Implementierung basiert auf der REST-Spezifikation TMF620 Product Catalog-Management-API Version 4, April 2021.

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

Diese API wird innerhalb des Namespace sn_prd_pm_adv bereitgestellt.

Der aufrufende Benutzer muss die Rolle sn_prd_pm_adv.catalog_integrator haben.

Diese API erstellt und aktualisiert Daten in den folgenden Tabellen.

• Merkmal [sn_prd_pm_characteristic]
• 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_characteristic]
• Produktspezifikation [sn_prd_pm_product_specification]
• Spezifikationsbeziehung [sn_prd_pm_specification_relationship]

Product Catalog Open API – GET /sn_prd_pm_adv/catalogmanagement/catalog

Ruft eine Liste aller Produktangebotskataloge ab.

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Wenn dieser Parameter nicht verwendet wird, werden alle Felder zurückgegeben. Datentyp: Zeichenfolge
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Standard: 20 Höchstwert: 100 Datentyp: Zahl
Offset	Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Standard: 0 Datentyp: Zahl

Tabelle : 3. Anforderungstextparameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 4. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Keine

Tabelle : 5. Antwortkopfzeilen

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

Statuscodes

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

Tabelle : 6. Statuscodes

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

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Beschreibung	Beschreibung des Produktangebotskatalogs. Datentyp: Zeichenfolge
id	Sys_id des Produktangebotskatalogs aus der Tabelle „Produktangebotskatalog“ [sn_prd_pm_product_offering_catalog]. Datentyp: Zeichenfolge
Name	Name des Produktangebotskatalogs. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden alle Produktangebotskataloge abgerufen.

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

Antworttext.

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

Product Catalog Open API – GET /sn_prd_pm_adv/catalogmanagement/catalog/{catalogId}

Ruft einen Produktangebotskatalog ab.

URL-Format

Standard-URL: /api/sn_prd_pm_adv/catalogmanagement/catalog/{catalogId}

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter

Name	Beschreibung
catalogId	Sys_id des abzurufenden Produktangebotskatalogs. Befindet sich in der Tabelle „Produktangebotskatalog“ [sn_prd_pm_product_offering_catalog]. Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter

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

Tabelle : 9. Anforderungstextparameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 10. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Keine

Tabelle : 11. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 12. Statuscodes

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

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Beschreibung	Beschreibung des Produktangebotskatalogs. Datentyp: Zeichenfolge
id	Sys_id des Produktangebotskatalogs aus der Tabelle „Produktangebotskatalog“ [sn_prd_pm_product_offering_catalog]. Datentyp: Zeichenfolge
Name	Name des Produktangebotskatalogs. Datentyp: Zeichenfolge

cURL-Anforderung

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

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

Antworttext.

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

Product Catalog Open API – GET /sn_prd_pm_adv/catalogmanagement/productoffering

Ruft alle Produktangebote ab.

URL-Format

Standard-URL: /api/sn_prd_pm_adv/catalogmanagement/productoffering

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 14. Abfrageparameter

Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: Kategorie Kanal Beschreibung externe ID id internalId interneVersion lastUpdate Name produktMerkmal productOfferingPrice productOfferingTerm Produktspezifikation prodSpecCharValueUse gültigFür version Standard: Alle Felder werden zurückgegeben. Datentyp: Zeichenfolge
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Standard: 20 Höchstwert: 100 Datentyp: Zahl
Offset	Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Standard: 0 Datentyp: Zahl
Spezifikation	Filtern Sie Produktangebote nach sys_id der Produktspezifikation. In der Antwort werden nur Produktangebote mit der angegebenen sys_id der Produktspezifikation zurückgegeben. Befindet sich in der Produktspezifikationstabelle [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
Status	Filtern Sie die Produktangebote nach Status. In der Antwort werden nur Produktangebote im angegebenen Status zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 15. Anforderungstextparameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 16. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Keine

Tabelle : 17. Antwortkopfzeilen

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

Statuscodes

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

Tabelle : 18. Statuscodes

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

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Kategorie	Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten "category:" [ { "id": "String", "name": "String" } ]
Kategorie.ID	ID der Kategorie. Datentyp: Zeichenfolge
Kategorie.Name	Name der Kategorie. Datentyp: Zeichenfolge
Kanal	Kanäle, die für den Verkauf des Produktangebots verwendet werden sollen. Datentyp: Array von Objekten "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	Beschreibung des Kanals. Datentyp: Zeichenfolge
channel.id	Sys_id des Kanals aus der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Produktangebots. Datentyp: Zeichenfolge
externe ID	External_id des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
id	Initial_version oder external_id des Produktangebots aus der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
internalId	Initial_version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
interneVersion	Version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
lastUpdate	Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
Name	Name des Produktangebots. Datentyp: Zeichenfolge
produktMerkmal	Liste der Produktmerkmale. Datentyp: Array von Objekten "productCharacteristic": [ { "name": "String", "value": "String" } ]
produktMerkmal.name	Name des Merkmals. Datentyp: Zeichenfolge
produktMerkmal.wert	Wert des Merkmals. Datentyp: Zeichenfolge
productOfferingPrice	Preisinformationen für das Produktangebot. Datentyp: Array von Objekten "productOfferingPrice": [ { "price": Object, "priceType": "String" } ]
productOfferingPrice.price	Preisinformationen für das Produktangebot. Datentyp: Objekt "price": { "taxIncludedAmount": Object }
productOfferingPrice.price.taxIncludedAmount	Preisinformationen für das Produktangebot. Datentyp: Objekt "taxIncludedAmount": { "unit": "String", "value": "String" }
produktOfferingPrice.price.taxIncludedAmount.unit	Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge
productOfferingPrice.price.taxIncludedAmount.value	Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge
productOfferingPrice.priceType	Typ des Produktangebotspreises, einmalige oder wiederkehrende Zahlung. Gültige Werte: nonRecurring (einmalig) recurring Datentyp: Zeichenfolge
productOfferingTerm	Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge
Produktspezifikation	Produktspezifikation für das Produkt. Datentyp: Objekt "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
produktSpecification.id	Initial_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
produktSpecification.internalId	Initial_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
produktSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
Produktspezifikation.Version	External_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
prodSpecCharValueUse	Merkmale des Produktangebots. Datentyp: Array von Objekten "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Mögliche Werte des Merkmals. Datentyp: Array von Objekten "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.name	Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.valueType	Werttyp des Merkmals, z. B. Auswahl oder E-Mail.
gültigFür	Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
gültigFür.endDateTime	Enddatum des Produktangebots. Datentyp: Zeichenfolge
gültigFür.startDateTime	Startdatum des Produktangebots. Datentyp: Zeichenfolge
version	External_version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden alle Produktangebote abgerufen.

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

Antworttext:

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

Product Catalog Open API – GET /sn_prd_pm_adv/catalogmanagement/productoffering/{offeringId}

Ruft ein Produktangebot ab.

URL-Format

Standard-URL: /api/sn_prd_pm_adv/catalogmanagement/productoffering/{offeringId}

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter

Name	Beschreibung
Angebots-ID	Initial_version des abzurufenden Produktangebots. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: Kategorie Kanal Beschreibung externe ID id internalId interneVersion lastUpdate Name produktMerkmal productOfferingPrice productOfferingTerm Produktspezifikation prodSpecCharValueUse gültigFür version Standard: Alle Felder werden zurückgegeben. Datentyp: Zeichenfolge
Spezifikation	Filtern Sie Produktangebote nach sys_id der Produktspezifikation. In der Antwort werden nur Produktangebote mit der angegebenen sys_id der Produktspezifikation zurückgegeben. Befindet sich in der Produktspezifikationstabelle [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
Status	Filtern Sie die Produktangebote nach Status. In der Antwort werden nur Produktangebote im angegebenen Status zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 21. Anforderungstextparameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 22. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Keine

Tabelle : 23. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 24. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Datensatz nicht gefunden Der mit der ID verknüpfte Datensatz wurde in der Tabelle nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Kategorie	Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array "category:" [ { "id": "String", "name": "String" } ]
Kategorie.ID	ID der Kategorie. Datentyp: Zeichenfolge
Kategorie.Name	Name der Kategorie. Datentyp: Zeichenfolge
Kanal	Kanäle, die für den Verkauf des Produktangebots verwendet werden sollen. Datentyp: Array "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	Beschreibung des Kanals. Datentyp: Zeichenfolge
channel.id	Sys_id des Kanals aus der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Produktangebots. Datentyp: Zeichenfolge
externe ID	External_id des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
id	Initial_version oder external_id des Produktangebots aus der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
internalId	Initial_version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
interneVersion	Version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
lastUpdate	Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
Name	Name des Produktangebots. Datentyp: Zeichenfolge
produktMerkmal	Liste der Produktmerkmale. Datentyp: Array "productCharacteristic": [ { "name": "String", "value": "String" } ]
produktMerkmal.name	Name des Merkmals. Datentyp: Zeichenfolge
produktMerkmal.wert	Wert des Merkmals. Datentyp: Zeichenfolge
productOfferingPrice	Preisinformationen für das Produktangebot. Datentyp: Array "productOfferingPrice": [ { "price": Object, "priceType": "String" } ]
productOfferingPrice.price	Preisinformationen für das Produktangebot. Datentyp: Objekt "price": { "taxIncludedAmount": Object }
productOfferingPrice.price.taxIncludedAmount	Preisinformationen für das Produktangebot. Datentyp: Objekt "taxIncludedAmount": { "unit": "String", "value": "String" }
produktOfferingPrice.price.taxIncludedAmount.unit	Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge
productOfferingPrice.price.taxIncludedAmount.value	Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge
productOfferingPrice.priceType	Gibt an, ob der Produktangebotspreis eine einmalige oder wiederkehrende Zahlung ist. Gültige Werte: nicht wiederkehrend recurring Datentyp: Zeichenfolge
productOfferingTerm	Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge
Produktspezifikation	Produktspezifikation für das Produkt. Datentyp: Objekt "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
produktSpecification.id	Initial_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
produktSpecification.internalId	Initial_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
produktSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
Produktspezifikation.Version	External_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
prodSpecCharValueUse	Merkmal des Produktangebots. Datentyp: Array "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Array mit den möglichen Werten des Merkmals. Datentyp: Array "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.name	Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.valueType	Der Werttyp des Merkmals, z. B. Auswahl oder E-Mail.
gültigFür	Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
gültigFür.endDateTime	Enddatum des Produktangebots. Datentyp: Zeichenfolge
gültigFür.startDateTime	Startdatum des Produktangebots. Datentyp: Zeichenfolge
version	External_version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Produktangebot abgerufen.

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

Antworttext:

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

Product Catalog Open API – GET /sn_prd_pm_adv/catalogmanagement/productspecification

Ruft alle Produktspezifikationen ab.

URL-Format

Standard-URL: /api/sn_prd_pm_adv/catalogmanagement/productspecification

Unterstützte Anforderungsparameter

Tabelle : 25. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 26. Abfrageparameter

Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: Beschreibung externe ID id internalId interneVersion lastUpdate Name produktSpecCharacteristic productSpecificationRelationship resourceSpecification serviceSpecification gültigFür version Standard: Alle Felder werden zurückgegeben. Datentyp: Zeichenfolge
limit	Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter offset, um den Datensatzabruf zu paginieren. Standard: 20 Höchstwert: 100 Datentyp: Zahl
Offset	Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Standard: 0 Datentyp: Zahl
Status	Filtern Sie Produktspezifikationennach Status. In der Antwort werden nur Produktspezifikationen im angegebenen Status zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 27. Anforderungstextparameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 28. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Keine

Tabelle : 29. Antwortkopfzeilen

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

Statuscodes

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

Tabelle : 30. Statuscodes

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

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Beschreibung	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externe ID	External_id der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
id	Initial_version oder external_id der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
internalId	Initial_version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
interneVersion	Version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
lastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
Name	Name der Spezifikation. Datentyp: Zeichenfolge
produktSpecCharacteristic	Spezifikationsmerkmal. Datentyp: Array von Objekten "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
produktSpecCharacteristic.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacteristic.productSpecCharacteristicValue	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten "productSpecCharacteristicValue": [ { "value": "String" } ]
produktSpecCharacteristic.productSpecCharacteristicValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
productSpecCharacteristic.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
produktSpecCharacteristic.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacteristic.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
productSpecCharacteristic.valueType	Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Datentyp: Zeichenfolge
productSpecificationRelationship	Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
produktSpecificationRelationship.id	ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge
produktSpecificationRelationship.type	Typ der Beziehung. Datentyp: Zeichenfolge
produktSpecificationRelationship.validFor	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
produktSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge
produktSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge
resourceSpecification	Liste der Ressourcenspezifikationen, die sich auf diese Produktspezifikation beziehen. Datentyp: Array von Objekten "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Initial_version oder external_id der Ressourcenspezifikation. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.internalId	Initial_version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.internalVersion	Version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.version	External_version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
serviceSpecification	Liste der Servicespezifikationen, die sich auf diese Produktspezifikation beziehen. Datentyp: Array von Objekten "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	Initial_version oder external_id der Servicespezifikation. Befindet sich im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.internalId	Initial_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.internalVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.version	External_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
gültigFür	Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
gültigFür.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
gültigFür.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
version	External_version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden alle Produktspezifikationen abgerufen.

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

Antworttext:

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

Product Catalog Open API – GET /sn_prd_pm_adv/catalogmanagement/productspecification/{specificationId}

Ruft eine angegebene Produktspezifikation ab.

URL-Format

Standard-URL: /api/sn_prd_pm_adv/catalogmanagement/productspecification/{specificationId}

Unterstützte Anforderungsparameter

Tabelle : 31. Pfadparameter

Name	Beschreibung
Spezifikations-ID	Initial_version der abzurufenden Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge

Tabelle : 32. Abfrageparameter

Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: Beschreibung externe ID id internalId interneVersion lastUpdate Name produktSpecCharacteristic productSpecificationRelationship resourceSpecification serviceSpecification gültigFür version Standard: Alle Felder werden zurückgegeben. Datentyp: Zeichenfolge
Status	Filtern Sie Produktspezifikationennach Status. In der Antwort werden nur Produktspezifikationen im angegebenen Status zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 33. Anforderungstextparameter (JSON)

Name	Beschreibung
Keine

Kopfzeilen

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

Tabelle : 34. Anforderungskopfzeilen

Kopfzeile	Beschreibung
Keine

Tabelle : 35. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 36. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet.
400	Ungültige Anforderung. Mögliche Gründe: Ungültiger Pfadparameter Ungültiger URI
404	Datensatz nicht gefunden Der mit der ID verknüpfte Datensatz wurde in der Tabelle nicht gefunden.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Beschreibung	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externe ID	External_id der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
id	Initial_version oder external_id der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
internalId	Initial_version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
interneVersion	Version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
lastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
Name	Name der Spezifikation. Datentyp: Zeichenfolge
produktSpecCharacteristic	Spezifikationsmerkmale. Datentyp: Array von Objekten "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
produktSpecCharacteristic.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacteristic.productSpecCharacteristicValue	Mögliche Werte des Merkmals. Datentyp: Array von Objekten "productSpecCharacteristicValue": [ { "value": "String" } ]
produktSpecCharacteristic.productSpecCharacteristicValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
productSpecCharacteristic.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
produktSpecCharacteristic.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacteristic.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
productSpecCharacteristic.valueType	Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Datentyp: Zeichenfolge
productSpecificationRelationship	Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array von Objekten "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
produktSpecificationRelationship.id	ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge
produktSpecificationRelationship.type	Typ der Beziehung. Datentyp: Zeichenfolge
produktSpecificationRelationship.validFor	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
produktSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge
produktSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge
resourceSpecification	Liste der Ressourcenspezifikationen, die sich auf diese Produktspezifikation beziehen. Datentyp: Array von Objekten "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Initial_version oder external_id der Ressourcenspezifikation. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.internalId	Initial_version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.internalVersion	Version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.version	External_version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
serviceSpecification	Liste der Servicespezifikationen, die sich auf diese Produktspezifikation beziehen. Datentyp: Array von Objekten "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	Initial_version oder external_id der Servicespezifikation. Befindet sich im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.internalId	Initial_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.internalVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.version	External_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
gültigFür	Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
gültigFür.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
gültigFür.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
version	External_version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird eine Produktspezifikation abgerufen.

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

Antworttext:

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

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

Erstellt einen Produktangebotskatalog.

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 37. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 38. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 39. Anforderungstextparameter (JSON)

Name	Beschreibung
Beschreibung	Beschreibung des Produktangebotskatalogs. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
externe ID	Eindeutiger Bezeichner für den Produktangebotskatalog aus dem externen System. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Name	Erforderlich. Name des Produktangebotskatalogs. Datentyp: Zeichenfolge

Header

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

Tabelle : 40. Anforderungskopfzeilen

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

Tabelle : 41. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 42. Statuscodes

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

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Beschreibung	Beschreibung des Produktangebotskatalogs. Datentyp: Zeichenfolge
id	Sys_id des Produktangebotskatalogs aus der Tabelle „Produktangebotskatalog“ [sn_prd_pm_product_offering_catalog]. Datentyp: Zeichenfolge
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_prd_pm_adv/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"
}

Product Catalog Open API – POST /sn_prd_pm_adv/catalogmanagement/productoffering

Erstellt ein Produktangebot.

URL-Format

Standard-URL: /api/sn_prd_pm_adv/catalogmanagement/productoffering

Unterstützte Anforderungsparameter

Tabelle : 43. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 44. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 45. Anforderungstextparameter (JSON)

Name	Beschreibung
Kategorie	Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array von Objekten "category:" [ { "id": "String", "name": "String" } ]
Kategorie.ID	Erforderlich, wenn der Parameter category verwendet wird. ID der Kategorie. Datentyp: Zeichenfolge
Kategorie.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 "channel:" [ { "description": "String", "id": "String", "name": "String" } ]
channel.description	Beschreibung des Kanals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
channel.id	Erforderlich. Sys_id des Kanals aus der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Beschreibung	Erforderlich. Beschreibung des Produktangebots. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner für das Produktangebot aus dem externen System. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Erforderlich. Initial_version oder external_id des Produktangebots aus der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
internalId	Initial_version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
interneVersion	Version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
lastUpdate	Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Name	Erforderlich. Name des Produktangebots. Datentyp: Zeichenfolge
produktMerkmal	Liste der Produktmerkmale. Datentyp: Array von Objekten "productCharacteristic": [ { "name": "String", "value": "String" } ]
produktMerkmal.name	Name des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
produktMerkmal.wert	Wert des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
productOfferingPrice	Preisinformationen für das Produktangebot. Datentyp: Array von Objekten "productOfferingPrice": [ { "price": Object, "priceType": "String" } ]
productOfferingPrice.price	Preisinformationen für das Produktangebot. Datentyp: Objekt "price": { "taxIncludedAmount": Object }
productOfferingPrice.price.taxIncludedAmount	Preisinformationen für das Produktangebot. Datentyp: Objekt "taxIncludedAmount": { "unit": "String", "value": "String" }
produktOfferingPrice.price.taxIncludedAmount.unit	Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
productOfferingPrice.price.taxIncludedAmount.value	Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
productOfferingPrice.priceType	Erforderlich, wenn der Parameter productOfferingPrice verwendet wird. Preistyp des Produktangebots, einmalige oder wiederkehrende Zahlung. Gültige Werte: nonRecurring (einmalig) recurring 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": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
produktSpecification.id	Erforderlich. Initial_version oder external_id der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
produktSpecification.internalId	Initial_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
produktSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
Produktspezifikation.Version	External_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
prodSpecCharValueUse	Merkmale des Produktangebots. Datentyp: Array von Objekten "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Erforderlich. Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Erforderlich. Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
prodSpecCharValueUse.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
prodSpecCharValueUse.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
prodSpecCharValueUse.valueType	Werttyp des Merkmals, z. B. Auswahl oder E-Mail.
gültigFür	Erforderlich. Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
gültigFür.endDateTime	Enddatum des Produktangebots. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
gültigFür.startDateTime	Startdatum des Produktangebots. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
version	External_version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge

Header

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

Tabelle : 46. Anforderungskopfzeilen

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

Tabelle : 47. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 48. Statuscodes

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

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Kategorie	Liste der Kategorien, zu denen das Produkt gehört. Datentyp: Array "category:" [ { "id": "String", "name": "String" } ]
Kategorie.ID	ID der Kategorie. Datentyp: Zeichenfolge
Kategorie.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": "String", "id": "String", "name": "String" } ]
channel.description	Beschreibung des Kanals. Datentyp: Zeichenfolge
channel.id	Sys_id des Kanals aus der Tabelle „Verteilungskanal“ [sn_prd_pm_distribution_channel]. Datentyp: Zeichenfolge
channel.name	Name des Kanals. Datentyp: Zeichenfolge
Beschreibung	Beschreibung des Produktangebots. Datentyp: Zeichenfolge
externe ID	External_id des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
id	Initial_version oder external_id des Produktangebots aus der Tabelle „Produktangebot“ [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
internalId	Initial_version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
interneVersion	Version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
lastUpdate	Datum, an dem das Produktangebot zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
Name	Name des Produktangebots. Datentyp: Zeichenfolge
produktMerkmal	Liste der Produktmerkmale. Datentyp: Array von Objekten "productCharacteristic": [ { "name": "String", "value": "String" } ]
produktMerkmal.name	Name des Merkmals. Datentyp: Zeichenfolge
produktMerkmal.wert	Wert des Merkmals. Datentyp: Zeichenfolge
productOfferingPrice	Preisinformationen für das Produktangebot. Datentyp: Array von Objekten "productOfferingPrice": [ { "price": Object, "priceType": "String" } ]
productOfferingPrice.price	Preisinformationen für das Produktangebot. Datentyp: Objekt "price": { "taxIncludedAmount": Object }
productOfferingPrice.price.taxIncludedAmount	Preisinformationen für das Produktangebot. Datentyp: Objekt "taxIncludedAmount": { "unit": "String", "value": "String" }
produktOfferingPrice.price.taxIncludedAmount.unit	Währungscode für den Produktangebotspreis. Datentyp: Zeichenfolge
productOfferingPrice.price.taxIncludedAmount.value	Preis des Produktangebots einschließlich Steuern. Datentyp: Zeichenfolge
productOfferingPrice.priceType	Preistyp des Produktangebots, einmalige oder wiederkehrende Zahlung. Mögliche Werte: nonRecurring (einmalig) recurring Datentyp: Zeichenfolge
productOfferingTerm	Gültige Vertragslaufzeit für das Produktangebot. Datentyp: Zeichenfolge
Produktspezifikation	Produktspezifikation für das Produkt. Datentyp: Objekt "productSpecification": { "id": "String", "internalId": "String", "internalVersion": "String", "version": "String" }
produktSpecification.id	Initial_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
produktSpecification.internalId	Initial_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
produktSpecification.internalVersion	Version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
Produktspezifikation.Version	External_version der Produktspezifikation. Befindet sich in der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
prodSpecCharValueUse	Merkmale des Produktangebots. Datentyp: Array von Objekten "prodSpecCharValueUse": [ { "productSpecCharacteristicValue": Array, "description": "String", "name": "String", "validFor": Object, "valueType": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten "productSpecCharacteristicValue": [ { "value": "String" } ]
prodSpecCharValueUse.productSpecCharacteristicValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.name	Name des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
prodSpecCharValueUse.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
prodSpecCharValueUse.valueType	Werttyp des Merkmals, z. B. Auswahl oder E-Mail.
gültigFür	Datumsbereich, für den das Produktangebot gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
gültigFür.endDateTime	Enddatum des Produktangebots. Datentyp: Zeichenfolge
gültigFür.startDateTime	Startdatum des Produktangebots. Datentyp: Zeichenfolge
version	External_version des Produktangebots aus der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird ein Produktangebot erstellt.

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

Antworttext:

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

Product Catalog Open API – POST /sn_prd_pm_adv/catalogmanagement/productspecification

Erstellt eine produktspezifische.

URL-Format

Standard-URL: /api/sn_prd_pm_adv/catalogmanagement/productspecification

Unterstützte Anforderungsparameter

Tabelle : 49. Pfadparameter

Name	Beschreibung
Keine

Tabelle : 50. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 51. Anforderungstextparameter (JSON)

Name	Beschreibung
Beschreibung	Erforderlich. Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externe ID	Eindeutiger Bezeichner für die Produktspezifikation aus dem externen System. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
id	Erforderlich. Initial_version oder external_id der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
internalId	Initial_version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
interneVersion	Version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
lastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Name	Erforderlich. Name der Spezifikation. Datentyp: Zeichenfolge
produktSpecCharacteristic	Spezifikationsmerkmal. Datentyp: Array "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
produktSpecCharacteristic.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
produktSpecCharacteristic.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacteristic.productSpecCharacteristicValue	Erforderlich. Array mit den möglichen Werten des Merkmals. Datentyp: Array "productSpecCharacteristicValue": [ { "value": "String" } ]
produktSpecCharacteristic.productSpecCharacteristicValue.value	Erforderlich. Wert des Merkmals. Datentyp: Zeichenfolge
productSpecCharacteristic.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
produktSpecCharacteristic.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
produktSpecCharacteristic.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
productSpecCharacteristic.valueType	Der Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
productSpecificationRelationship	Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
produktSpecificationRelationship.id	ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
produktSpecificationRelationship.type	Erforderlich, wenn der Parameter productSpecificationRelationship verwendet wird. Typ der Beziehung. Gültige Werte: zusammengesetzt_aus Bündel Datentyp: Zeichenfolge
produktSpecificationRelationship.validFor	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
produktSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
produktSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
resourceSpecification	Erforderlich. Array von Ressourcenspezifikationen, die sich auf diese Produktspezifikation beziehen. Datentyp: Array "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Erforderlich. Initial_version oder external_id der Ressourcenspezifikation. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.internalId	Initial_version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.internalVersion	Version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.version	External_version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
serviceSpecification	Liste der Servicespezifikationen, die sich auf diese Produktspezifikation beziehen. Datentyp: Array von Objekten "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	Initial_version oder external_id der Servicespezifikation. Befindet sich im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.internalId	Initial_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.internalVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.version	External_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
gültigFür	Erforderlich. Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
gültigFür.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
gültigFür.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
version	External_version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge

Header

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

Tabelle : 52. Anforderungskopfzeilen

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

Tabelle : 53. Antwortkopfzeilen

Kopfzeile	Beschreibung
Content-Type	Datenformat des Antworttexts. Unterstützt nur application/json.

Statuscodes

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

Tabelle : 54. Statuscodes

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

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
Beschreibung	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
id	Initial_version oder external_id der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
internalId	Initial_version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
interneVersion	Version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge
lastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
Name	Name der Spezifikation. Datentyp: Zeichenfolge
produktSpecCharacteristic	Spezifikationsmerkmal. Datentyp: Array "productSpecCharacteristic": [ { "description": "String", "name": "String", "productSpecCharacteristicValue": Array, "validFor": Object, "valueType": "String" } ]
produktSpecCharacteristic.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacteristic.productSpecCharacteristicValue	Array mit den möglichen Werten des Merkmals. Datentyp: Array "productSpecCharacteristicValue": [ { "value": "String" } ]
produktSpecCharacteristic.productSpecCharacteristicValue.value	Wert des Merkmals. Datentyp: Zeichenfolge
productSpecCharacteristic.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
produktSpecCharacteristic.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
produktSpecCharacteristic.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
productSpecCharacteristic.valueType	Der Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Datentyp: Zeichenfolge
productSpecificationRelationship	Beziehungen dieser Spezifikation zu anderen Produktspezifikationen. Datentyp: Array "productSpecificationRelationship": [ { "id": "String", "type": "String", "validFor": Object } ]
produktSpecificationRelationship.id	ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge
produktSpecificationRelationship.type	Typ der Beziehung. Datentyp: Zeichenfolge
produktSpecificationRelationship.validFor	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
produktSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge
produktSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge
resourceSpecification	Liste der Ressourcenspezifikationen, die sich auf diese Produktspezifikation beziehen. Datentyp: Array von Objekten "resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
resourceSpecification.id	Initial_version oder external_id der Ressourcenspezifikation. Befindet sich im Feld „sys_id“ oder „external_id“ der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.internalId	Initial_version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.internalVersion	Version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
resourceSpecification.version	External_version der Ressourcenspezifikation. Befindet sich in der Tabelle „Ressourcenspezifikation“ [sn_prd_pm_resource_specification]. Datentyp: Zeichenfolge
serviceSpecification	Liste der Servicespezifikationen, die sich auf diese Produktspezifikation beziehen. Datentyp: Array von Objekten "serviceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]
serviceSpecification.id	Initial_version oder external_id der Servicespezifikation. Befindet sich im Feld sys_id oder external_id der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.internalId	Initial_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.internalVersion	Version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.name	Name der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
serviceSpecification.version	External_version der Servicespezifikation. Befindet sich in der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]. Datentyp: Zeichenfolge
gültigFür	Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt "validFor": { "endDateTime": "String", "startDateTime": "String" }
gültigFür.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
gültigFür.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
version	External_version der Produktspezifikation aus der Tabelle „Produktspezifikation“ [sn_prd_pm_product_specification]. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel wird eine Produktspezifikation erstellt.

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

Antworttext.

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