Servicevertrag-API

Freigeben Version: Washingtondc

Aktualisiert 1. Februar 2024

48 Minuten Lesedauer

Mit der Service Contract- API können Sie Servicevertragsdatensätze erstellen und abrufen.

Hinweis:

Diese API dient zum Erstellen von Daten in den Tabellen für die Anwendung Kundenverträge und Berechtigungen. Es handelt sich nicht um eine Allzweck-API.

Für den Zugriff auf diese API müssen die folgenden Plugins in der zugehörigen Instanz aktiviert sein:

Kundenverträge und Berechtigungen (com.sn_pss_core)
Customer Service Installationsbasisverwaltung (com.snc.install)
Product Catalog Management Core (com.sn_prd)

Um diese API erfolgreich aufzurufen, benötigen Sie außerdem die Rolle sn_pss_core.pss_integrator. Diese API wird im Namespace sn_pss_core ausgeführt.

Bevor Sie diese API verwenden, sollten Sie über zugehörige Daten in den folgenden Tabellen verfügen. Weitere Informationen finden Sie unter Create service contracts.

Account [customer_account]
Verbraucher [csm_consumer]
Haushalt [csm_household]
Installationsbasis [sn_install_base_item]
Produktangebot [sn_prd_pm_product_offering]
Produktmodell [cmdb_model]
Verkauftes Produkt [sn_install_base_sold_product]

Service Contract – GET /sn_pss_core/servicecontract/{id}

Ruft einen angegebenen Servicevertragsdatensatz ab.

Dieser Endpunkt ruft bei der Verarbeitung der Anforderung Daten in den folgenden Tabellen ab:

Merkmal [sn_pss_core_entitlement_characteristic]
Berechtigung [service_entitlement]
Berechtigungsnutzung [sn_pss_core_entitlement_usage]
Verkauftes Produkt abgedeckt [sn_install_base_m2m_contract_sold_product] – Diese Tabelle enthält Informationen für abgedeckte verkaufte Produkte und abgedeckte Installationsbasiselemente.
Servicevertrag [sn_pss_core_service_contract]
Servicevertragsposition [sn_pss_core_service_contract_line]

URL-Format

Versionierte URL: /api/sn_pss_core/v1/servicecontract/{id}

Standard-URL: /api/sn_pss_core/servicecontract/{id}

Unterstützte Anforderungsparameter

Tabelle : 1. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
id	Sys_id des abzurufenden Servicevertrags. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge

Tabelle : 2. Abfrageparameter
Name	Beschreibung
display_value	Typ der zurückzugebenden Daten. Gültige Werte: false: Gibt den `Wert` für alle Felder zurück. Beispiel: `"state":"entwurf"`. true: `display_value` für alle Felder zurückgeben. Beispiel: `"state":"Entwurf"` all: Gibt alle Informationen für alle Felder zurück. `"state": { "name": "state", "label": "State", "value": "draft", "display_value": "Draft", "type": "string" }` Datentyp: Zeichenfolge Standardwert: false

