Servicekatalog – API öffnen

Yokohama-API-Referenz

Release

yokohama

ft:locale

de-DE

ft:publication_title

Yokohama-API-Referenz

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

Servicekatalog – API öffnen

Freigeben Version: Yokohama

Aktualisiert 30. Januar 2025

15 Minuten Lesedauer

Die Servicekatalog Geöffnet Die API stellt Endpunkte zum Erstellen und Abrufen von Servicespezifikationen bereit.

Verwenden Sie diese API, um Servicekatalog-Informationen zwischen externen Systemen und zu verwalten Now Platform. Die Servicekatalog Geöffnet API ist ein ServiceNow®Implementierung der REST-Spezifikation der TM-Forumservicekatalog-API. Diese Implementierung basiert auf TMF633 Servicekatalog-API REST-Spezifikation Version 4 , Oktober 2020.

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

Diese API wird in bereitgestellt sn_prd_pm_adv Namespace.

Der aufrufende Anwender muss über die Rolle „sn_prd_pm_adv.catalog_integrator“ verfügen.

Diese API erstellt und aktualisiert Daten in den folgenden Tabellen.

Merkmal [sn_prd_pm_characteristic]
Merkmalsoption [sn_prd_pm_characteristic_option]
Servicespezifikation [sn_prd_pm_service_specification]
Spezifikationsbeziehung [sn_prd_pm_specification_relationship]

Servicekatalog offen – GET /servicespefication

Ruft eine Liste aller Servicespezifikationen ab.

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 1. Pfad-Parameter
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 zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie offsetParameter zum Paginieren des Datensatzabrufs. Datentyp: Zahl Standard: 20 Maximum: 100
Offset	Startindex, bei dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Datentyp: Zahl Standard: 0
Staat	Filtern Sie Servicespezifikationen nach Status. Nur Spezifikationen mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 3. Anforderungstext-Parameter (JSON)
Name	Beschreibung
Keine

Header

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

Tabelle : 4. Anforderungskopfzeilen.
Header	Beschreibung
Keine

