Servicekatalog – API öffnen

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 ServiceNow AI 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.

Die Endpunkte dieser API werden in bereitgestellt sn_tmf-api Namespace unter Produktkatalog Geöffnet API-Name:

• Servicekategorie erstellen (POST) – Servicekatalog offen – POST /api/sn_tmf_api/catalogmanagement/serviceCategory
• Servicespezifikation erstellen (POST) – Servicekatalog offen – POST/Servicespezifikation
• Servicekategorie löschen (LÖSCHEN) – Servicekatalog offen – LÖSCHEN SIE /api/sn_tmf_api/catalogmanagement/serviceCategory/{ID}
• Servicekategorie abrufen (GET) – Servicekatalog offen – GET /api/sn_tmf_api/catalogmanagement/serviceCategory/{ID}
• Servicespezifikation abrufen (GET) – Servicekatalog offen – GET /servicspecification/{Speciffic Id}
• Servicespezifikationen auflisten (GET) – Servicekatalog offen – GET /servicespefication
• Servicekategorie aktualisieren (PATCH) – Servicekatalog offen – POST /api/sn_tmf_api/catalogmanagement/serviceCategory

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 – LÖSCHEN SIE /api/sn_tmf_api/catalogmanagement/serviceCategory/{ID}

Löscht den angegebenen Servicekategoriedatensatz in der Tabelle „Spezifikationskategorie“ [sn_prd_pm_specification_category].

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/serviceCategory/{ID}

Unterstützte Anforderungsparameter

Tabelle : 1. Pfad-Parameter

Name	Beschreibung
ID	SYS_ID der zu löschenden Servicekategorie. Tabelle: Servicekategorie [sn_prd_pm_specification_category] Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 3. Anforderungstextparameter (XML oder 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
Akzeptieren	Datenformat des Anforderungstexts. Unterstützt nur Anwendung/JSON.

Tabelle : 5. Antwortkopfzeilen

Header	Beschreibung
Keine

Statuscodes

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

Tabelle : 6. Statuscodes

Statuscode	Beschreibung
204	Kein Inhalt.
400	Ungültige Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
Keine

cURL-Anforderung

Das folgende Beispiel löscht eine Servicekategorie mit der ID a1b23456c7de8a90f0123456gh789ij. Gibt einen Statuscode mit Messaging zurück.

curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
  --request DELETE \
  --header "Accept:application/json" \
  --user 'user:password'

Servicekatalog offen – RUFT /api/sn_tmf_api/catalogmanagement/serviceCategory AB

Ruft eine Liste aller Servicekategoriedatensätze in der Tabelle „Servicekategorie“ [sn_prd_pm_specification_category] ab.

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 7. Pfad-Parameter

Name	Beschreibung
Keine

Tabelle : 8. Abfrageparameter

Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. Gültige Felder: href ID Name Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück
ID	Filtern Sie Servicekategorien nach bestimmten sys_ID(s). Tabelle: Servicekategorie [Service_category] 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. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Verwenden Sie keinen negativen Zahlenwert. Datentyp: Zahl Standard: 0

Tabelle : 9. Anforderungstextparameter (XML oder 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 : 10. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren:Application/JSON

Tabelle : 11. Antwortkopfzeilen

Header	Beschreibung
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn Offset=2 Und Grenzwert = 3 , Der Wert des Inhaltsbereichs-Headers ist Elemente 3-5 .
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur Anwendung/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 : 12. 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 oder XML)

Name	Beschreibung
ExternalIdentifier	Identifizierung von Informationen für ein externes System, das an der Verwaltung von Kategorien beteiligt ist. Datentyp: Array von Objekten "externalIdentifier": [ { "id": "String", "owner": "String" } ]
externalIdentifier.id	Eindeutiger Bezeichner für die Servicekategorie. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Tabelle: Servicekategorie [sn_prd_pm_specification_category], Feld external_ID
ExternalIdentifier.owner	Das System, das die angegebene externe ID besitzt. Datentyp: Zeichenfolge
href	Hyperlink für den Zugriff auf die Servicekategorie. Datentyp: Zeichenfolge
ID	SYS_ID der Servicekategorie. Tabelle: Servicekategorie [sn_prd_pm_specification_category] Datentyp: Zeichenfolge
IsRoot	Kennzeichnung, die angibt, ob die Kategorie ein Stamm von Kategorien ist. Gültige Werte: Wahr: Kategorie ist ein Stamm von Kategorien. Falsch: Kategorie ist kein Stamm von Kategorien. Datentyp: Boolesch
Modellkategorie	Liste der Modellkategorien, die der Servicekategorie zugeordnet sind. Datentyp: Array von Objekten "modelCategory": [ { "id": "String", "name": "String" } ]
modelCategory.id	SYS_ID der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
modelCategory.name	Name der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
Name	Name der Servicekategorie. Datentyp: Zeichenfolge
Servicekandidat	Liste der Referenzen für Servicekandidaten, die dieser Kategorie zugeordnet sind. Datentyp: Array von Objekten "serviceCandidate": [ { "id": "String", "href": "String", "name": "String", "@referredType": "String", "version": "String" } ]
ServiceCandidate.@referredType	Wert ist immer Servicekategorie . Datentyp: Zeichenfolge
ServiceCandidate.href	Hyperlink für den Zugriff auf die Servicespezifikation. Datentyp: Zeichenfolge
serviceCandidate.id	SYS_ID der Servicespezifikation. Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification] Datentyp: Zeichenfolge
ServiceCandidate.Version	Version des Servicekandidaten. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Beispiel wird der GET-Vorgang aufgerufen, um eine Liste aller Servicekategoriedatensätze in der Tabelle „Servicekategorie“ [sn_prd_pm_specification_category] zurückzugeben.

curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory" \
  --request GET \
  --header "Accept:application/json" \
  --user 'user:password'
``

Antworttext.

{
  "id": "a1b23456c7de8a90f0123456gh789ij",
  "href": "api/sn_tmf_api/service_catalog_api/serviceCategory/a2a68216d9ce2a90f87718429ae503dd",
  "name": "Cloud Services",
  "serviceCandidate": [
    {
      "id": "14fbd5ead902ea90f87718429ae503f7",
      "href": "api/sn_tmf_api/catalogmanagement/serviceSpecification/14fbd5ead902ea90f87718429ae503f7",
      "version": "1",
      "name": "servicenow",
      "@referredType": "ServiceCategory"
    }
  ],
  "modelCategory": [
    {
      "id": "a1d5bc14c3031000b959fd251eba8f5f",
      "name": "Business Service"
    }
  ],
  "externalIdentifier": [
    {
      "id": "1234234312",
      "owner": "TMF200000123233"
    }
  ],
  "isRoot": "true"
}

Servicekatalog offen – GET /api/sn_tmf_api/catalogmanagement/serviceCategory/{ID}

Ruft einen bestimmten Servicekategoriedatensatz in der Tabelle „Spezifikationskategorie“ [sn_prd_pm_specification_category] ab.

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 13. Pfad-Parameter

Name	Beschreibung
ID	SYS_ID der abzurufenden Servicekategorie. Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category] Datentyp: Zeichenfolge

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: href ID Name Datentyp: Zeichenfolge Standard: Gibt alle Felder zurück
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. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Verwenden Sie keinen negativen Zahlenwert. Datentyp: Zahl Standard: 0

Tabelle : 15. Anforderungstextparameter (XML oder 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 : 16. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren:Application/JSON

Tabelle : 17. Antwortkopfzeilen

Header	Beschreibung
Inhaltsbereich	Inhaltsbereich, der in einem paginierten Aufruf zurückgegeben wird. Beispiel: Wenn Offset=2 Und Grenzwert = 3 , Der Wert des Inhaltsbereichs-Headers ist Elemente 3-5 .
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur Anwendung/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 : 18. 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 oder XML)