Tabelle : 3. Anforderungstextparameter (XML oder 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
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 5. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 6. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
403	Unzulässig. Der Benutzer hat keine Berechtigung für den Zugriff auf die API.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttextparameter (JSON oder XML)


Name	Beschreibung
Account	Sys_id des Account-Datensatzes, zu dem der Servicevertrag gehört. Befindet sich in der Tabelle „Account“ [customer_account]. Datentyp: Zeichenfolge
consumer	Sys_id des Verbraucherdatensatzes, zu dem der Servicevertrag gehört. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
endet	Datum, an dem der Servicevertrag endet. Datentyp: Zeichenfolge
Haushalt	Sys_id des Haushalts, der dem Servicevertrag zugeordnet ist. Befindet sich im Haushalt [csm_household]. Datentyp: Zeichenfolge
install_base_items_covered	Liste der Installationsbasiselemente, die von der Servicevertragsposition abgedeckt werden. Datentyp: Array von Objekten `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
install_base_items_covered.hinzugefügt	Datum, ab dem der zugehörige Servicevertrag das Installationsbasiselement abdeckt. Datentyp: Zeichenfolge
install_base_items_covered.contract	Sys_id des Servicevertrags-Datensatzes, der dem Installationsbasiselement zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
install_base_items_covered.berechtigung	Sys_id des Berechtigungsdatensatzes, der dem Installationsbasiselement zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
install_base_items_covered.install_base	Sys_id des zugeordneten Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item]. Datentyp: Zeichenfolge
install_base_items_covered.entfernt	Datum, an dem die Abdeckung des Installationsbasiselements durch den zugeordneten Servicevertrag endet. Datentyp: Zeichenfolge
install_base_items_covered.service_contract_line	Sys_id des zugehörigen Servicevertrags-Positionsdatensatzes. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
install_base_items_covered.sys_created_by	Name des Benutzers, der den Installationsbasiselement-Datensatz erstellt hat. Datentyp: Zeichenfolge
install_base_items_covered.sys_created_on	Datum und Uhrzeit der Erstellung des Installationsbasiselement-Datensatzes. Datentyp: Zeichenfolge
install_base_items_covered.sys_id	Sys_id des abgedeckten Installationsbasiselements. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
install_base_items_covered.sys_updated_by	Name des Benutzers, der den Datensatz des Installationsbasiselements zuletzt aktualisiert hat. Datentyp: Zeichenfolge
install_base_items_covered.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Installationsbasiselement-Datensatzes. Datentyp: Zeichenfolge
Nummer	Automatisch generierte Servicevertragsnummer. Datentyp: Zeichenfolge
service_contract_lines	Liste der Servicevertrags-Positionen (Services), die dem Servicevertrag zugeordnet sind. Datentyp: Array von Objekten `"service_contract_lines": [ { "contract": "String", "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "product_model": "String", "product_offering": "String", "sold_product": "String", "sold_product_covered": [Array], "starts": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String" } ]`
service_contract_lines.contract	Sys_id des Servicevertrags, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
service_contract_lines.ends	Datum, an dem die Servicevertragsposition endet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Wird nie beendet, bis manuell entfernt wird.
service_contract_lines.berechtigungen	Liste der Berechtigungen, die dem Servicevertrag zugeordnet sind. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Array von Objekten "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "entitlement_usages": [Array], "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "service_contract_line": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]
service_contract_lines.entitlements.account	Sys_id des Account-Datensatzes, zu dem die Berechtigung gehört. Befindet sich in der Tabelle „Account“ [customer_account]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.consumer	Sys_id des Verbraucherdatensatzes, zu dem die Berechtigung gehört. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.contract	Sys_id des Vertragsdatensatzes, zu dem die Berechtigung gehört. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
service_contract_lines.berechtigungen.end_date	Enddatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Wird nie beendet, bis manuell entfernt wird.
service_contract_lines.entitlements.entitlement_characteristics	Liste der Merkmale, die der Berechtigung zugeordnet sind. Befindet sich in der Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic]. Datentyp: Array von Objekten `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ]`
service_contract_lines.entitlements.entitlement_characteristics.characteristic	Sys_id des Merkmalsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.characteristic_option	Sys_id des Merkmalsoptionsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmalsoption“ [sn_prd_pm_characteristic_option]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.entitlement	Sys_id des zugeordneten Berechtigungsdatensatzes. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.service_contract_line	Sys_id des Servicevertrags-Positionsdatensatzes, der dem Berechtigungsmerkmal zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.sys_created_by	Name des Benutzers, der den Berechtigungsmerkmale-Datensatz erstellt hat. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes mit Berechtigungsmerkmalen. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.sys_id	Sys_id des Berechtigungsmerkmale-Datensatzes. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.sys_updated_by	Name des Benutzers, der den Berechtigungsmerkmale-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes mit Berechtigungsmerkmalen. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.type	Typ des Berechtigungsmerkmals. Gültige Werte: Abdeckung Abdeckung und Verwendung Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.value	Wert des Merkmals. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_name	Name der Berechtigung. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_usages	Liste der Nutzungswerte für das zugeordnete Produkt. Datentyp: Array von Objekten `"entitlement_usages": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String", "total_units": "String", "used_units": "String" } ]`
service_contract_lines.entitlements.entitlement_usages.entitlement	Sys_id des Berechtigungsdatensatzes, der der Berechtigungsnutzung zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_usages.entitlement_characteristic	Sys_id des Berechtigungsmerkmal-Datensatzes, der der Berechtigungsnutzung zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_usages.period_end	Enddatum, ab dem die Berechtigungsnutzung nicht mehr nachverfolgt wird. Datentyp: Zeichenfolge Format: jjjj-mm-tt
service_contract_lines.entitlements.entitlement_usages.period_start	Startdatum der Nachverfolgung der Berechtigungsnutzung. Datentyp: Zeichenfolge Format: jjjj-mm-tt
service_contract_lines.entitlements.entitlement_usages.sys_created_by	Name des Benutzers, der den Berechtigungsnutzungsdatensatz erstellt hat. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_usages.sys_created_on	Datum und Uhrzeit der Erstellung des Berechtigungsnutzungsdatensatzes. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_usages.sys_id	Sys_id des Berechtigungsnutzungsdatensatzes. Befindet sich in der Tabelle „Berechtigungsnutzung“ [sn_pss_core_entitlement_usage]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_usages.sys_updated_by	Name des Benutzers, der den Berechtigungsnutzungsdatensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_usages.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Berechtigungsnutzungsdatensatzes. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_usages.total_units	Gesamtzahl der erworbenen Einheiten. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_usages.used_units	Anzahl der verwendeten Einheiten. Datentyp: Zeichenfolge
service_contract_lines.entitlements.household	Sys_id des Haushaltsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Haushalt“ [csm_household]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered	Liste der Installationsbasiselemente, die von der Servicevertragsposition abgedeckt werden. Datentyp: Array von Objekten `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
service_contract_lines.entitlements.install_base_items_covered.hinzugefügt	Datum, an dem das zugeordnete Installationsbasiselement der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered.contract	Sys_id des Servicevertrags-Datensatzes, der dem Installationsbasiselement zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered.entitlement	Sys_id des Berechtigungsdatensatzes, der dem Installationsbasiselement zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered.install_base	Sys_id des zugeordneten Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered.entfernt	Datum, an dem das zugeordnete Installationsbasiselement aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered.service_contract_line	Sys_id des zugehörigen Servicevertrags-Positionsdatensatzes. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered.sys_created_by	Name des Benutzers, der den Installationsbasiselement-Datensatz erstellt hat. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered.sys_created_on	Datum und Uhrzeit der Erstellung des Installationsbasiselement-Datensatzes. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered.sys_id	Sys_id des abgedeckten Installationsbasiselements. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered.sys_updated_by	Name des Benutzers, der den Datensatz des Installationsbasiselements zuletzt aktualisiert hat. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Installationsbasiselement-Datensatzes. Datentyp: Zeichenfolge
service_contract_lines.entitlements.product	Sys_id des Produktmodelldatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.product_offering	Sys_id des Produktangebotsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
service_contract_lines.berechtigungen.service_contract_line	Sys_id des Servicevertrags-Positionsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_entitlement	Sys_id des Datensatzes für verkaufte Produkte, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_products_covered	Liste der abgedeckten Produkte. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Array von Objekten `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
service_contract_lines.entitlements.sold_products_covered.added	Datum, an dem das zugeordnete verkaufte Produkt der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
service_contract_lines.entitlements.sold_products_covered.contract	Sys_id des Servicevertrags-Datensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
entitlements.sold_products_covered.entitlement	Sys_id des Berechtigungsdatensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_products_covered.removed	Datum, an dem das zugeordnete verkaufte Produkt aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
service_contract_lines.entitlements.sold_products_covered.service_contract_line	Sys_id des Servicevertrags-Positionsdatensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_products_covered.sold_product	Sys_id des von der Berechtigung abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_products_covered.sys_created_by	Name des Benutzers, der den Datensatz „Verkauftes Produkt abgedeckt“ erstellt hat. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_products_covered.sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes für das abgedeckte verkaufte Produkt. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_products_covered.sys_id	Sys_id des von diesem Servicevertrag abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_products_covered.sys_updated_by	Name des Benutzers, der den Datensatz „Verkauftes Produkt abgedeckt“ zuletzt aktualisiert hat. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_products_covered.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes „Verkauftes Produkt abgedeckt“. Datentyp: Zeichenfolge
service_contract_lines.berechtigungen.start_date	Startdatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt
service_contract_lines.entitlements.state	Aktueller Status der Berechtigung. Gültige Werte: (Groß-/Kleinschreibung beachten) aktiv Abgebrochen Entwurf abgelaufen ausgesetzt Datentyp: Zeichenfolge
service_contract_lines.entitlements.sys_created_by	Name des Benutzers, der den Berechtigungsdatensatz erstellt hat. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sys_created_on	Datum und Uhrzeit der Erstellung des Berechtigungsdatensatzes. Datentyp: Zeichenfolge
service_contract_lines.berechtigungen.sys_id	Sys_id des zugeordneten Berechtigungsdatensatzes. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sys_updated_by	Name des Benutzers, der den Berechtigungsdatensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sys_updated_on	Datum und Uhrzeit der Erstellung des Berechtigungsdatensatzes. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics	Liste der Merkmale, die der Servicevertragsposition zugeordnet sind. Befindet sich in der Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic]. Datentyp: Array von Objekten `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ]`
service_contract_lines.entitlement_characteristics.characteristic	Sys_id des Merkmalsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.characteristic_option	Sys_id des Merkmalsoptionsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmalsoption“ [sn_prd_pm_characteristic_option]. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.entitlement	Sys_id des zugeordneten Berechtigungsdatensatzes. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.service_contract_line	Sys_id des Servicevertrags-Positionsdatensatzes, der dem Berechtigungsmerkmal zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.sys_created_by	Name des Benutzers, der den Berechtigungsmerkmale-Datensatz erstellt hat. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes mit Berechtigungsmerkmalen. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.sys_id	Sys_id des Berechtigungsmerkmale-Datensatzes. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.sys_updated_by	Name des Benutzers, der den Berechtigungsmerkmale-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes mit Berechtigungsmerkmalen. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.type	Typ des Berechtigungsmerkmals. Gültige Werte: Abdeckung Abdeckung und Verwendung Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.value	Wert des Merkmals. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered	Liste der Installationsbasiselemente, die von der Servicevertragsposition abgedeckt werden. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Array von Objekten `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
service_contract_lines.install_base_items_covered.hinzugefügt	Datum, an dem das zugeordnete Installationsbasiselement der Servicevertragsposition hinzugefügt wurde. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.contract	Sys_id des Servicevertrags-Datensatzes, der dem Installationsbasiselement zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.entitlement	Sys_id des Berechtigungsdatensatzes, der dem Installationsbasiselement zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.install_base	Sys_id des Installationsbasiselements, das von der Servicevertragsposition abgedeckt wird. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item]. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.entfernt	Datum, an dem die zugeordnete Servicevertragsposition die Abdeckung des Installationsbasiselements beendet. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.service_contract_line	Sys_id des zugehörigen Servicevertrags-Positionsdatensatzes. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.sys_created_by	Name des Benutzers, der den Installationsbasiselement-Datensatz erstellt hat. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.sys_created_on	Datum und Uhrzeit der Erstellung des Installationsbasiselement-Datensatzes. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.sys_id	Sys_id des abgedeckten Installationsbasiselements. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.sys_updated_by	Name des Benutzers, der den Datensatz des Installationsbasiselements zuletzt aktualisiert hat. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Installationsbasiselement-Datensatzes. Datentyp: Zeichenfolge
service_contract_lines.name	Name der Servicevertragsposition. Datentyp: Zeichenfolge
service_contract_lines.product_model	Sys_id des Produkts, das der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model]. Datentyp: Zeichenfolge
service_contract_lines.product_offering	Sys_id des Produktangebotsdatensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
service_contract_lines.sold_product	Sys_id des Datensatzes für verkaufte Produkte, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.sold_products_covered	Liste der abgedeckten Produkte. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Array von Objekten `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
service_contract_lines.sold_products_covered.hinzugefügt	Datum, an dem das zugeordnete verkaufte Produkt der Servicevertragsposition hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
service_contract_lines.sold_products_covered.contract	Sys_id des Servicevertrags-Datensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
service_contract_lines.sold_products_covered.entitlement	Sys_id des Berechtigungsdatensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
service_contract_lines.sold_products_covered.removed	Datum, an dem das zugeordnete verkaufte Produkt aus der Servicevertragsposition entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
service_contract_lines.sold_products_covered.service_contract_line	Sys_id des Servicevertrags-Positionsdatensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
service_contract_lines.sold_products_covered.sold_product	Sys_id des von der Berechtigung abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.sold_products_covered.sys_created_by	Name des Benutzers, der den Datensatz „Verkauftes Produkt abgedeckt“ erstellt hat. Datentyp: Zeichenfolge
service_contract_lines.sold_products_covered.sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes für das abgedeckte verkaufte Produkt. Datentyp: Zeichenfolge
service_contract_lines.sold_products_covered.sys_id	Sys_id des von diesem Servicevertrag abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.sold_products_covered.sys_updated_by	Name des Benutzers, der den Datensatz „Verkauftes Produkt abgedeckt“ zuletzt aktualisiert hat. Datentyp: Zeichenfolge
service_contract_lines.sold_products_covered.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes „Verkauftes Produkt abgedeckt“. Datentyp: Zeichenfolge
service_contract_lines.starts	Startdatum der Servicevertragsposition. Datentyp: Zeichenfolge Format: jjjj-mm-tt
service_contract_lines.state	Aktueller Status der Servicevertragsposition. Gültige Werte: (Groß-/Kleinschreibung beachten) aktiv Abgebrochen Entwurf abgelaufen ausgesetzt Datentyp: Zeichenfolge
service_contract_lines.sys_created_by	Name des Benutzers, der den Datensatz der Servicevertragsposition erstellt hat. Datentyp: Zeichenfolge
service_contract_lines.sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes der Servicevertragsposition. Datentyp: Zeichenfolge
service_contract_lines.sys_id	Sys_id eines Servicevertrags-Positionsdatensatzes. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
service_contract_lines.sys_updated_by	Name des Benutzers, der den Datensatz der Servicevertragsposition zuletzt aktualisiert hat. Datentyp: Zeichenfolge
service_contract_lines.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes der Servicevertragsposition. Datentyp: Zeichenfolge
short_description	Kurzbeschreibung oder Name des Servicevertrags. Datentyp: Zeichenfolge
„sold_products_covered“.	Liste der abgedeckten Produkte. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Array von Objekten `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
„sold_products_covered“hinzugefügt	Datum, an dem das zugehörige verkaufte Produkt dem Vertrag hinzugefügt wurde. Datentyp: Zeichenfolge
„sold_products_covered.contract“	Sys_id des Servicevertrags-Datensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
Berechtigung „sold_products_covered“.	Sys_id des Berechtigungsdatensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
„sold_products_covered“ wurde entfernt	Datum, an dem das zugeordnete verkaufte Produkt aus dem Vertrag entfernt wurde. Datentyp: Zeichenfolge
„sold_products_covered“.service_line_contract	Sys_id des Servicevertrags-Positionsdatensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
„sold_products_covered“.sold_product	Sys_id des vom Servicevertrag abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
„sold_products_covered“.sys_created_by	Name des Benutzers, der den Datensatz „Verkauftes Produkt abgedeckt“ erstellt hat. Datentyp: Zeichenfolge
„sold_products_covered“.sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes für das abgedeckte verkaufte Produkt. Datentyp: Zeichenfolge
„sold_products_covered“.sys_id	Sys_id des von diesem Servicevertrag abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
„sold_products_covered“.sys_updated_by	Name des Benutzers, der den Datensatz „Verkauftes Produkt abgedeckt“ zuletzt aktualisiert hat. Datentyp: Zeichenfolge
„sold_products_covered“.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes „Verkauftes Produkt abgedeckt“. Datentyp: Zeichenfolge
beginnt	Datum, an dem der Servicevertrag beginnt. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Startet, sobald genehmigt.
Status	Aktueller Status des Servicevertrags. Gültige Werte: (Groß-/Kleinschreibung beachten) aktiv Abgebrochen Entwurf abgelaufen ausgesetzt Datentyp: Zeichenfolge
sys_created_by	Name des Benutzers, der den Servicevertragsdatensatz erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Datensatzerstellung des Servicevertrags. Datentyp: Zeichenfolge
sys_id	Sys_id des Servicevertrags-Datensatzes. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
sys_updated_by	Name des Benutzers, der den Servicevertragsdatensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Servicevertragsdatensatzes. Datentyp: Zeichenfolge
vendor_contract	Eindeutiger Bezeichner für einen zugeordneten externen Vertrag. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract/fc73d2de89226110f877430a4e008add" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Antwort:

{
    "result": {
        "sys_id": "d8641151d1f53110f8776589fa411fde",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:27:29",
        "sys_updated_on": "2023-10-09 11:27:29",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "number": "CNTR0010004",
        "state": "active",
        "starts": "2022-12-03",
        "ends": "",
        "short_description": null,
        "vendor_contract": "External Reference",
        "service_contract_lines": [
            {
                "sys_id": "d4641d91d1f53110f8776589fa411fbb",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "name": "CLI",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "sold_product": null,
                "starts": "2022-12-03",
                "ends": "",
                "product_offering": null,
                "product_model": null,
                "entitlements": [
                    {
                        "sys_id": "a8641d91d1f53110f8776589fa411fc0",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "entitlement_name": "ENTL",
                        "account": "4c325111d1f53110f8776589fa411f3d",
                        "consumer": null,
                        "household": null,
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "state": "active",
                        "product_offering": null,
                        "sold_entitlement": null,
                        "product": null,
                        "start_date": "2022-12-03",
                        "end_date": "",
                        "entitlement_characteristics": [
                            {
                                "sys_id": "a8641d91d1f53110f8776589fa411fd0",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "service_contract_line": null,
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                                "value": "5",
                                "characteristic": "63418db7539e61106bfcddeeff7b1238",
                                "type": "coverage_and_usage"
                            }
                        ],
                        "entitlement_usages": [
                            {
                                "sys_id": "a8641d91d1f53110f8776589fa411fd1",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "entitlement_characteristic": "a8641d91d1f53110f8776589fa411fd0",
                                "period_start": "2022-12-03",
                                "period_end": "",
                                "total_units": "5",
                                "used_units": "3"
                            }
                        ],
                        "sold_products_covered": [
                            {
                                "sys_id": "a0641d91d1f53110f8776589fa411fc2",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "contract": "d8641151d1f53110f8776589fa411fde",
                                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "sold_product": "da23d151d1f53110f8776589fa411f27",
                                "added": "",
                                "removed": ""
                            }
                        ],
                        "install_base_items_covered": [
                            {
                                "sys_id": "e0641d91d1f53110f8776589fa411fc3",
                                "sys_created_by": "admin",
                                "sys_updated_by": "admin",
                                "sys_created_on": "2023-10-09 11:27:29",
                                "sys_updated_on": "2023-10-09 11:27:29",
                                "contract": "d8641151d1f53110f8776589fa411fde",
                                "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                                "entitlement": "a8641d91d1f53110f8776589fa411fc0",
                                "install_base": "43739151d1f53110f8776589fa411fc1",
                                "added": "2023-12-03",
                                "removed": "2023-12-03"
                            }
                        ]
                    }
                ],
                "sold_products_covered": [
                    {
                        "sys_id": "98641d91d1f53110f8776589fa411fbc",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "install_base_items_covered": [
                    {
                        "sys_id": "58641d91d1f53110f8776589fa411fbd",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "install_base": "a1731551d1f53110f8776589fa411f8d",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "entitlement_characteristics": [
                    {
                        "sys_id": "e0641d91d1f53110f8776589fa411fbf",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "service_contract_line": "d4641d91d1f53110f8776589fa411fbb",
                        "entitlement": null,
                        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                        "value": "5",
                        "characteristic": "63418db7539e61106bfcddeeff7b1238",
                        "type": "coverage"
                    }
                ]
            },
            {
                "sys_id": "e4641d91d1f53110f8776589fa411fd2",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "name": "CLI 2",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "sold_product": null,
                "starts": "2022-12-03",
                "ends": "",
                "product_offering": null,
                "product_model": null,
                "entitlements": [],
                "sold_products_covered": [
                    {
                        "sys_id": "e8641d91d1f53110f8776589fa411fd3",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
                        "entitlement": null,
                        "sold_product": "7f23995dd1b53110f8776589fa411f66",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "install_base_items_covered": [
                    {
                        "sys_id": "a8641d91d1f53110f8776589fa411fd4",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "contract": "d8641151d1f53110f8776589fa411fde",
                        "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
                        "entitlement": null,
                        "install_base": "a483d951d1f53110f8776589fa411fad",
                        "added": "2023-12-03",
                        "removed": "2023-12-03"
                    }
                ],
                "entitlement_characteristics": [
                    {
                        "sys_id": "a8641d91d1f53110f8776589fa411fd5",
                        "sys_created_by": "admin",
                        "sys_updated_by": "admin",
                        "sys_created_on": "2023-10-09 11:27:29",
                        "sys_updated_on": "2023-10-09 11:27:29",
                        "service_contract_line": "e4641d91d1f53110f8776589fa411fd2",
                        "entitlement": null,
                        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
                        "value": "5",
                        "characteristic": "63418db7539e61106bfcddeeff7b1238",
                        "type": "coverage"
                    }
                ]
            }
        ],
        "sold_products_covered": [
            {
                "sys_id": "9c641d91d1f53110f8776589fa411fb9",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": null,
                "entitlement": null,
                "sold_product": "0df21151d1f53110f8776589fa411f1b",
                "added": "2023-12-03",
                "removed": "2023-12-03"
            }
        ],
        "install_base_items_covered": [
            {
                "sys_id": "d8641d91d1f53110f8776589fa411fba",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:27:29",
                "sys_updated_on": "2023-10-09 11:27:29",
                "contract": "d8641151d1f53110f8776589fa411fde",
                "service_contract_line": null,
                "entitlement": null,
                "install_base": "e2639951d1f53110f8776589fa411f2b",
                "added": "2023-12-03",
                "removed": "2023-12-03"
            }
        ]
    }
}

Service Contract – GET /sn_pss_core/servicecontract/contractline/{id}

Ruft einen angegebenen Servicevertrags-Positionsdatensatz ab.

Dieser Endpunkt ruft bei der Verarbeitung der Anforderung Daten in den folgenden Tabellen ab:

Merkmal [sn_pss_core_entitlement_characteristic]
Berechtigung [service_entitlement]
Berechtigungsnutzung [sn_pss_core_entitlement_usage]
Verkauftes Produkt abgedeckt [sn_install_base_m2m_contract_sold_product] – Diese Tabelle enthält Informationen für abgedeckte verkaufte Produkte und abgedeckte Installationsbasiselemente.
Servicevertragsposition [sn_pss_core_service_contract_line]

URL-Format

Versionierte URL: /api/sn_pss_core/v1/servicecontract/contractline/{id}

Standard-URL: /api/sn_pss_core/servicecontract/contractline/{id}

Unterstützte Anforderungsparameter

Tabelle : 7. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge
id	Sys_id des abzurufenden Datensatzes der Servicevertragsposition. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge

Tabelle : 8. Abfrageparameter
Name	Beschreibung
display_value	Typ der zurückzugebenden Daten. Gültige Werte: false: Gibt den `Wert` für alle Felder zurück. Beispiel: `"state":"entwurf"`. true: `display_value` für alle Felder zurückgeben. Beispiel: `"state":"Entwurf"` all: Gibt alle Informationen für alle Felder zurück. `"state": { "name": "state", "label": "State", "value": "draft", "display_value": "Draft", "type": "string" }` Datentyp: Zeichenfolge Standardwert: false

Tabelle : 9. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Keine

Kopfzeilen

Tabelle : 10. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 11. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 12. Statuscodes
Statuscode	Beschreibung
200	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
403	Unzulässig. Der Benutzer hat keine Berechtigung für den Zugriff auf die API.
404	Nicht gefunden. Das angeforderte Element wurde nicht gefunden.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttextparameter (JSON oder XML)


Name	Beschreibung
contract	Sys_id des Servicevertrags, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
endet	Datum, an dem die Servicevertragsposition endet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Wird nie beendet, bis manuell entfernt wird.
-Berechtigungen	Liste der Berechtigungen, die der Servicevertragsposition zugeordnet sind. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Array von Objekten "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "entitlement_usages": [Array], "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "service_contract_line": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]
-Berechtigungen.Konto	Sys_id des Account-Datensatzes, zu dem die Berechtigung gehört. Befindet sich in der Tabelle „Account“ [customer_account]. Datentyp: Zeichenfolge
Berechtigungen.Verbraucher	Sys_id des Verbraucherdatensatzes, zu dem die Berechtigung gehört. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
-Berechtigungen.Vertrag	Sys_id des Vertragsdatensatzes, zu dem die Berechtigung gehört. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
-Berechtigungen.end_date	Enddatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Wird nie beendet, bis manuell entfernt wird.
Berechtigungen.entitlement_characteristics	Liste der Merkmale, die der Berechtigung zugeordnet sind. Befindet sich in der Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic]. Datentyp: Array von Objekten `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ]`
Berechtigungen.entitlement_characteristics.characteristic	Sys_id des Merkmalsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
Berechtigungen.entitlement_characteristics.characteristic_option	Sys_id des Merkmalsoptionsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmalsoption“ [sn_prd_pm_characteristic_option]. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.entitlement	Sys_id des zugeordneten Berechtigungsdatensatzes. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.service_contract_line	Sys_id des Servicevertrags-Positionsdatensatzes, der dem Berechtigungsmerkmal zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.sys_created_by	Name des Benutzers, der den Berechtigungsmerkmale-Datensatz erstellt hat. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes mit Berechtigungsmerkmalen. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.sys_id	Sys_id des Berechtigungsmerkmale-Datensatzes. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.sys_updated_by	Name des Benutzers, der den Berechtigungsmerkmale-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes mit Berechtigungsmerkmalen. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.type	Typ des Berechtigungsmerkmals. Gültige Werte: Abdeckung Abdeckung und Verwendung Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.value	Wert des Merkmals. Datentyp: Zeichenfolge
entitlements.entitlement_name	Name der Berechtigung. Datentyp: Zeichenfolge
Berechtigungen.entitlement_usages	Liste der Nutzungswerte für das zugeordnete Produkt. Datentyp: Array von Objekten `"entitlement_usages": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_update_on": "String", "total_units": "String", "used_units": "String" } ]`
entitlements.entitlement_usages.entitlement	Sys_id des Berechtigungsdatensatzes, der der Berechtigungsnutzung zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
entitlements.entitlement_usages.entitlement_characteristic	Sys_id des Berechtigungsmerkmal-Datensatzes, der der Berechtigungsnutzung zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic]. Datentyp: Zeichenfolge
entitlements.entitlement_usages.period_end	Enddatum, ab dem die Berechtigungsnutzung nicht mehr nachverfolgt wird. Datentyp: Zeichenfolge Format: jjjj-mm-tt
entitlements.entitlement_usages.period_start	Startdatum der Nachverfolgung der Berechtigungsnutzung. Datentyp: Zeichenfolge Format: jjjj-mm-tt
entitlements.entitlement_usages.sys_created_by	Name des Benutzers, der den Berechtigungsnutzungsdatensatz erstellt hat. Datentyp: Zeichenfolge
entitlements.entitlement_usages.sys_created_on	Datum und Uhrzeit der Erstellung des Berechtigungsnutzungsdatensatzes. Datentyp: Zeichenfolge
entitlements.entitlement_usages.sys_id	Sys_id des Berechtigungsnutzungsdatensatzes. Befindet sich in der Tabelle „Berechtigungsnutzung“ [sn_pss_core_entitlement_usage]. Datentyp: Zeichenfolge
entitlements.entitlement_usages.sys_updated_by	Name des Benutzers, der den Berechtigungsnutzungsdatensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
entitlements.entitlement_usages.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Berechtigungsnutzungsdatensatzes. Datentyp: Zeichenfolge
entitlements.entitlement_usages.total_units	Gesamtzahl der erworbenen Einheiten. Datentyp: Zeichenfolge
entitlements.entitlement_usages.used_units	Anzahl der verwendeten Einheiten. Datentyp: Zeichenfolge
Berechtigungen.Haushalt	Sys_id des Haushaltsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Haushalt“ [csm_household]. Datentyp: Zeichenfolge
-Berechtigungen.install_base_items_covered	Liste der Installationsbasiselemente, die von der Servicevertragsposition abgedeckt werden. Datentyp: Array von Objekten `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
-Berechtigungen.install_base_items_covered.hinzugefügt	Datum, an dem das zugeordnete Installationsbasiselement der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge
entitlements.install_base_items_covered.contract	Sys_id des Servicevertrags-Datensatzes, der dem Installationsbasiselement zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
entitlements.install_base_items_covered.entitlement	Sys_id des Berechtigungsdatensatzes, der dem Installationsbasiselement zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
entitlements.install_base_items_covered.install_base	Sys_id des zugeordneten Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item]. Datentyp: Zeichenfolge
Berechtigungen.install_base_items_covered.entfernt	Datum, an dem das zugeordnete Installationsbasiselement aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge
Berechtigungen.install_base_items_covered.service_contract_line	Sys_id des zugehörigen Servicevertrags-Positionsdatensatzes. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
entitlements.install_base_items_covered.sys_created_by	Name des Benutzers, der den Installationsbasiselement-Datensatz erstellt hat. Datentyp: Zeichenfolge
Berechtigungen.install_base_items_covered.sys_created_on	Datum und Uhrzeit der Erstellung des Installationsbasiselement-Datensatzes. Datentyp: Zeichenfolge
entitlements.install_base_items_covered.sys_id	Sys_id des abgedeckten Installationsbasiselements. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
Berechtigungen.install_base_items_covered.sys_updated_by	Name des Benutzers, der den Datensatz des Installationsbasiselements zuletzt aktualisiert hat. Datentyp: Zeichenfolge
Berechtigungen.install_base_items_covered.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Installationsbasiselement-Datensatzes. Datentyp: Zeichenfolge
-Berechtigungen.Produkt	Sys_id des Produktmodelldatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model]. Datentyp: Zeichenfolge
Berechtigungen.product_offering	Sys_id des Produktangebotsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
Berechtigungen service_contract_line	Sys_id des Servicevertrags-Positionsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
-Berechtigungen.sold_entitlement	Sys_id des Datensatzes für verkaufte Produkte, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
-Berechtigungen.sold_products_covered	Liste der abgedeckten Produkte. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Array von Objekten `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
Berechtigungen.sold_products_covered.hinzugefügt	Datum, an dem das zugeordnete verkaufte Produkt der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
entitlements.sold_products_covered.contract	Sys_id des Servicevertrags-Datensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
entitlements.sold_products_covered.entitlement	Sys_id des Berechtigungsdatensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
-Berechtigungen.sold_products_covered.removed	Datum, an dem das zugeordnete verkaufte Produkt aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
Berechtigungen.sold_products_covered.service_contract_line	Sys_id des Servicevertrags-Positionsdatensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
Berechtigungen.sold_products_covered.sold_product	Sys_id des von der Berechtigung abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
-Berechtigungen.sold_products_covered.sys_created_by	Name des Benutzers, der den Datensatz „Verkauftes Produkt abgedeckt“ erstellt hat. Datentyp: Zeichenfolge
-Berechtigungen.sold_products_covered.sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes für das abgedeckte verkaufte Produkt. Datentyp: Zeichenfolge
Berechtigungen.sold_products_covered.sys_id	Sys_id des von diesem Servicevertrag abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
-Berechtigungen.sold_products_covered.sys_updated_by	Name des Benutzers, der den Datensatz „Verkauftes Produkt abgedeckt“ zuletzt aktualisiert hat. Datentyp: Zeichenfolge
-Berechtigungen.sold_products_covered.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes „Verkauftes Produkt abgedeckt“. Datentyp: Zeichenfolge
Berechtigungen.start_date	Startdatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt
Berechtigungen.Status	Aktueller Status der Berechtigung. Gültige Werte: (Groß-/Kleinschreibung beachten) aktiv Abgebrochen Entwurf abgelaufen ausgesetzt Datentyp: Zeichenfolge
-Berechtigungen.sys_created_by	Name des Benutzers, der den Berechtigungsdatensatz erstellt hat. Datentyp: Zeichenfolge
-Berechtigungen.sys_created_on	Datum und Uhrzeit der Erstellung des Berechtigungsdatensatzes. Datentyp: Zeichenfolge
Berechtigungen. sys_id	Sys_id des zugeordneten Berechtigungsdatensatzes. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
-Berechtigungen.sys_updated_by	Name des Benutzers, der den Berechtigungsdatensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
-Berechtigungen.sys_updated_on	Datum und Uhrzeit der Erstellung des Berechtigungsdatensatzes. Datentyp: Zeichenfolge
entitlement_characteristics	Liste der Berechtigungsmerkmale, die der Servicevertragsposition zugeordnet sind. Befindet sich in der Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic]. Datentyp: Array von Objekten `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "type": "String", "value": "String" } ]`
entitlement_characteristics.Merkmal	Sys_id des Merkmalsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
entitlement_characteristics.characteristic_option	Sys_id des Merkmalsoptionsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmalsoption“ [sn_prd_pm_characteristic_option]. Datentyp: Zeichenfolge
entitlement_characteristics.entitlement	Sys_id des Berechtigungsdatensatzes. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
entitlement_characteristics.service_contract_line	Sys_id des Servicevertrags-Positionsdatensatzes, der dem Berechtigungsmerkmal zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
entitlement_characteristics.sys_created_by	Name des Benutzers, der den Berechtigungsmerkmale-Datensatz erstellt hat. Datentyp: Zeichenfolge
entitlement_characteristics.sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes mit Berechtigungsmerkmalen. Datentyp: Zeichenfolge
entitlement_characteristics.sys_id	Sys_id des Berechtigungsmerkmale-Datensatzes. Datentyp: Zeichenfolge
entitlement_characteristics.sys_updated_by	Name des Benutzers, der den Berechtigungsmerkmale-Datensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge
entitlement_characteristics.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes mit Berechtigungsmerkmalen. Datentyp: Zeichenfolge
entitlement_characteristics.type	Typ des Berechtigungsmerkmals. Gültige Werte: Abdeckung Abdeckung und Verwendung Datentyp: Zeichenfolge
entitlement_characteristics.value	Wert des Merkmals. Datentyp: Zeichenfolge
install_base_items_covered	Liste der Installationsbasiselemente, die von der Servicevertragsposition abgedeckt werden. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Array von Objekten `"install_base_items_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "install_base": "String", "removed": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
install_base_items_covered.hinzugefügt	Datum, an dem das zugeordnete Installationsbasiselement der Servicevertragsposition hinzugefügt wurde. Datentyp: Zeichenfolge
install_base_items_covered.contract	Sys_id des Servicevertrags-Datensatzes, der dem Installationsbasiselement zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
install_base_items_covered.berechtigung	Sys_id des Berechtigungsdatensatzes, der dem Installationsbasiselement zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
install_base_items_covered.install_base	Sys_id des Installationsbasiselements, das von der Servicevertragsposition abgedeckt wird. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item]. Datentyp: Zeichenfolge
install_base_items_covered.entfernt	Datum, an dem die zugeordnete Servicevertragsposition die Abdeckung des Installationsbasiselements beendet. Datentyp: Zeichenfolge
install_base_items_covered.service_contract_line	Sys_id des zugehörigen Servicevertrags-Positionsdatensatzes. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
install_base_items_covered.sys_created_by	Name des Benutzers, der den Installationsbasiselement-Datensatz erstellt hat. Datentyp: Zeichenfolge
install_base_items_covered.sys_created_on	Datum und Uhrzeit der Erstellung des Installationsbasiselement-Datensatzes. Datentyp: Zeichenfolge
install_base_items_covered.sys_id	Sys_id des abgedeckten Installationsbasiselements. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
install_base_items_covered.sys_updated_by	Name des Benutzers, der den Datensatz des Installationsbasiselements zuletzt aktualisiert hat. Datentyp: Zeichenfolge
install_base_items_covered.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Installationsbasiselement-Datensatzes. Datentyp: Zeichenfolge
Name	Name der Servicevertragsposition. Datentyp: Zeichenfolge
product_model	Sys_id des Produkts, das der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model]. Datentyp: Zeichenfolge
product_offering	Sys_id des Produktangebotsdatensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
„sold_product“	Sys_id des Datensatzes für verkaufte Produkte, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
„sold_products_covered“.	Liste der abgedeckten Produkte. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Array von Objekten `"sold_products_covered": [ { "added": "String", "contract": "String", "entitlement": "String", "removed": "String", "service_contract_line": "String", "sold_product": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String" } ]`
„sold_products_covered“hinzugefügt	Datum, an dem das zugeordnete verkaufte Produkt der Servicevertragsposition hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
„sold_products_covered.contract“	Sys_id des Servicevertrags-Datensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
Berechtigung „sold_products_covered“.	Sys_id des Berechtigungsdatensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
„sold_products_covered.removed“	Datum, an dem das zugeordnete verkaufte Produkt aus der Servicevertragsposition entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
„sold_products_covered“.service_contract_line	Sys_id des Servicevertrags-Positionsdatensatzes, der dem verkauften Produkt zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
„sold_products_covered“.sold_product	Sys_id des von der Berechtigung abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
„sold_products_covered“.sys_created_by	Name des Benutzers, der den Datensatz „Verkauftes Produkt abgedeckt“ erstellt hat. Datentyp: Zeichenfolge
„sold_products_covered“.sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes für das abgedeckte verkaufte Produkt. Datentyp: Zeichenfolge
„sold_products_covered“.sys_id	Sys_id des von diesem Servicevertrag abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
„sold_products_covered“.sys_updated_by	Name des Benutzers, der den Datensatz „Verkauftes Produkt abgedeckt“ zuletzt aktualisiert hat. Datentyp: Zeichenfolge
„sold_products_covered“.sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes „Verkauftes Produkt abgedeckt“. Datentyp: Zeichenfolge
beginnt	Startdatum der Servicevertragsposition. Datentyp: Zeichenfolge Format: jjjj-mm-tt
Status	Aktueller Status der Servicevertragsposition. Gültige Werte: (Groß-/Kleinschreibung beachten) aktiv Abgebrochen Entwurf abgelaufen ausgesetzt Datentyp: Zeichenfolge
sys_created_by	Name des Benutzers, der den Datensatz der Servicevertragsposition erstellt hat. Datentyp: Zeichenfolge
sys_created_on	Datum und Uhrzeit der Erstellung des Datensatzes der Servicevertragsposition. Datentyp: Zeichenfolge
sys_id	Sys_id eines Servicevertrags-Positionsdatensatzes. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge
sys_updated_by	Name des Benutzers, der den Datensatz der Servicevertragsposition zuletzt aktualisiert hat. Datentyp: Zeichenfolge
sys_updated_on	Datum und Uhrzeit der letzten Aktualisierung des Datensatzes der Servicevertragsposition. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen wird.

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract/contractline/fc73d2de89226110f877430a4e008add" \
--request GET \
--header "Accept:application/json" \
--user "username":"password"

Antwort:

{
  "result": {
    "sys_id": "16e451d1d1f53110f8776589fa411f80",
    "sys_created_by": "admin",
    "sys_updated_by": "admin",
    "sys_created_on": "2023-10-09 11:29:47",
    "sys_updated_on": "2023-10-09 11:29:47",
    "name": "CLI",
    "contract": "a4b415d1d1f53110f8776589fa411f20",
    "sold_product": null,
    "starts": "2022-12-03",
    "ends": "",
    "product_offering": null,
    "product_model": null,
    "sold_products_covered": [
      {
        "sys_id": "5ae451d1d1f53110f8776589fa411f81",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:47",
        "sys_updated_on": "2023-10-09 11:29:47",
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "entitlement": null,
        "sold_product": "0df21151d1f53110f8776589fa411f1b",
        "added": "2023-12-03",
        "removed": "2023-12-03"
      }
    ],
    "install_base_items_covered": [],
    "entitlement_characteristics": [
      {
        "sys_id": "dae451d1d1f53110f8776589fa411f82",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:47",
        "sys_updated_on": "2023-10-09 11:29:47",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "entitlement": null,
        "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
        "value": "5",
        "characteristic": "63418db7539e61106bfcddeeff7b1238",
        "type": "coverage"
      }
    ],
    "entitlements": [
      {
        "sys_id": "16e419d1d1f53110f8776589fa411f3c",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:48",
        "sys_updated_on": "2023-10-09 11:29:48",
        "entitlement_name": "ENTL 2",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "state": "active",
        "product_offering": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2022-12-03",
        "end_date": "",
        "entitlement_characteristics": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3e",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "service_contract_line": null,
            "entitlement": "16e419d1d1f53110f8776589fa411f3c",
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage_and_usage"
          }
        ],
        "entitlement_usages": [
          {
            "sys_id": "56e419d1d1f53110f8776589fa411f3f",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "entitlement": "16e419d1d1f53110f8776589fa411f3c",
            "entitlement_characteristic": "1ae419d1d1f53110f8776589fa411f3e",
            "period_start": "2022-12-03",
            "period_end": "",
            "total_units": "5",
            "used_units": "2"
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3d",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
            "entitlement": "16e419d1d1f53110f8776589fa411f3c",
            "sold_product": "da23d151d1f53110f8776589fa411f27",
            "added": "",
            "removed": ""
          }
        ],
        "install_base_items_covered": []
      },
      {
        "sys_id": "9ee451d1d1f53110f8776589fa411f83",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:29:48",
        "sys_updated_on": "2023-10-09 11:29:48",
        "entitlement_name": "ENTL 1",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "contract": "a4b415d1d1f53110f8776589fa411f20",
        "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
        "state": "active",
        "product_offering": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2022-12-03",
        "end_date": "",
        "entitlement_characteristics": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f86",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "service_contract_line": null,
            "entitlement": "9ee451d1d1f53110f8776589fa411f83",
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage_and_usage"
          }
        ],
        "entitlement_usages": [
          {
            "sys_id": "dee451d1d1f53110f8776589fa411f86",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "entitlement": "9ee451d1d1f53110f8776589fa411f83",
            "entitlement_characteristic": "92e451d1d1f53110f8776589fa411f86",
            "period_start": "2022-12-03",
            "period_end": "",
            "total_units": "5",
            "used_units": "3"
          }
        ],
        "sold_products_covered": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f85",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:29:48",
            "sys_updated_on": "2023-10-09 11:29:48",
            "contract": "a4b415d1d1f53110f8776589fa411f20",
            "service_contract_line": "16e451d1d1f53110f8776589fa411f80",
            "entitlement": "9ee451d1d1f53110f8776589fa411f83",
            "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
            "added": "",
            "removed": ""
          }
        ],
        "install_base_items_covered": []
      }
    ]
  } 
}

