Servicekatalog-OpenAPI

Yokohama API-Referenz

Release

yokohama

ft:locale

de-DE

ft:publication_title

Yokohama API-Referenz

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

Servicekatalog-OpenAPI

Freigeben Version: Yokohama

Aktualisiert 30. Januar 2025

15 Minuten Lesedauer

Die Service Catalog Open API bietet Endpunkte zum Erstellen und Abrufen von Servicespezifikationen.

Verwenden Sie diese API, um Servicekataloginformationen zwischen externen Systemen und Now Platformzu verwalten. Die Servicekatalog-Open -API ist eine ServiceNow® -Implementierung der REST-Spezifikation der Servicekatalog-API des TM-Forums. Diese Implementierung basiert auf der REST-Spezifikation TMF633 Service Catalog API REST Version 4vom Oktober 2020.

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

Diese API wird im Namespace sn_prd_pm_adv bereitgestellt.

Der anrufende Benutzer 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_charakteristik]
Merkmalsoption [sn_prd_pm_charakteristik_option]
Servicespezifikation [sn_prd_pm_service_specification]
Spezifikationsbeziehung [sn_prd_pm_specification_relationship]

Servicekatalog offen – GET /servicespecification

Ruft eine Liste aller Servicespezifikationen ab.

URL-Format

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

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. Datentyp: Zahl Standard: 20 Maximum: 100
Offset	Startindex, ab dem mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze. Datentyp: Zahl Standard: 0
state	Filtern Sie Servicespezifikationen nach Status. In der Antwort werden nur Spezifikationen mit einem Status zurückgegeben, der dem Wert dieses Parameters entspricht. Datentyp: Zeichenfolge

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

Kopfzeilen

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

Tabelle : 4. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn `Offset=2` und `Limit=3`, ist der Wert des Content-Range -Headers `Elemente 3-5`.
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur application/json.
Verknüpfung	Enthält die folgenden Links zum Navigieren durch Abfrageergebnisse. zuerst letzte Weiter vorheriger
X-Gesamtzahl	Für paginierte Abfragen gibt dieser Header die Gesamtzahl der auf dem Server verfügbaren Datensätze an.

Statuscodes

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

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

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
description	Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externalId	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 Versionsfeld 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	initial_version oder external_id der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.internalId	Die initiale Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpezifikation.interneVersion	Die external_version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.version	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship	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	initial_version oder external_id der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.internalId	Die initiale Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpezifikationBeziehung.interneVersion	Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.relationshipType	Typ der Beziehung. Datentyp: Zeichenfolge
serviceSpecificationRelationship.validFor	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
serviceSpezifikationsbeziehung.version	Die external_version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
specCharacterificent	Spezifikationsmerkmal. Datentyp: Array von Objekten `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacterific.characteristValueSpecification	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacterific.characteristValueSpecification.value	Wert des Merkmals. Datentyp: Zeichenfolge
Spez. Merkmal. Beschreibung	Beschreibung des Merkmals. Datentyp: Zeichenfolge
specCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
specCharacterific.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacterific.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
specCharacterific.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
Spezifisches Merkmal.WerteTyp	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
validFor	Datumsbereich, für den diese Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
@type	Typ der Spezifikation. Datentyp: Zeichenfolge

cURL-Anforderung

In diesem Beispiel werden alle Servicespezifikationen abgerufen.

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 /servicespecification/{specificationId}

Ruft eine Servicespezifikation ab.

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
Spezifikations-ID	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
state	Filtern Sie Servicespezifikationen nach Status. In der Antwort werden nur Spezifikationen mit einem Status zurückgegeben, der dem Wert dieses Parameters entspricht. Datentyp: Zeichenfolge

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

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Keine

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

Statuscodes

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

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

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
description	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 Versionsfeld 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	initial_version oder external_id der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.internalId	Die initiale Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpezifikation.interneVersion	Die external_version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.version	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship	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	initial_version oder external_id der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.internalId	Die initiale Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpezifikationBeziehung.interneVersion	Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.relationshipType	Typ der Beziehung. Datentyp: Zeichenfolge
serviceSpecificationRelationship.validFor	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
serviceSpezifikationsbeziehung.version	Die external_version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
specCharacterificent	Spezifikationsmerkmal. Datentyp: Array von Objekten `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacterific.characteristValueSpecification	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacterific.characteristValueSpecification.value	Wert des Merkmals. Datentyp: Zeichenfolge
Spez. Merkmal. Beschreibung	Beschreibung des Merkmals. Datentyp: Zeichenfolge
specCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
specCharacterific.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacterific.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
specCharacterific.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
Spezifisches Merkmal.WerteTyp	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
validFor	Datumsbereich, für den diese Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
@type	Typ der Spezifikation. Datentyp: Zeichenfolge

cURL-Anforderung

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

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 /servicespecification