Name	Beschreibung
ExternalIdentifier	Identifizierung von Informationen für ein externes System, das an der Verwaltung von Kategorien beteiligt ist. Datentyp: Array von Objekten "externalIdentifier": [ { "id": "String", "owner": "String" } ]
externalIdentifier.id	Eindeutiger Bezeichner für die Servicekategorie. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category], Feld: External_ID
ExternalIdentifier.owner	Das System, das diese ID besitzt. Datentyp: Zeichenfolge
href	Hyperlink für den Zugriff auf die Servicekategorie. Datentyp: Zeichenfolge
ID	SYS_ID der Servicekategorie. Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category] Datentyp: Zeichenfolge
IsRoot	Kennzeichnung, die angibt, ob die Kategorie ein Stamm von Kategorien ist. Gültige Werte: Wahr: Kategorie ist ein Stamm von Kategorien. Falsch: Kategorie ist kein Stamm von Kategorien. Datentyp: Boolesch
Modellkategorie	Liste der Modellkategorien, die der Servicekategorie zugeordnet sind. Datentyp: Array von Objekten "modelCategory": [ { "id": "String", "name": "String" } ]
modelCategory.id	SYS_ID der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
modelCategory.name	Name der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
Name	Name der Servicekategorie. Datentyp: Zeichenfolge
Servicekandidat	Liste der Servicekandidaten, die dieser Kategorie zugeordnet sind. Datentyp: Array von Objekten "serviceCandidate": [ { "id": "String", "href": "String", "name": "String", "@referredType": "String", "version": "String" } ]
ServiceCandidate.@referredType	Referenzierter Typ des Servicekandidaten. Wert ist immer Servicekategorie . Datentyp: Zeichenfolge
ServiceCandidate.href	Hyperlink für den Zugriff auf die Servicespezifikation. Datentyp: Zeichenfolge
serviceCandidate.id	SYS_ID der Servicespezifikation. Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification] Datentyp: Zeichenfolge
ServiceCandidate.Version	Version des Servicekandidaten. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Beispiel wird der GET-Vorgang aufgerufen, um einen bestimmten Servicekategoriedatensatz gemäß einer bestimmten ID zurückzugeben, a2a68216d9ce2a90f87718429ae503dd.

curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
  --request GET \
  --header "Accept:application/json" \
  --user 'user:password'

Antworttext.

{
  "id": "a2a68216d9ce2a90f87718429ae503dd",
  "href": "api/sn_tmf_api/service_catalog_api/serviceCategory/a1b23456c7de8a90f0123456gh789ij",
  "name": "Cloud Services",
  "serviceCandidate": [
    {
      "id": "a1b23456c7de8a90f0123456gh789ij",
      "href": "api/sn_tmf_api/catalogmanagement/serviceSpecification/a1b23456c7de8a90f0123456gh789ij",
      "version": "1",
      "name": "servicenow",
     

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 : 19. Pfad-Parameter

Name	Beschreibung
Keine

Tabelle : 20. Abfrageparameter

Name	Beschreibung
Felder	Liste der Felder, die in der Antwort zurückgegeben werden sollen. Ungültige Felder werden ignoriert. 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
Status	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 : 21. 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 : 22. Anforderungskopfzeilen.

Header	Beschreibung
Keine

Tabelle : 23. Antwortkopfzeilen

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 : 24. 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.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
@TYPE	Typ der Spezifikation. Datentyp: Zeichenfolge
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].
ExternalSystem	Externes System der Servicespezifikation, angehängt mit TMF633 . Wenn das externe System beispielsweise ABC ist, geben Sie den Wert in ein externalSystemAS ABC-TMF633 . Datentyp: Zeichenfolge
ExternalSystem	Drittpartei oder nicht native Plattform, die mit dem Servicekatalog interagiert. Wert wird immer mit angehängt TMF633 . Beispiel: Wenn das externe System ist ABC Dann muss der Wert in der externen Quelle sein ABC-TMF633 . Datentyp: Zeichenfolge
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].
Letztes Update	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. Kann ein einfaches oder komplexes Merkmal sein. Mögliche Werte: Datum, Adresse Ganzzahl, Datum/Uhrzeit Array.Integer Array.Einzeiliger Test Einzeiliger Text Array.Objekt Array.Date Array.Decimal Ja/Nein Objekt Array.Datetime Kontrollkästchen E-Mail Auswahl 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].

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",
       "externalSystem": "Salesforce - TMF633",
      "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": ""
                  }
               }
            ]
         }
      ]
      "externalSource": "ABC-TMF633"
   },
   {
      "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": ""
                  }
               }
            ]
    "externalSource": "ABC-TMF633"
         },
         {
            "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 : 25. Pfad-Parameter

Name	Beschreibung
SpezifikationId	SYS_ID der abzurufenden Servicespezifikation. Datentyp: Zeichenfolge Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification]