Servicevertrag – POST /sn_pss_core/servicecontract

Erstellt einen Servicevertragsdatensatz aus einer angegebenen Nutzlast.

Die Service Contract API speichert Daten in verschiedenen Tabellen. Im Folgenden finden Sie die Liste der Tabellen, in denen Datensätze von diesem Endpunkt beim Erstellen eines Servicevertrags erstellt werden:

Merkmal [sn_pss_core_entitlement_characteristic]
Berechtigung [service_entitlement]
Berechtigungsnutzung [sn_pss_core_entitlement_usage]
Verkauftes Produkt abgedeckt [sn_install_base_m2m_contract_sold_product] – Diese Tabelle enthält Informationen für abgedeckte verkaufte Produkte und abgedeckte Installationsbasiselemente.
Servicevertrag [sn_pss_core_service_contract]
Servicevertragsposition [sn_pss_core_service_contract_line]

Der Anforderungstext dieses Endpunkts verweist auf Felder in den folgenden Tabellen. Diese Informationen müssen Ihrer Instanz hinzugefügt werden, bevor diese API verwendet werden kann. Weitere Informationen finden Sie unter Create service contracts.

Account [customer_account]
Merkmalsoption [sn_prd_pm_characteristic_option]
Verbraucher [csm_consumer]
Haushalt [csm_household]