Tabelle : 5. Antwort-Header
Header	Beschreibung
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` Und `Grenzwert = 3` , Der Wert von Content-RangeHeader ist `Elemente 3-5` .
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt application/json.
Verknüpfen	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter previous
X-Gesamtzahl	Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

Statuscodes

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

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

Antworttext-Parameter (JSON)


Name	Beschreibung
Beschreibung	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externalId	Externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_ID der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
ID	Anfangsversion oder externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „initial_Version“ oder „external_ID“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
internalId	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „initial_Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
InternalVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
LastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
name	Name der Spezifikation. Datentyp: Zeichenfolge
ResourceSpecification	Ressourcenspezifikationen für diese Servicespezifikation. Datentyp: Array von Objekten `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Die initial_Version oder external_ID der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.internalId	Die initial_Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.internalVersion	Die external_Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge
ResourceSpecification.Version	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
ServiceSpecificationBeziehung	Die Beziehungen dieser Spezifikation zu anderen Servicespezifikationen. Datentyp: Array von Objekten `"serviceSpecificationRelationship": [ { "id": "String", "internalId": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ]`
serviceSpecificationRelationship.id	Die initial_Version oder external_ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.internalId	Die initial_Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.internalVersion	Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
ServiceSpecificationBeziehung.Beziehungstyp	Typ der Beziehung. Datentyp: Zeichenfolge
ServiceSpezifikationBeziehung.validFür	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ServiceSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge
ServiceSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge
ServiceSpecificationRelationship.Version	Die external_Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
Merkmal	Spezifikationsmerkmal. Datentyp: Array von Objekten `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	Wert des Merkmals. Datentyp: Zeichenfolge
specCharacteristic.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
specCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
Specteristic.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
Specteristic.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
SpecCharacteristic.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
SpecCharacteristic.valueType	Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Datentyp: Zeichenfolge
ValidiertFür	Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ValidFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
ValidFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
Version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
@Typ	Typ der Spezifikation. Datentyp: Zeichenfolge

Curl-Anforderung

Dieses Beispiel ruft alle Servicespezifikationen ab.

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

Antworttext.

[
   {
      "id": "16d79ec3532520103b6bddeeff7b12a6",
      "name": "SD WAN Optimization Service",
      "description": "SD WAN Optimization Service",
      "lastUpdate": "2022-01-23 22:48:55",
      "validFor": {
         "startDateTime": "2022-01-12",
         "endDateTime": "2027-02-11"
      },
      "serviceSpecificationRelationship": [
         {
            "id": "a1f5fe981bb420106ba59acf034bcb4f",
            "name": "Deduplication and Compression",
            "version": "1",
            "type": "rfs",
            "validFor": {
               "startDateTime": "2021-02-11",
               "endDateTime": "2027-02-11"
            }
         }
      ],
      "resourceSpecification": [],
      "serviceSpecCharacteristic": [
         {
            "name": "SSL Optimization",
            "description": "SSL Optimization",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-14 07:47:57"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "False",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "True",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "CIFS Optimization",
            "description": "CIFS Optimization Protocol",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-14 07:49:09"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "SMB1",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "SMB2",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         }
      ]
   },
   {
      "id": "31c5caff07266010a7955b7e0ad3006b",
      "name": "Firewall Administration",
      "description": "Firewall Administration",
      "lastUpdate": "2022-01-23 11:46:48",
      "validFor": {
         "startDateTime": "2021-11-22",
         "endDateTime": ""
      },
      "serviceSpecificationRelationship": [],
      "resourceSpecification": [
         {
            "id": "3546463307666010a7955b7e0ad3005d",
            "name": "Cisco Firewall Management system",
            "version": "1"
         }
      ],
      "serviceSpecCharacteristic": [
         {
            "name": "Firewall Administration CPE Model",
            "description": "Firewall Administration CPE Model",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-02-20 00:55:37"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "2100 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "4100 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "7300 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "9300 series",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Firewall Administration CPE Type",
            "description": "Firewall Administration CPE Type",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-02-20 00:53:45"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Physical",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Virtual",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Configuration and Policy backup",
            "description": "Configuration and Policy backup",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-21 10:46:02"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Weekly",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Monthly",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Daily",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Remote CLI troubleshoot support",
            "description": "Remote CLI troubleshoot support",
            "valueType": "choice",
            "validFor": {
               "startDatetime": "2022-01-21 10:45:38"
            },
            "productSpecCharacteristicValue": [
               {
                  "value": "Standard support",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Premium support",
                  "validFor": {
                     "startDateTime": ""
                  }
               },
               {
                  "value": "Basic support",
                  "validFor": {
                     "startDateTime": ""
                  }
               }
            ]
         },
         {
            "name": "Firewall Administration CPE ID",
            "description": "Firewall Administration CPE ID",
            "valueType": "single_line_text",
            "validFor": {
               "startDatetime": "2022-02-20 00:57:50"
            },
            "productSpecCharacteristicValue": []
         }
      ]
   }
]

Servicekatalog offen – GET /servicspecification/{Speciffic Id}

Ruft eine Servicespezifikation ab.

URL-Format

Standard-URL: /api/sn_prd_pm_adv/catalogmanagement/servicespefication/{SpecifationId}

Unterstützte Anforderungsparameter

Tabelle : 7. Pfad-Parameter
Name	Beschreibung
SpezifikationId	SYS_ID der abzurufenden Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_service_specification]

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
Staat	Filtern Sie Servicespezifikationen nach Status. Nur Spezifikationen mit einem Status, der dem Wert dieses Parameters entspricht, werden in der Antwort zurückgegeben. Datentyp: Zeichenfolge

Tabelle : 9. Anforderungstext-Parameter (JSON)
Name	Beschreibung
Keine

Header

Tabelle : 10. Anforderungskopfzeilen.
Header	Beschreibung
Keine

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

Statuscodes

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

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

Antworttext-Parameter (JSON)


Name	Beschreibung
Beschreibung	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externalId	Externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_ID der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
ID	Anfangsversion oder externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „initial_Version“ oder „external_ID“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
internalId	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „initial_Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
InternalVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
LastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
name	Name der Spezifikation. Datentyp: Zeichenfolge
ResourceSpecification	Ressourcenspezifikationen für diese Servicespezifikation. Datentyp: Array von Objekten `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Die initial_Version oder external_ID der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.internalId	Die initial_Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.internalVersion	Die external_Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge
ResourceSpecification.Version	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
ServiceSpecificationBeziehung	Die Beziehungen dieser Spezifikation zu anderen Servicespezifikationen. Datentyp: Array von Objekten `"serviceSpecificationRelationship": [ { "id": "String", "internalId": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ]`
serviceSpecificationRelationship.id	Die initial_Version oder external_ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.internalId	Die initial_Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.internalVersion	Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
ServiceSpecificationBeziehung.Beziehungstyp	Typ der Beziehung. Datentyp: Zeichenfolge
ServiceSpezifikationBeziehung.validFür	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ServiceSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge
ServiceSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge
ServiceSpecificationRelationship.Version	Die external_Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
Merkmal	Spezifikationsmerkmal. Datentyp: Array von Objekten `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	Wert des Merkmals. Datentyp: Zeichenfolge
specCharacteristic.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
specCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
Specteristic.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
Specteristic.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
SpecCharacteristic.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
SpecCharacteristic.valueType	Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Datentyp: Zeichenfolge
ValidiertFür	Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ValidFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
ValidFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
Version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
@Typ	Typ der Spezifikation. Datentyp: Zeichenfolge

Curl-Anforderung

Dieses Beispiel ruft eine Servicespezifikation für einen Firewall-Service ab.

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

Antworttext.

{
   "id": "31c5caff07266010a7955b7e0ad3006b",
   "name": "Firewall Administration",
   "description": "Firewall Administration",
   "lastUpdate": "2022-01-23 11:46:48",
   "validFor": {
      "startDateTime": "2021-11-22",
      "endDateTime": ""
   },
   "serviceSpecificationRelationship": [],
   "resourceSpecification": [
      {
         "id": "3546463307666010a7955b7e0ad3005d",
         "name": "Cisco Firewall Management system",
         "version": "1"
      }
   ],
   "serviceSpecCharacteristic": [
      {
         "name": "Firewall Administration CPE Model",
         "description": "Firewall Administration CPE Model",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-02-20 00:55:37"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "2100 series",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "4100 series",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "7300 series",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "9300 series",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Firewall Administration CPE Type",
         "description": "Firewall Administration CPE Type",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-02-20 00:53:45"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Physical",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Virtual",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Configuration and Policy backup",
         "description": "Configuration and Policy backup",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-21 10:46:02"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Weekly",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Monthly",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Daily",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Remote CLI troubleshoot support",
         "description": "Remote CLI troubleshoot support",
         "valueType": "choice",
         "validFor": {
            "startDatetime": "2022-01-21 10:45:38"
         },
         "productSpecCharacteristicValue": [
            {
               "value": "Standard support",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Premium support",
               "validFor": {
                  "startDateTime": ""
               }
            },
            {
               "value": "Basic support",
               "validFor": {
                  "startDateTime": ""
               }
            }
         ]
      },
      {
         "name": "Firewall Administration CPE ID",
         "description": "Firewall Administration CPE ID",
         "valueType": "single_line_text",
         "validFor": {
            "startDatetime": "2022-02-20 00:57:50"
         },
         "productSpecCharacteristicValue": []
      }
   ]
}

Servicekatalog offen – POST/Servicespezifikation

Erstellt eine Servicespezifikation.

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 13. Pfad-Parameter
Name	Beschreibung
Keine

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstext-Parameter (JSON)
Name	Beschreibung
Beschreibung	Erforderlich. Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externalId	Externe ID der Servicespezifikation. Wenn beides externalIdUnd idAngegeben werden, müssen sie auf dieselbe Spezifikation verweisen. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_service_specification]
ID	Die initial_Version oder external_ID der Servicespezifikation. Wenn idIst nicht angegeben, dieser Endpunkt erstellt eine neue Spezifikation mit Version=1. Wenn idWird angegeben, erstellt dieser Endpunkt eine neue Version der angegebenen Spezifikation. Wenn beides externalIdUnd idAngegeben werden, müssen sie auf dieselbe Spezifikation verweisen. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
InternalVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_service_specification]
LastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
name	Erforderlich. Name der Spezifikation. Datentyp: Zeichenfolge
ResourceSpecification	Erforderlich. Ressourcenspezifikationen für diese Servicespezifikation. Datentyp: Array von Objekten `"resourceSpecification": [ { "id": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Erforderlich. Die initial_Version oder external_ID der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.internalVersion	Die external_Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ResourceSpecification.Version	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ServiceSpecificationBeziehung	Details der Beziehungen der Spezifikation zu anderen Servicespezifikationen. Datentyp: Array von Objekten `"serviceSpecificationRelationship": [ { "id": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ]`
serviceSpecificationRelationship.id	Erforderlich, wenn verwendet wird serviceSpecificationRelationshipParameter. Initial_Version oder external_ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.internalVersion	Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ServiceSpecificationBeziehung.Beziehungstyp	Erforderlich, wenn verwendet wird serviceSpecificationRelationshipParameter. Typ der Beziehung. Gültige Werte: Pakete Composite_of Datentyp: Zeichenfolge
ServiceSpezifikationBeziehung.validFür	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ServiceSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ServiceSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ServiceSpecificationRelationship.Version	Die external_Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Merkmal	Spezifikationsmerkmal. Datentyp: Array von Objekten `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	Erforderlich. Mögliche Werte des Merkmals. Datentyp: Array von Objekten `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	Erforderlich. Wert des Merkmals. Datentyp: Zeichenfolge
specCharacteristic.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
specCharacteristic.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
Specteristic.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
Specteristic.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
SpecCharacteristic.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
SpecCharacteristic.valueType	Erforderlich. Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Datentyp: Zeichenfolge
ValidiertFür	Erforderlich. Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ValidFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
ValidFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Version	Externe Version der Servicespezifikation. Version muss für die angegebene Versionskette eindeutig sein. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
@Typ	Erforderlich. Typ der Spezifikation. Gültige Werte: CustomerFacingServiceSpezifikation ResourceFacingServicespezifikation Datentyp: Zeichenfolge

Header

Tabelle : 16. Anforderungskopfzeilen.
Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Nur unterstützt application/json.
Inhaltstyp	Datenformat des Anforderungstexts. Nur unterstützt application/json.

Tabelle : 17. Antwort-Header
Header	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Nur unterstützt application/json.

Statuscodes

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

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

Antworttext-Parameter (JSON)


Name	Beschreibung
Beschreibung	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externalId	Externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_ID der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
ID	Anfangsversion oder externe ID der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „initial_Version“ oder „external_ID“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
internalId	Anfangsversion der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „initial_Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
InternalVersion	Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „Version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
LastUpdate	Datum, an dem die Spezifikation zuletzt aktualisiert wurde. Datentyp: Zeichenfolge
name	Name der Spezifikation. Datentyp: Zeichenfolge
ResourceSpecification	Ressourcenspezifikationen für diese Servicespezifikation. Datentyp: Array von Objekten `"resourceSpecification": [ { "id": "String", "internalId": "String", "internalVersion": "String", "name": "String", "version": "String" } ]`
resourceSpecification.id	Die initial_Version oder external_ID der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.internalId	Die initial_Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.internalVersion	Die external_Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge
ResourceSpecification.Version	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
ServiceSpecificationBeziehung	Die Beziehungen dieser Spezifikation zu anderen Servicespezifikationen. Datentyp: Array von Objekten `"serviceSpecificationRelationship": [ { "id": "String", "internalId": "String", "internalVersion": "String", "relationshipType": "String", "validFor": {Object}, "version": "String" } ]`
serviceSpecificationRelationship.id	Die initial_Version oder external_ID der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.internalId	Die initial_Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.internalVersion	Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
ServiceSpecificationBeziehung.Beziehungstyp	Typ der Beziehung. Datentyp: Zeichenfolge
ServiceSpezifikationBeziehung.validFür	Datumsbereich, für den die Beziehung gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ServiceSpecificationRelationship.validFor.endDateTime	Enddatum der Beziehung. Datentyp: Zeichenfolge
ServiceSpecificationRelationship.validFor.startDateTime	Startdatum der Beziehung. Datentyp: Zeichenfolge
ServiceSpecificationRelationship.Version	Die external_Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
Merkmal	Spezifikationsmerkmal. Datentyp: Array von Objekten `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacteristic.characteristicValueSpecification	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacteristic.characteristicValueSpecification.value	Wert des Merkmals. Datentyp: Zeichenfolge
specCharacteristic.description	Beschreibung des Merkmals. Datentyp: Zeichenfolge
specCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
Specteristic.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
Specteristic.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
SpecCharacteristic.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
SpecCharacteristic.valueType	Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Datentyp: Zeichenfolge
ValidiertFür	Datumsbereich, für den die Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
ValidFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
ValidFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
Version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld external_Version der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification].
@Typ	Typ der Spezifikation. Datentyp: Zeichenfolge

Curl-Anforderung

In diesem Beispiel wird eine Servicespezifikation für einen Firewall-Service erstellt.

curl "https://instance.servicenow.com/api/sn_prd_pm_adv/catalogmanagement/servicespecification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   "externalId": "7655",
   "name": "Firewall Service",
   "description": "This service specification describes a firewall service that can be deployed in customer-premises equipment.",
   "validFor": {
      "startDateTime": "2017-08-23T00:00",
      "endDateTime": "2021-03-25T00:00"
   },
   "lastUpdate": "2020-08-15T00:00",
   "resourceSpecification": [
      {
         "id": "af66e551c32f10105252716b7d40dd52",
         "name": "Firewall"
      }
   ],
   "specCharacteristic": [
      {
         "name": "Edge",
         "description": "This characteristic describes the operating system run by the service",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-08-12T00:00",
            "endDateTime": "2021-03-07T00:00"
         },
         "characteristicValueSpecification": [
            {
               "value": "Android KitKat"
            }
         ],
      }
   ],
   "serviceSpecRelationship": [
      {
         "relationshipType": "composed_of",
         "id": "65033023ebdb30107ee5302698522849",
         "validFor": {
            "startDateTime": "2017-08-25T00:00",
            "endDateTime": "2021-03-25T00:00"
         }
      }
   ],
   "@type": "ResourceFacingServiceSpecification"
}" \
--user 'username':'password'

Antworttext.

{
   "id": "21a7ee64c32310105253716b8d40dd60",
   "name": "Firewall Service",
   "description": "This service specification describes a firewall service that can be deployed in customer-premises equipment.",
   "validFor": {
      "startDateTime": "2017-08-23T00:00",
      "endDateTime": "2021-03-25T00:00"
   },
   "lastUpdate": "2020-08-15T00:00",
   "resourceSpecification": [
      {
         "id": "af66e551c32f10105252716b7d40dd52",
         "name": "Firewall"
      }
   ],
   "specCharacteristic": [
      {
         "name": "Edge",
         "description": "This characteristic describes the operating system run by the service",
         "valueType": "choice",
         "validFor": {
            "startDateTime": "2017-08-12T00:00",
            "endDateTime": "2021-03-07T00:00"
         },
         "characteristicValueSpecification": [
            {
               "value": "Android KitKat"
            }
         ],
      }
   ],
   "serviceSpecRelationship": [
      {
         "relationshipType": "composed_of",
         "id": "65033023ebdb30107ee5302698522849",
         "validFor": {
            "startDateTime": "2017-08-25T00:00",
            "endDateTime": "2021-03-25T00:00"
         }
      }
   ],
   "@type": "ResourceFacingServiceSpecification"
}