Tabelle : 26. 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
Status	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 : 27. 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 : 28. Anforderungskopfzeilen.

Header	Beschreibung
Keine

Tabelle : 29. Antwortkopfzeilen

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 : 30. Statuscodes

Statuscode	Beschreibung
200	Anforderung erfolgreich verarbeitet.
400	Ungültige Anforderung. Dies 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.

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
@TYPE	Typ der Spezifikation. Datentyp: Zeichenfolge
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].
ExternalSystem	Externes System der Servicespezifikation, angehängt mit TMF633 . Wenn das externe System beispielsweise ABC ist, geben Sie den Wert in ein externalSystemAS ABC-TMF633 . Datentyp: Zeichenfolge
ExternalSystem	Drittpartei oder nicht native Plattform, die mit dem Servicekatalog interagiert. Wert wird immer mit angehängt TMF633 . Beispiel: Wenn das externe System ist ABC Dann muss der Wert in der externen Quelle sein ABC-TMF633 . Datentyp: Zeichenfolge
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].
Letztes Update	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. Kann ein einfaches oder komplexes Merkmal sein. Mögliche Werte: Datum, Adresse Ganzzahl, Datum/Uhrzeit Array.Integer Array.Einzeiliger Test Einzeiliger Text Array.Objekt Array.Date Array.Decimal Ja/Nein Objekt Array.Datetime Kontrollkästchen E-Mail Auswahl 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].

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",
   "externalSystem": "Salesforce - TMF633",
   "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": []
      }
   ],
   "externalSource": "ABC-TMF633"
}

Servicekategorie offen – PATCH /api/sn_tmf_api/catalogmanagement/serviceCategory/{ID}

Aktualisiert einen angegebenen Datensatz in der Tabelle „Spezifikationskategorie“ [sn_prd_pm_specification_category].

URL-Format

Standard-URL: /api/sn_tmf_api/catalogmanagement/serviceCategory/ {ID}

Unterstützte Anforderungsparameter

Tabelle : 31. Pfad-Parameter

Name	Beschreibung
ID	SYS_ID der Servicekategorietabelle. Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category] Datentyp: Zeichenfolge