URL-Format

Versionierte URL: /api/sn_pss_core/v1/servicecontract

Standard-URL: /api/sn_pss_core/servicecontract

Unterstützte Anforderungsparameter

Tabelle : 13. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 14. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 15. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
Account	Erforderlich, wenn der Parameter consumer nicht angegeben ist. Sys_id des Account-Datensatzes, zu dem der Servicevertrag gehört. Befindet sich in der Tabelle „Account“ [customer_account]. Datentyp: Zeichenfolge
consumer	Erforderlich, wenn der Parameter account nicht angegeben ist. Sys_id des Verbraucherdatensatzes, zu dem der Servicevertrag gehört. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
endet	Datum, an dem der Servicevertrag endet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Wird nie beendet, bis manuell entfernt wird.
Haushalt	Nur gültig für Verbraucherserviceverträge. Sys_id des Haushalts, der dem Servicevertrag zugeordnet ist. Befindet sich im Haushalt [csm_household]. Datentyp: Zeichenfolge Standard: null (kein Haushalt)
install_base_items_covered	Liste der vom Servicevertrag abgedeckten Installationsbasiselemente. Die Daten in diesem Parameter werden in die Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product] eingefügt. Weitere Informationen zu Installationsbasiselementen Configure install base. Datentyp: Array von Objekten `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
install_base_items_covered.added	Datum, ab dem der zugehörige Servicevertrag das Installationsbasiselement abdeckt. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
install_base_items_covered.install_base	Sys_id des zugeordneten Installationsbasiselement-Datensatzes. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item]. Datentyp: Zeichenfolge
install_base_items_covered.entfernt	Datum, an dem die Abdeckung des Installationsbasiselements durch den zugeordneten Servicevertrag endet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
service_contract_lines	Liste der Servicevertrags-Positionen, die dem Servicevertrag zugeordnet sind. Diese Daten werden in die Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line] eingefügt. Datentyp: Array von Objekten `"service_contract_lines": [ { "ends": "String", "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "product_model": "String", "product_offering": "String", "sold_product": "String", "sold_products_covered": [Array], "starts": "String", "state": "String" } ]`
service_contract_lines.ends	Datum, an dem die Servicevertragsposition endet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Wird nie beendet, bis manuell entfernt wird.
service_contract_lines.entitlements	Liste der Berechtigungen, die dem Servicevertrag zugeordnet werden sollen. Diese Berechtigungen werden in die Tabelle „Berechtigung“ [service_entitlement] eingefügt. Datentyp: Array von Objekten `"entitlements" [ { "account": "String", "consumer": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String" } ]`
service_contract_lines.entitlements.account	Sys_id des Account-Datensatzes, zu dem die Berechtigung gehört. Befindet sich in der Tabelle „Account“ [customer_account]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.consumer	Sys_id des Verbraucherdatensatzes, zu dem die Berechtigung gehört. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
service_contract_lines.berechtigungen.end_date	Enddatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Wird nie beendet, bis manuell entfernt wird.
service_contract_lines.entitlements.entitlement_characteristics	Liste der Merkmale, die der Berechtigung zugeordnet sind. Die Daten in diesem Array werden in die Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic] eingefügt. Datentyp: Array von Objekten `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
service_contract_lines.entitlements.entitlement_characteristics.characteristic	Erforderlich. Sys_id des Merkmalsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.characteristic_option	Sys_id des Merkmalsoptionsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmalsoption“ [sn_prd_pm_characteristic_option]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage	Verwendeter Einheitenwert für das zugeordnete Berechtigungsmerkmal. Diese Daten werden in die Tabelle „Berechtigungsnutzung“ [sn_pss_core_entitlement_usage] eingefügt. Übergeben Sie diesen Parameter nur, wenn sich die entitlement_characteristics unter der -Berechtigung befinden. Datentyp: Objekt `"entitlement_usage": { "usage_units": "String" }`
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.usage_units	Verwendung des zugeordneten Berechtigungsmerkmals. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.type	Typ des Berechtigungsmerkmals. Gültige Werte: Abdeckung Abdeckung und Verwendung Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.value	Erforderlich, wenn der Parameter input_type, der in dem im Parameter entitlement_characteristics.characteristic angegebenen Datensatz enthalten ist, keine `Auswahl`ist. Wert des Merkmals. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_name	Erforderlich. Name der Berechtigung. Datentyp: Zeichenfolge
service_contract_lines.entitlements.household	Wird nur übergeben, wenn die Haushalts-Plugins aktiv sind und der Parameter consumer übergeben wird. Sys_id des Haushaltsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Haushalt“ [csm_household]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered	Liste der Installationsbasiselemente, die von der Berechtigung abgedeckt werden. Die Informationen in diesem Array werden in die Tabelle „Verkauftes Produkt abgedeckt“ [sn_install_base_m2m_contract_sold_product] eingefügt. Datentyp: Array von Objekten `"install_base_items_covered": [ { "added": "String", "removed": "String" } ]`
service_contract_lines.entitlements.install_base_items_covered.hinzugefügt	Datum, an dem das zugeordnete Installationsbasiselement der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
service_contract_lines.entitlements.install_base_items_covered.entfernt	Datum, an dem das zugeordnete Installationsbasiselement aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
service_contract_lines.entitlements.product	Sys_id des Produktmodelldatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.product_offering	Sys_id des Produktangebotsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_entitlement	Sys_id des Datensatzes für verkaufte Produkte, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_products_covered	Liste der verkauften Produkte, die unter die Berechtigung fallen. Datentyp: Array von Objekten `"sold_products_covered": [ { "added": "String", "removed": "String" } ]`
service_contract_lines.entitlements.sold_products_covered.added	Datum, an dem das zugeordnete verkaufte Produkt der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
service_contract_lines.entitlements.sold_products_covered.removed	Datum, an dem das zugeordnete verkaufte Produkt aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
service_contract_lines.berechtigungen.start_date	Erforderlich. Startdatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt
service_contract_lines.entitlements.state	Erforderlich. Aktueller Status der Berechtigung. Gültige Werte: (Groß-/Kleinschreibung beachten) aktiv Abgebrochen Entwurf abgelaufen ausgesetzt Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics	Liste der Merkmale, die der Servicevertragsposition zugeordnet sind. Die Daten in diesem Array werden in die Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic] eingefügt. Datentyp: Array von Objekten `"entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
service_contract_lines.entitlement_characteristics.characteristic	Erforderlich. Sys_id des Merkmalsdatensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.characteristic_option	Sys_id des Merkmaloptionsdatensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Merkmalsoption“ [sn_prd_pm_characteristic_option]. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.entitlement_usage	Verwendeter Einheitenwert für das zugeordnete Merkmal der Servicevertragsposition. Diese Daten werden in die Tabelle „Berechtigungsnutzung“ [sn_pss_core_entitlement_usage] eingefügt. Datentyp: Objekt `"entitlement_usage": { "usage_units": "String" }`
service_contract_lines.entitlement_characteristics.entitlement_usage.usage_units	Verwendung des zugeordneten Berechtigungsmerkmals. Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.type	Typ des Merkmals der Servicevertragsposition. Gültige Werte: Abdeckung Abdeckung und Verwendung Datentyp: Zeichenfolge
service_contract_lines.entitlement_characteristics.value	Erforderlich, wenn der Parameter entitlement_characteristics.type nicht übergeben wird. Wert des Merkmals. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered	Liste der Installationsbasiselemente, die von der Servicevertragsposition abgedeckt werden. Die Daten in diesem Parameter werden in die Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product] eingefügt. Datentyp: Array von Objekten `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
service_contract_lines.install_base_items_covered.hinzugefügt	Datum, an dem das zugeordnete Installationsbasiselement der Servicevertragsposition hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
service_contract_lines.install_base_items_covered.install_base	Sys_id des Installationsbasiselements, das von der Servicevertragsposition abgedeckt wird. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item]. Datentyp: Zeichenfolge
service_contract_lines.install_base_items_covered.entfernt	Datum, an dem die zugeordnete Servicevertragsposition die Abdeckung des Installationsbasiselements beendet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
service_contract_lines.name	Name der Servicevertragsposition. Datentyp: Zeichenfolge
service_contract_lines.product_model	Sys_id des Produkts, das der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model]. Datentyp: Zeichenfolge
service_contract_lines.product_offering	Sys_id des Produktangebotsdatensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
service_contract_lines.sold_product	Sys_id des Datensatzes für verkaufte Produkte, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
service_contract_lines..sold_products_covered	Liste der von der Servicevertragsposition abgedeckten Produkte. Datentyp: Array von Objekten `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
service_contract_lines..sold_products_covered.hinzugefügt	Datum, ab dem die zugehörige Servicevertragsposition das zugehörige Produkt abdeckt. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
service_contract_lines..sold_products_covered.entfernt	Datum, an dem die Abdeckung des zugehörigen Produkts durch die zugeordnete Servicevertragsposition endet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
service_contract_lines..sold_products_covered.sold_product	Sys_id eines Produkts, das der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
service_contract_lines..starts	Erforderlich. Startdatum der Servicevertragsposition. Datentyp: Zeichenfolge Format: jjjj-mm-tt
service_contract_lines..state	Erforderlich. Aktueller Status der Servicevertragsposition. Gültige Werte: (Groß-/Kleinschreibung beachten) aktiv Abgebrochen Entwurf abgelaufen ausgesetzt Datentyp: Zeichenfolge
short_description	Kurzbeschreibung oder Name des Servicevertrags. Datentyp: Zeichenfolge Standard: null (leere Zeichenfolge)
„sold_products_covered“.	Erforderlich, wenn der Parameter install_base_items_covered nicht angegeben ist. Liste der vom Servicevertrag abgedeckten Produkte. Die Daten in diesem Parameter werden in die Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product] eingefügt. Datentyp: Array von Objekten `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]`
„sold_products_covered.added“.	Datum, ab dem der zugehörige Servicevertrag das Produkt abdeckt. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
„sold_products_covered.removed“	Datum, an dem der zugehörige Servicevertrag die Abdeckung des zugehörigen Produkts beendet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
„sold_products_covered.sold_product“.	Sys_id des vom Servicevertrag abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
beginnt	Erforderlich. Datum, an dem der Servicevertrag beginnt. Datentyp: Zeichenfolge Format: jjjj-mm-tt
Status	Erforderlich. Aktueller Status des Servicevertrags. Gültige Werte: (Groß-/Kleinschreibung beachten) aktiv Abgebrochen Entwurf abgelaufen ausgesetzt Datentyp: Zeichenfolge
vendor_contract	Erforderlich. Eindeutiger Bezeichner für einen zugeordneten externen Vertrag. Datentyp: Zeichenfolge