Erstellt eine Servicespezifikation.

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
Keine

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Parameter des Anforderungstexts (JSON)
Name	Beschreibung
description	Erforderlich. Beschreibung der Spezifikation. Datentyp: Zeichenfolge
externalId	Externe ID der Servicespezifikation. Wenn externalId und id angegeben werden, müssen sie sich auf dieselbe Spezifikation beziehen. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_service_specification]
id	initial_version oder external_id der Servicespezifikation. Wenn id nicht angegeben ist, erstellt dieser Endpunkt eine neue Spezifikation mit version=1. Wenn id angegeben wird, erstellt dieser Endpunkt eine neue Version der angegebenen Spezifikation. Wenn externalId und id angegeben werden, müssen sie sich auf dieselbe Spezifikation beziehen. 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. initial_version oder external_id der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpezifikation.interneVersion	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
serviceSpecificationRelationship	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 der Parameter serviceSpecificationRelationship verwendet wird. Initial_version oder external_id der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpezifikationBeziehung.interneVersion	Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
serviceSpecificationRelationship.relationshipType	Erforderlich, wenn der Parameter serviceSpecificationRelationship verwendet wird. Typ der Beziehung. Gültige Werte: Pakete Bestehend aus Datentyp: Zeichenfolge
serviceSpecificationRelationship.validFor	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
serviceSpezifikationsbeziehung.version	Die external_version der zugehörigen Spezifikation. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
specCharacterificent	Spezifikationsmerkmal. Datentyp: Array von Objekten `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacterific.characteristValueSpecification	Erforderlich. Mögliche Werte des Merkmals. Datentyp: Array von Objekten `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacterific.characteristValueSpecification.value	Erforderlich. Wert des Merkmals. Datentyp: Zeichenfolge
Spez. Merkmal. Beschreibung	Beschreibung des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
specCharacteristic.name	Erforderlich. Name des Merkmals. Datentyp: Zeichenfolge
specCharacterific.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacterific.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
specCharacterific.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge Standard: Leere Zeichenfolge
Spezifisches Merkmal.WerteTyp	Erforderlich. Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
validFor	Erforderlich. Datumsbereich, für den diese Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge 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]
@type	Erforderlich. Typ der Spezifikation. Gültige Werte: KundenbezogeneServicespezifikation ResourceFacingServiceSpecification Datentyp: Zeichenfolge

Header

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

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

Statuscodes

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

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

Parameter des Antwort-Haupttexts (JSON)


Name	Beschreibung
description	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 Versionsfeld 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	initial_version oder external_id der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.internalId	Die initiale Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpezifikation.interneVersion	Die external_version der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.name	Name der Ressourcenspezifikation. Datentyp: Zeichenfolge
resourceSpecification.version	Version der Ressourcenspezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship	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	initial_version oder external_id der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.internalId	Die initiale Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpezifikationBeziehung.interneVersion	Version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
serviceSpecificationRelationship.relationshipType	Typ der Beziehung. Datentyp: Zeichenfolge
serviceSpecificationRelationship.validFor	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
serviceSpezifikationsbeziehung.version	Die external_version der zugehörigen Spezifikation. Datentyp: Zeichenfolge
specCharacterificent	Spezifikationsmerkmal. Datentyp: Array von Objekten `"specCharacteristic": [ { "characteristicValueSpecification": [Array], "description": "String", "name": "String", "validFor": {Object}, "valueType": "String" } ]`
specCharacterific.characteristValueSpecification	Liste der möglichen Werte des Merkmals. Datentyp: Array von Objekten `"characteristicValueSpecification": [ { "value": "String" } ]`
specCharacterific.characteristValueSpecification.value	Wert des Merkmals. Datentyp: Zeichenfolge
Spez. Merkmal. Beschreibung	Beschreibung des Merkmals. Datentyp: Zeichenfolge
specCharacteristic.name	Name des Merkmals. Datentyp: Zeichenfolge
specCharacterific.validFor	Datumsbereich, für den das Merkmal gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
specCharacterific.validFor.endDateTime	Enddatum des Merkmals. Datentyp: Zeichenfolge
specCharacterific.validFor.startDateTime	Startdatum des Merkmals. Datentyp: Zeichenfolge
Spezifisches Merkmal.WerteTyp	Werttyp des Merkmals, z. B. „Auswahl“ oder „E-Mail“. Datentyp: Zeichenfolge
validFor	Datumsbereich, für den diese Spezifikation gültig ist. Datentyp: Objekt `"validFor": { "endDateTime": "String", "startDateTime": "String" }`
validFor.endDateTime	Enddatum der Spezifikation. Datentyp: Zeichenfolge
validFor.startDateTime	Startdatum der Spezifikation. Datentyp: Zeichenfolge
version	Externe Version der Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Im Feld „external_version“ der Tabelle „Servicespezifikation“ [sn_prd_pm_service_specification]
@type	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"
}