Tabelle : 32. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 33. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
ExternalIdentifier	Identifizierung von Informationen für ein externes System, das an der Verwaltung von Kategorien beteiligt ist. Datentyp: Array von Objekten "externalIdentifier": [ { "id": "String", "owner": "String" } ]
externalIdentifier.id	Eindeutiger Bezeichner für die Servicekategorie. Dieser Wert wird von einem externen System bestimmt. Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category], Feld: External_ID Datentyp: Zeichenfolge
ExternalIdentifier.owner	Das System, das diese ID besitzt. Datentyp: Zeichenfolge
href	Hyperlink für den Zugriff auf die Servicekategorie. Datentyp: Zeichenfolge
ID	SYS_ID der Servicekategorie. Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category] Datentyp: Zeichenfolge
IsRoot	Kennzeichnung, die angibt, ob die Kategorie ein Stamm von Kategorien ist. Gültige Werte: Wahr: Kategorie ist ein Stamm von Kategorien. Falsch: Kategorie ist kein Stamm von Kategorien. Datentyp: Boolesch
Modellkategorie	Liste der Modellkategorien, die der Servicekategorie zugeordnet sind. Datentyp: Array von Objekten "modelCategory": [ { "id": "String", "name": "String" } ]
modelCategory.id	SYS_ID der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
modelCategory.name	Name der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
Name	Name der Servicekategorie. Datentyp: Zeichenfolge
Servicekandidat	Liste der Servicekandidaten, die dieser Kategorie zugeordnet sind. Datentyp: Array von Objekten "serviceCandidate": [ { "@referredType": "String", "href": "String", "id": "String", "name": "String", "version": "String" } ]
ServiceCandidate.@referredType	Wert ist immer Servicekategorie . Datentyp: Zeichenfolge
ServiceCandidate.href	Hyperlink für den Zugriff auf die Servicespezifikation. Datentyp: Zeichenfolge
serviceCandidate.id	SYS_ID der Servicespezifikation. Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification] Datentyp: Zeichenfolge
ServiceCandidate.Version	Version des Servicekandidaten. Datentyp: Zeichenfolge

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 : 34. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 35. Antwortkopfzeilen

Header	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 : 36. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Anforderungstexts. Unterstützt nur Anwendung/JSON.
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützt nur Anwendung/JSON.

Tabelle : 37. Antwortkopfzeilen

Header	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur Anwendung/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 : 38. Statuscodes

Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe erkannt: Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
ExternalIdentifier	Identifizierung von Informationen für ein externes System, das an der Verwaltung von Kategorien beteiligt ist. Datentyp: Array von Objekten "externalIdentifier": [ { "id": "String", "owner": "String" } ]
ExternalIdentifier.ID	Eindeutiger Bezeichner für die Servicekategorie. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category], Feld: External_ID
ExternalIdentifier.owner	Das System, das diese ID besitzt. Datentyp: Zeichenfolge
href	Hyperlink für den Zugriff auf die Servicekategorie. Datentyp: Zeichenfolge
ID	SYS_ID der Servicekategorie. Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category] Datentyp: Zeichenfolge
IsRoot	Kennzeichnung, die angibt, ob die Kategorie ein Stamm von Kategorien ist. Gültige Werte: Wahr: Kategorie ist ein Stamm von Kategorien. Falsch: Kategorie ist kein Stamm von Kategorien. Datentyp: Boolesch
Modellkategorie	Liste der Modellkategorien, die der Servicekategorie zugeordnet sind. Datentyp: Array von Objekten "modelCategory": [ { "id": "String", "name": "String" } ]
Modellkategorie.ID	SYS_ID der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
modelCategory.name	Name der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
Name	Name der Servicekategorie. Datentyp: Zeichenfolge
Servicekandidat	Liste der Servicekandidaten, die dieser Kategorie zugeordnet sind. Datentyp: Array von Objekten "serviceCandidate": [ { "@referredType": "String", "href": "String", "id": "String", "name": "String", "version": "String" } ]
ServiceCandidate.@referredType	Wert ist immer Servicekategorie . Datentyp: Zeichenfolge
ServiceCandidate.href	Hyperlink für den Zugriff auf die Servicespezifikation. Datentyp: Zeichenfolge
ServiceCandidate.ID	SYS_ID der Servicespezifikation. Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification] Datentyp: Zeichenfolge
ServiceCandidate.Version	Version des Servicekandidaten. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Beispiel aktualisiert den Namen, die Version, den Servicekandidaten, die Modellkategorie und die Informationen zum externen Bezeichner der Servicekategorie.

curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory/a1b23456c7de8a90f0123456gh789ij" \
  --request PATCH \
  --header "Accept:application/json" \
  --header "Content-Type:application/json" \
  --data '{
    "name": "Cloud Services",
    "version": "1.0",
    "serviceCandidate": [
      {
        "id": "a1b23456c7de8a90f0123456gh789ij",
        "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
        "version": "3.2",
        "name": "Cloud Services",
        "@referredType": "ServiceCategory"
      }
    ],
    "modelCategory": [
      {
        "id": "b2d5bc14c3031000b959fd251eba8f96",
        "name": "model"
      }
    ],
    "externalIdentifier": {
      "id": "1234234312",
      "owner": "TMF200000123233"
    },
    "isRoot": true
  }' \
  --user 'user:password

Antworttext.

{
  "name": "Cloud Services",
  "version": "1.0",
  "serviceCandidate": [
    {
      "id": "a1b23456c7de8a90f0123456gh789ij",
      "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
      "version": "3.2",
      "name": "Cloud Services",
      "@referredType": "ServiceCategory"
    }
  ],
  "modelCategory": [
    {
      "id": "b2d5bc14c3031000b959fd251eba8f96",
      "name": "model"
    }
  ],
  "externalIdentifier": {
    "id": "1234234312",
    "owner": "TMF200000123233"
  },
  "isRoot": true,
  "id": "8138241b1caaaa10f87703c075c809fe",
  "href": "api/sn_tmf_api/catalogmanagement/serviceCategory/8138241b1caaaa10f87703c075c809fe"
}

Servicekatalog offen – POST /api/sn_tmf_api/catalogmanagement/serviceCategory

Erstellt einen neuen Servicekategoriedatensatz in der Tabelle „Spezifikationskategorie“ [sn_prd_pm_specification_category].

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 39. Pfad-Parameter

Name	Beschreibung
Keine

Tabelle : 40. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 41. Anforderungstextparameter (XML oder JSON)

Name	Beschreibung
ExternalIdentifier	Identifizierung von Informationen für ein externes System, das an der Verwaltung von Kategorien beteiligt ist. Datentyp: Array von Objekten "externalIdentifier": [ { "id": "String", "owner": "String" } ]
externalIdentifier.id	Eindeutiger Bezeichner für die Servicekategorie. Dieser Wert wird von einem externen System bestimmt. Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category], Feld: External_ID Datentyp: Zeichenfolge
ExternalIdentifier.owner	Das System, das diese ID besitzt. Datentyp: Zeichenfolge
href	Hyperlink für den Zugriff auf die Servicekategorie. Datentyp: Zeichenfolge
ID	SYS_ID der Servicekategorie. Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category] Datentyp: Zeichenfolge
IsRoot	Kennzeichnung, die angibt, ob die Kategorie ein Stamm von Kategorien ist. Gültige Werte: Wahr: Kategorie ist ein Stamm von Kategorien. Falsch: Kategorie ist kein Stamm von Kategorien. Datentyp: Boolesch
Modellkategorie	Liste der Modellkategorien, die der Servicekategorie zugeordnet sind. Datentyp: Array von Objekten "modelCategory": [ { "id": "String", "name": "String" } ]
modelCategory.id	SYS_ID der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
modelCategory.name	Name der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
Name	Name der Servicekategorie. Datentyp: Zeichenfolge
Servicekandidat	Liste der Servicekandidaten, die dieser Kategorie zugeordnet sind. Datentyp: Array von Objekten "serviceCandidate": [ { "id": "String", "href": "String", "name": "String", "@referredType": "String", "version": "String" } ]
ServiceCandidate.@referredType	Wert ist immer Servicekategorie . Datentyp: Zeichenfolge
ServiceCandidate.href	Hyperlink für den Zugriff auf die Servicespezifikation. Datentyp: Zeichenfolge
serviceCandidate.id	SYS_ID der Servicespezifikation. Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification] Datentyp: Zeichenfolge
ServiceCandidate.Version	Version des Servicekandidaten. Datentyp: Zeichenfolge

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 : 42. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Anforderungstexts. Unterstützt nur Anwendung/JSON.
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützt nur Anwendung/JSON.