Header

Tabelle : 16. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 17. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 18. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet, und die Datensätze wurden erstellt.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
403	Unzulässig. Der Benutzer hat keine Berechtigung für den Zugriff auf die API.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttextparameter (JSON oder XML)


Name	Beschreibung
install_base_items_covered	Liste der sys_ids der vom Servicevertrag abgedeckten Installationsbasiselemente. Datentyp: Array von Objekten `"install_base_items_covered": [ { "sys_id": "String" } ]`
install_base_items_covered.sys_id	Sys_id des abgedeckten Installationsbasiselements. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
Nummer	Automatisch generierte Servicevertragsnummer. Datentyp: Zeichenfolge
service_contract_lines	Liste der Servicevertrags-Positionen, die dem Servicevertrag zugeordnet sind. Datentyp: Array von Objekten `"service_contract_lines": [ { "entitlements": [Array], "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "name": "String", "sold_products_covered": [Array], "sys_id": "String" } ]`
service_contract_lines.berechtigungen	Liste der Berechtigungen, die dem Servicevertrag zugeordnet sind. Datentyp: Array von Objekten `"entitlements" [ { "entitlement_name": "String", "entitlement_characteristics": [Array], "install_base_items_covered": [Array], "sold_products_covered": [Array], "sys_id": "String" } ]`
service_contract_lines.entitlements.entitlement_name	Name der Berechtigung. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics	Liste der unter der Berechtigung erstellten Berechtigungsmerkmalobjekte. Datentyp: Array von Objekten `"entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage	Berechtigungsnutzungsobjekt, das unter „entitlement_characteristic“ eingefügt wird. Datentyp: Objekt `"entitlement_usage": { "sys_id": "String" }`
service_contract_lines.entitlements.entitlement_characteristics.entitlement_usage.sys_id	Sys_id des Berechtigungsnutzungsdatensatzes. Befindet sich in der Tabelle „Berechtigungsnutzung“ [sn_pss_core_entitlement_usage]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.entitlement_characteristics.sys_id	Sys_id eines Berechtigungsmerkmal-Datensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.install_base_items_covered	Liste der sys_ids der Installationsbasiselemente, die von der Berechtigung abgedeckt werden. Datentyp: Array von Objekten `"install_base_items_covered": [ { "sys_id": "String" } ]`
service_contract_lines.entitlements.install_base_items_covered.sys_id	Sys_id eines Installationsbasiselements, das von der Berechtigung abgedeckt wird. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.entitlements.sold_products_covered	Liste der sys_ids der von der Berechtigung abgedeckten Produkte. Datentyp: Array von Objekten `"sold_products_covered": [ { "sys_id": "String" } ]`
service_contract_lines.entitlements.sold_products_covered.sys_id	Sys_id eines Produkts, das von der Berechtigung abgedeckt wird. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
service_contract_lines.berechtigungen.sys_id	Sys_id des Berechtigungsdatensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
short_description	Kurzbeschreibung oder Name des Servicevertrags. Datentyp: Zeichenfolge
„sold_products_covered“.	Liste der sys_ids der vom Servicevertrag abgedeckten Produkte. Datentyp: Array von Objekten `"sold_products_covered": [ { "sys_id": "String" } ]`
„sold_products_covered“.sys_id	Sys_id eines vom Servicevertrag abgedeckten Produkts. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
sys_id	Sys_id des Servicevertrags-Datensatzes. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen und ein Servicevertrag mit einem Datensatz für das abgedeckte Produkt, einem Datensatz für das abgedeckte Installationsbasiselement und zwei Servicevertragspositionen erstellt wird.

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "account": "4c325111d1f53110f8776589fa411f3d",
  "vendor_contract": "External Reference",
  "starts": "2022-12-03",
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "install_base_items_covered": [
    {
      "install_base": "e2639951d1f53110f8776589fa411f2b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "service_contract_lines": [
    {
      "state": "active",
      "name": "CLI",
      "starts": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "ec235d9dd1b53110f8776589fa411fe2",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "install_base_items_covered": [
        {
          "install_base": "a1731551d1f53110f8776589fa411f8d",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlements": [
        {
          "state": "active",
          "entitlement_name": "ENTL",
          "start_date": "2022-12-03",
          "sold_products_covered": [
            {
              "sold_product": "da23d151d1f53110f8776589fa411f27"
            }
          ],
          "install_base_items_covered": [
            {
              "install_base": "43739151d1f53110f8776589fa411fc1",
              "added": "2023-12-03",
              "removed": "2023-12-03"
            }
          ],
          "entitlement_characteristics": [
            {
              "characteristic": "63418db7539e61106bfcddeeff7b1238",
              "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
              "value": "20",
              "type": "coverage_and_usage",
              "entitlement_usage": {
                "used_units": "3"
              }
            }
          ]
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage"
        }
      ]
    },
    {
      "state": "active",
      "name": "CLI 2",
      "starts": "2022-12-03",
      "sold_products_covered": [
        { 
          "sold_product": "7f23995dd1b53110f8776589fa411f66",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "install_base_items_covered": [
        {
          "install_base": "a483d951d1f53110f8776589fa411fad",
          "added": "2023-12-03",
          "removed": "2023-12-03"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage"
        }
      ]
    }
  ]
} 
--user "username":"password"

Antwort:

{ 
  "result": {
    "sys_id": "d8641151d1f53110f8776589fa411fde",
    "number": "CNTR0010004",
    "short_description": null,
    "sold_products_covered": [
      {
        "sys_id": "9c641d91d1f53110f8776589fa411fb9"
      }
    ], 
    "install_base_items_covered": [
      {
        "sys_id": "d8641d91d1f53110f8776589fa411fba"
      }
    ],
    "service_contract_lines": [
      {
        "sys_id": "d4641d91d1f53110f8776589fa411fbb",
        "name": "CLI",
        "sold_products_covered": [
          {
            "sys_id": "98641d91d1f53110f8776589fa411fbc"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "58641d91d1f53110f8776589fa411fbd"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "e0641d91d1f53110f8776589fa411fbf",
            "entitlement_usage": {}
          }
        ],
        "entitlements": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fc0",
            "entitlement_name": "ENTL",
            "sold_products_covered": [
              {
                "sys_id": "a0641d91d1f53110f8776589fa411fc2"
              }
            ],
            "install_base_items_covered": [
              {
                "sys_id": "e0641d91d1f53110f8776589fa411fc3"
              }
            ],
            "entitlement_characteristics": [
              {
                "sys_id": "a8641d91d1f53110f8776589fa411fd0",
                "entitlement_usage": {
                  "sys_id": "a8641d91d1f53110f8776589fa411fd1"
                }
              }
            ]
          }
        ]
      },
      {
        "sys_id": "e4641d91d1f53110f8776589fa411fd2",
        "name": "CLI 2",
        "sold_products_covered": [
          {
            "sys_id": "e8641d91d1f53110f8776589fa411fd3"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd4"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "a8641d91d1f53110f8776589fa411fd5",
            "entitlement_usage": {}
          }
        ],
        "entitlements": []
      }
    ]
  }
}

Servicevertrag – POST /sn_pss_core/servicecontract/contractline

Erstellt einen Vertragspositionsdatensatz und alle zugehörigen Entitäten.

Dieser Endpunkt speichert Daten in den folgenden Tabellen, wenn die Anforderung verarbeitet wird:

Merkmal [sn_pss_core_entitlement_characteristic]
Berechtigung [service_entitlement]
Berechtigungsnutzung [sn_pss_core_entitlement_usage]
Verkauftes Produkt abgedeckt [sn_install_base_m2m_contract_sold_product] – Diese Tabelle enthält Informationen für abgedeckte verkaufte Produkte und abgedeckte Installationsbasiselemente.
Servicevertragsposition [sn_pss_core_service_contract_line]

URL-Format

Versionierte URL: /api/sn_pss_core/v1/servicecontract/contractline

Standard-URL: /api/sn_pss_core/servicecontract/contractline

Unterstützte Anforderungsparameter

Tabelle : 19. Pfadparameter
Name	Beschreibung
api_version	Optional. Version des Endpunkts, auf den zugegriffen werden soll. Zum Beispiel `v1` oder `v2`. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge

Tabelle : 20. Abfrageparameter
Name	Beschreibung
Keine

Tabelle : 21. Anforderungstextparameter (XML oder JSON)
Name	Beschreibung
contract	Erforderlich. Sys_id des Servicevertrags, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Servicevertrag“ [sn_pss_core_service_contract]. Datentyp: Zeichenfolge
endet	Datum, an dem die Servicevertragsposition endet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Wird nie beendet, bis manuell entfernt wird.
-Berechtigungen	Liste der Berechtigungen, die dem Servicevertrag zugeordnet werden sollen. Diese Berechtigungen werden in die Tabelle „Berechtigung“ [service_entitlement] eingefügt. Datentyp: Array von Objekten `"entitlements" [ { "account": "String", "consumer": "String", "end_date": "String", "entitlement_characteristics": [Array], "entitlement_name": "String", "household": "String", "install_base_items_covered": [Array], "product": "String", "product_offering": "String", "sold_entitlement": "String", "sold_products_covered": [Array], "start_date": "String", "state": "String" } ]`
-Berechtigungen.Konto	Erforderlich, wenn der Parameter consumer nicht übergeben wird. Sys_id des Account-Datensatzes, zu dem die Berechtigung gehört. Befindet sich in der Tabelle „Account“ [customer_account]. Datentyp: Zeichenfolge
Berechtigungen.Verbraucher	Erforderlich, wenn der Parameter account nicht übergeben wird. Sys_id des Verbraucherdatensatzes, zu dem die Berechtigung gehört. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer]. Datentyp: Zeichenfolge
-Berechtigungen.end_date	Enddatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Wird nie beendet, bis manuell entfernt wird.
Berechtigungen.entitlement_characteristics	Liste der Merkmale, die der Berechtigung zugeordnet sind. Die Daten in diesem Array werden in die Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic] eingefügt. Datentyp: Array von Objekten `"entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
Berechtigungen.entitlement_characteristics.characteristic	Erforderlich. Sys_id des Merkmalsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
Berechtigungen.entitlement_characteristics.characteristic_option	Sys_id des Merkmalsoptionsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Merkmalsoption“ [sn_prd_pm_characteristic_option]. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.entitlement_usage	Verwendeter Einheitenwert für das zugeordnete Berechtigungsmerkmal. Diese Daten werden in die Tabelle „Berechtigungsnutzung“ [sn_pss_core_entitlement_usage] eingefügt. Übergeben Sie diesen Parameter nur, wenn sich die entitlement_characteristics unter der -Berechtigung befinden. Datentyp: Objekt `"entitlement_usage": { "usage_units": "String" }`
entitlements.entitlement_characteristics.entitlement_usage.usage_units	Verwendung des zugeordneten Berechtigungsmerkmals. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.type	Typ des Berechtigungsmerkmals. Gültige Werte: Abdeckung Abdeckung und Verwendung Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.value	Erforderlich, wenn der Parameter input_type, der in dem im Parameter entitlement_characteristics.characteristic angegebenen Datensatz enthalten ist, keine `Auswahl`ist. Wert des Merkmals. Datentyp: Zeichenfolge
entitlements.entitlement_name	Erforderlich. Name der Berechtigung. Datentyp: Zeichenfolge
Berechtigungen.Haushalt	Wird nur übergeben, wenn die Haushalts-Plugins aktiv sind und der Parameter consumer übergeben wird. Sys_id des Haushaltsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Haushalt“ [csm_household]. Datentyp: Zeichenfolge
-Berechtigungen.install_base_items_covered	Liste der Installationsbasiselemente, die von der Berechtigung abgedeckt werden. Die Informationen in diesem Array werden in die Tabelle „Verkauftes Produkt abgedeckt“ [sn_install_base_m2m_contract_sold_product] eingefügt. Datentyp: Array von Objekten `"install_base_items_covered": [ { "added": "String", "removed": "String" } ]`
-Berechtigungen.install_base_items_covered.hinzugefügt	Datum, an dem das zugeordnete Installationsbasiselement der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
Berechtigungen.install_base_items_covered.entfernt	Datum, an dem das zugeordnete Installationsbasiselement aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
-Berechtigungen.Produkt	Sys_id des Produktmodelldatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model]. Datentyp: Zeichenfolge
Berechtigungen.product_offering	Sys_id des Produktangebotsdatensatzes, der der Berechtigung zugeordnet ist. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
-Berechtigungen.sold_entitlement	Sys_id des Datensatzes für verkaufte Produkte, der der Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
-Berechtigungen.sold_products_covered	Liste der verkauften Produkte, die unter die Berechtigung fallen. Datentyp: Array von Objekten `"sold_products_covered": [ { "added": "String", "removed": "String" } ]`
Berechtigungen.sold_products_covered.hinzugefügt	Datum, an dem das zugeordnete verkaufte Produkt der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
Berechtigungen.sold_products_covered.entfernt	Datum, an dem das zugeordnete verkaufte Produkt aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
Berechtigungen.start_date	Erforderlich. Startdatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt
Berechtigungen.Status	Erforderlich. Aktueller Status der Berechtigung. Gültige Werte: (Groß-/Kleinschreibung beachten) aktiv Abgebrochen Entwurf abgelaufen ausgesetzt Datentyp: Zeichenfolge
entitlement_characteristics	Liste der Merkmale, die der Servicevertragsposition zugeordnet sind. Die Daten in diesem Array werden in die Tabelle „Merkmal“ [sn_pss_core_entitlement_characteristic] eingefügt. Datentyp: Array von Objekten `"entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ]`
entitlement_characteristics.Merkmal	Erforderlich. Sys_id des Merkmalsdatensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_characteristic]. Datentyp: Zeichenfolge
entitlement_characteristics.characteristic_option	Erforderlich, wenn der Parameter input_type, der in dem im Parameter entitlement_characteristics.characteristic angegebenen Datensatz enthalten ist, auf `choice`festgelegt ist. Sys_id des Merkmaloptionsdatensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Merkmalsoption“ [sn_prd_pm_characteristic_option]. Datentyp: Zeichenfolge
entitlement_characteristics.entitlement_usage	Verwendeter Einheitenwert für das zugeordnete Merkmal der Servicevertragsposition. Diese Daten werden in die Tabelle „Berechtigungsnutzung“ [sn_pss_core_entitlement_usage] eingefügt. Datentyp: Objekt `"entitlement_usage": { "usage_units": "String" }`
entitlement_characteristics.entitlement_usage.used_units	Verwendung des zugeordneten Berechtigungsmerkmals. Datentyp: Zeichenfolge
entitlement_characteristics.type	Typ des Merkmals der Servicevertragsposition. Gültige Werte: Abdeckung Abdeckung und Verwendung Datentyp: Zeichenfolge
entitlement_characteristics.value	Erforderlich, wenn der Parameter entitlement_characteristics.type nicht übergeben wird. Wert des Merkmals. Datentyp: Zeichenfolge
install_base_items_covered	Erforderlich, wenn der Parameter sold_products_covered nicht übergeben wird. Liste der Installationsbasiselemente, die von der Servicevertragsposition abgedeckt werden. Die Daten in diesem Parameter werden in die Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product] eingefügt. Datentyp: Array von Objekten `"install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ]`
install_base_items_covered.hinzugefügt	Datum, an dem das zugeordnete Installationsbasiselement der Servicevertragsposition hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
install_base_items_covered.install_base	Sys_id des Installationsbasiselements, das von der Servicevertragsposition abgedeckt wird. Befindet sich in der Tabelle „Installationsbasiselement“ [sn_install_base_item]. Datentyp: Zeichenfolge
install_base_items_covered.entfernt	Datum, an dem die zugeordnete Servicevertragsposition die Abdeckung des Installationsbasiselements beendet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
Name	Erforderlich. Name der Servicevertragsposition. Datentyp: Zeichenfolge
product_model	Sys_id des Produkts, das der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model]. Datentyp: Zeichenfolge
product_offering	Sys_id des Produktangebotsdatensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Produktangebotstabelle [sn_prd_pm_product_offering]. Datentyp: Zeichenfolge
„sold_product“	Sys_id des Datensatzes für verkaufte Produkte, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product]. Datentyp: Zeichenfolge
„sold_product_covered“.	Erforderlich, wenn der Parameter install_base_items_covered nicht übergeben wird. Liste der von der Servicevertragsposition abgedeckten Produkte. Datentyp: Array von Objekten `"sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ]` Die Daten werden in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product] gespeichert.
„sold_product_covered“hinzugefügt	Datum, ab dem die zugehörige Servicevertragsposition das zugehörige Produkt abdeckt. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum
„sold_product_covered“ wurde entfernt	Datum, an dem die Abdeckung des zugehörigen Produkts durch die zugeordnete Servicevertragsposition endet. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum
„sold_product_covered“.sold_product	Sys_id eines Produkts, das der Servicevertragsposition zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
beginnt	Erforderlich. Startdatum der Servicevertragsposition. Datentyp: Zeichenfolge Format: jjjj-mm-tt
Status	Erforderlich. Aktueller Status der Servicevertragsposition. Gültige Werte: (Groß-/Kleinschreibung beachten) aktiv Abgebrochen Entwurf abgelaufen ausgesetzt Datentyp: Zeichenfolge