Tabelle : 43. Antwortkopfzeilen

Header	Beschreibung
Inhaltstyp	Datenformat des Antworttexts. Unterstützt nur Anwendung/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 : 44. Statuscodes

Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde aus mindestens einem der folgenden Gründe erkannt: Leere Nutzlast. Ungültige Nutzlast. Pflichtfeld fehlt.

Antworttext-Parameter (JSON oder XML)

Name	Beschreibung
ExternalIdentifier	Identifizierung von Informationen für ein externes System, das an der Verwaltung von Kategorien beteiligt ist. Datentyp: Array von Objekten "externalIdentifier": [ { "id": "String", "owner": "String" } ]
ExternalIdentifier.ID	Eindeutiger Bezeichner für die Servicekategorie. Dieser Wert wird von einem externen System bestimmt. Datentyp: Zeichenfolge Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category], Feld: External_ID
ExternalIdentifier.owner	Das System, das diese ID besitzt. Datentyp: Zeichenfolge
href	Hyperlink für den Zugriff auf die Servicekategorie. Datentyp: Zeichenfolge
ID	SYS_ID der Servicekategorie. Tabelle: Spezifikationskategorie [sn_prd_pm_specification_category] Datentyp: Zeichenfolge
IsRoot	Kennzeichnung, die angibt, ob die Kategorie ein Stamm von Kategorien ist. Gültige Werte: Wahr: Kategorie ist ein Stamm von Kategorien. Falsch: Kategorie ist kein Stamm von Kategorien. Datentyp: Boolesch
Modellkategorie	Liste der Modellkategorien, die der Servicekategorie zugeordnet sind. Datentyp: Array von Objekten "modelCategory": [ { "id": "String", "name": "String" } ]
Modellkategorie.ID	SYS_ID der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
modelCategory.name	Name der Modellkategorie. Tabelle: Modellkategorie [cmdb_model_category] Datentyp: Zeichenfolge
Name	Name der Servicekategorie. Datentyp: Zeichenfolge
Servicekandidat	Liste der Servicekandidaten, die dieser Kategorie zugeordnet sind. Datentyp: Array von Objekten "serviceCandidate": [ { "id": "String", "href": "String", "name": "String", "@referredType": "String", "version": "String" } ]
ServiceCandidate.@referredType	Wert ist immer Servicekategorie . Datentyp: Zeichenfolge
ServiceCandidate.href	Hyperlink für den Zugriff auf die Servicespezifikation. Datentyp: Zeichenfolge
ServiceCandidate.ID	SYS_ID der Servicespezifikation. Tabelle: Servicespezifikation [sn_prd_pm_Service_Specification] Datentyp: Zeichenfolge
ServiceCandidate.Version	Version des Servicekandidaten. Datentyp: Zeichenfolge

cURL-Anforderung

Im folgenden Beispiel wird POST aufgerufen, um einen neuen Servicekategoriedatensatz gemäß den Details im Anforderungstext zu erstellen.

curl "https://instance.service-now.com/api/sn_tmf_api/catalogmanagement/serviceCategory" \
  --request POST \
  --header "Accept:application/json" \
  --header "Content-Type:application/json" \
  --user 'user:password' \
  --data '{
    "name": "Cloud Services",
    "version": "1.0",
    "serviceCandidate": [
      {
        "id": "a1b23456c7de8a90f0123456gh789ij",
        "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
        "version": "3.2",
        "name": "Cloud Services",
        "@referredType": "ServiceCategory"
      }
    ],
    "modelCategory": [
      {
        "id": "b2d5bc14c3031000b959fd251eba8f96",
        "name": "model"
      }
    ],
    "externalIdentifier": {
      "id": "1234234312",
      "owner": "TMF200000123233"
    },
    "isRoot": true
  }'