Header

Tabelle : 22. Anforderungskopfzeilen
Kopfzeile	Beschreibung
Akzeptieren	Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json
Content-Type	Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml. Standard: application/json

Tabelle : 23. Antwortkopfzeilen
Kopfzeile	Beschreibung
Keine

Statuscodes

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

Tabelle : 24. Statuscodes
Statuscode	Beschreibung
201	Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet, und die Datensätze wurden erstellt.
400	Fehlerhafte Anforderung. Ein fehlerhafter Anforderungstyp oder eine falsch formatierte Anforderung wurde erkannt.
403	Unzulässig. Der Benutzer hat keine Berechtigung für den Zugriff auf die API.
500	Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

Antworttextparameter (JSON oder XML)


Name	Beschreibung
-Berechtigungen	Liste der Berechtigungen, die der Servicevertragsposition zugeordnet sind. Datentyp: Array von Objekten `"entitlements": [ { "entitlement_characteristics": [Array], "entitlement_name": "String", "install_base_items_covered": [Array], "sold_products_covered": [Array], "sys_id": "String" } ]`
Berechtigungen.entitlement_characteristics	Liste der unter der Berechtigung erstellten Berechtigungsmerkmalobjekte. Datentyp: Array von Objekten `"entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
entitlements.entitlement_characteristics.entitlement_usage	Berechtigungsnutzungsobjekt, das unter „entitlement_characteristic“ eingefügt wird. Datentyp: Objekt `"entitlement_usage": { "sys_id": "String" }`
entitlements.entitlement_characteristics.entitlement_usage.sys_id	Sys_id des Berechtigungsnutzungsdatensatzes. Befindet sich in der Tabelle „Berechtigungsnutzung“ [sn_pss_core_entitlement_usage]. Datentyp: Zeichenfolge
entitlements.entitlement_characteristics.sys_id	Sys_id des Berechtigungsmerkmale-Datensatzes. Datentyp: Zeichenfolge
entitlements.entitlement_name	Name der Berechtigung. Datentyp: Zeichenfolge
-Berechtigungen.install_base_items_covered	Liste der sys_ids der Installationsbasiselemente, die von der Berechtigung abgedeckt werden. Datentyp: Array von Objekten `"install_base_items_covered": [ { "sys_id": "String" } ]`
entitlements.install_base_items_covered.sys_id	Sys_id eines Installationsbasiselements, das von der Berechtigung abgedeckt wird. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
-Berechtigungen.sold_products_covered	Liste der sys_ids der von der Berechtigung abgedeckten Produkte. Datentyp: Array von Objekten `"sold_products_covered": [ { "sys_id": "String" } ]`
Berechtigungen.sold_products_covered.sys_id	Sys_id eines Produkts, das von der Berechtigung abgedeckt wird. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
Berechtigungen. sys_id	Sys_id des Berechtigungsdatensatzes, der der Servicevertragsposition zugeordnet ist. Befindet sich in der Berechtigungstabelle [service_entitlement]. Datentyp: Zeichenfolge
entitlement_characteristics	Liste der Berechtigungsmerkmalobjekte, die unter der Servicevertragsposition erstellt wurden. Datentyp: Array von Objekten `"entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ]`
entitlement_characteristics.entitlement_usage	Berechtigungsnutzungsobjekt, das unter „entitlement_characteristic“ eingefügt wird. Datentyp: Objekt `"entitlement_usage": { "sys_id": "String" }`
entitlement_characteristics.entitlement_usage.sys_id	Sys_id des Berechtigungsnutzungsdatensatzes. Befindet sich in der Tabelle „Berechtigungsnutzung“ [sn_pss_core_entitlement_usage]. Datentyp: Zeichenfolge
entitlement_characteristics.sys_id	Sys_id des Berechtigungsmerkmale-Datensatzes. Datentyp: Zeichenfolge
install_base_items_covered	Liste der sys_ids der Installationsbasiselemente, die von der Servicevertragsposition abgedeckt werden. Datentyp: Array von Objekten `"install_base_items_covered": [ { "sys_id": "String" } ]`
install_base_items_covered.sys_id	Sys_id des abgedeckten Installationsbasiselements. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
Name	Name der Servicevertragsposition. Datentyp: Zeichenfolge
„sold_products_covered“.	Liste der sys_ids der Produkte, die von der Servicevertragsposition abgedeckt werden. Datentyp: Array von Objekten `"sold_products_covered": [ { "sys_id": "String" } ]`
„sold_products_covered“.sys_id	Sys_id eines Produkts, das von der Servicevertragsposition abgedeckt wird. Befindet sich in der Tabelle „Verkaufte Produkte abgedeckt“ [sn_install_base_m2m_contract_sold_product]. Datentyp: Zeichenfolge
sys_id	Sys_id eines Servicevertrags-Positionsdatensatzes. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line]. Datentyp: Zeichenfolge

cURL-Anforderung

Das folgende Code-Beispiel zeigt, wie dieser Endpunkt aufgerufen und ein Datensatz für eine Servicevertrags-Position erstellt wird.

curl "https://instance.servicenow.com/api/sn_pss_core/servicecontract/contractline" \
--request POST \
--header "Accept:application/json" \
--data
{
  "state": "active",
  "contract": "a4b415d1d1f53110f8776589fa411f20",
  "name": "CLI",
  "starts": "2022-12-03",
  "sold_products_covered": [
    {
      "sold_product": "0df21151d1f53110f8776589fa411f1b",
      "added": "2023-12-03",
      "removed": "2023-12-03"
    }
  ],
  "entitlements": [
    {
      "state": "active",
      "entitlement_name": "ENTL 1",
      "start_date": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "ec235d9dd1b53110f8776589fa411fe2"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage_and_usage",
          "entitlement_usage": {
            "used_units": "3"
          }
        }
      ]
    },
    {
      "state": "active",
      "entitlement_name": "ENTL 2",
      "start_date": "2022-12-03",
      "sold_products_covered": [
        {
          "sold_product": "da23d151d1f53110f8776589fa411f27"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage_and_usage",
          "entitlement_usage": {
            "used_units": "2"
          }
        }
      ]
    }
  ],
  "entitlement_characteristics": [
    {
      "characteristic": "63418db7539e61106bfcddeeff7b1238",
      "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
      "value": "tyfy6h",
      "type": "coverage"
    }
  ]
}