Antworttext.

{
  "name": "Cloud Services",
  "version": "1.0",
  "serviceCandidate": [
    {
      "id": "a1b23456c7de8a90f0123456gh789ij",
      "href": "https://mycsp.com:8080/tmf-api/serviceCatalogManagement/v4/serviceCategory/5980",
      "version": "3.2",
      "name": "Cloud Services",
      "@referredType": "ServiceCategory"
    }
  ],
  "modelCategory": [
    {
      "id": "b2d5bc14c3031000b959fd251eba8f96",
      "name": "model"
    }
  ],
  "externalIdentifier": {
    "id": "1234234312",
    "owner": "TMF200000123233"
  },
  "isRoot": true,
  "id": "8138241b1caaaa10f87703c075c809fe",
  "href": "api/sn_tmf_api/service_catalog_api/serviceCategory/8138241b1caaaa10f87703c075c809fe"
}

Servicekatalog offen – POST/Servicespezifikation

Erstellt eine Servicespezifikation.

URL-Format

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

Unterstützte Anforderungsparameter

Tabelle : 45. Pfad-Parameter

Name	Beschreibung
Keine

Tabelle : 46. Abfrageparameter

Name	Beschreibung
Keine

Tabelle : 47. 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]
ExternalSystem	Drittpartei oder nicht native Plattform, die mit dem Servicekatalog interagiert. Wert wird immer mit angehängt TMF633 . Beispiel: Wenn das externe System ist ABC Dann muss der Wert in der externen Quelle sein ABC-TMF633 . Datentyp: Zeichenfolge
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]
Letztes Update	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	Werttyp des Merkmals, z. B. Auswahl oder E-Mail. Kann ein einfaches oder komplexes Merkmal sein. Mögliche Werte: Datum, Adresse Ganzzahl, Datum/Uhrzeit Array.Integer Array.Einzeiliger Test Einzeiliger Text Array.Objekt Array.Date Array.Decimal Ja/Nein Objekt Array.Datetime Kontrollkästchen E-Mail Auswahl 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].
@TYPE	Erforderlich. Typ der Spezifikation. Gültige Werte: CustomerFacingServiceSpezifikation ResourceFacingServicespezifikation Datentyp: Zeichenfolge

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 : 48. Anforderungskopfzeilen.

Header	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützt nur application/json.
Inhaltstyp	Datenformat des Anforderungstexts. Unterstützt nur application/json.

Tabelle : 49. Antwortkopfzeilen

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 : 50. Statuscodes

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

Parameter des Antwort-Haupttexts (JSON)

Name	Beschreibung
@TYPE	Typ der Spezifikation. Datentyp: Zeichenfolge
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].
ExternalSystem	Externes System der Servicespezifikation, angehängt mit TMF633 . Wenn das externe System beispielsweise ABC ist, geben Sie den Wert in ein externalSystemAS ABC-TMF633 . Datentyp: Zeichenfolge
ExternalSystem	Drittpartei oder nicht native Plattform, die mit dem Servicekatalog interagiert. Wert wird immer mit angehängt TMF633 . Beispiel: Wenn das externe System ist ABC Dann muss der Wert in der externen Quelle sein ABC-TMF633 . Datentyp: Zeichenfolge
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].
Letztes Update	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. Kann ein einfaches oder komplexes Merkmal sein. Mögliche Werte: Datum, Adresse Ganzzahl, Datum/Uhrzeit Array.Integer Array.Einzeiliger Test Einzeiliger Text Array.Objekt Array.Date Array.Decimal Ja/Nein Objekt Array.Datetime Kontrollkästchen E-Mail Auswahl 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].

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\",
   \"externalSource\": \"ABC-TMF633\",
   \"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",
   "externalSource": "ABC-TMF633",
   "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"
}