Antwort:

{
  "result": {
    "sys_id": "16e451d1d1f53110f8776589fa411f80",
    "name": "CLI",
    "sold_products_covered": [
      {
        "sys_id": "5ae451d1d1f53110f8776589fa411f81"
      }
    ],
    "install_base_items_covered": [],
    "entitlement_characteristics": [
      {
        "sys_id": "dae451d1d1f53110f8776589fa411f82",
        "entitlement_usage": {}
      }
    ],
    "entitlements": [
      {
        "sys_id": "9ee451d1d1f53110f8776589fa411f83",
        "entitlement_name": "ENTL 1",
        "sold_products_covered": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f85"
          }
        ],
        "install_base_items_covered": [],
        "entitlement_characteristics": [
          {
            "sys_id": "92e451d1d1f53110f8776589fa411f86",
            "entitlement_usage": {
              "sys_id": "dee451d1d1f53110f8776589fa411f86" 
            }
          }
        ]
      },
      {
        "sys_id": "16e419d1d1f53110f8776589fa411f3c",
        "entitlement_name": "ENTL 2",
        "sold_products_covered": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3d"
          }
        ],
        "install_base_items_covered": [],
        "entitlement_characteristics": [
          {
            "sys_id": "1ae419d1d1f53110f8776589fa411f3e", 
            "entitlement_usage": {
              "sys_id": "56e419d1d1f53110f8776589fa411f3f"
            }
          }
        ]
      }
    ]
  } 
}