---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Berechtigungs-API

# Berechtigungs-API {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 12 Minuten Lesedauer

Die Berechtigung Die API stellt Endpunkte zum Erstellen und Abrufen von Berechtigungsdatensätzen aus einer Instanz bereit.
Berechtigungsprüfungen werden als Teil von Supportservices nach dem Verkauf für Kunden durchgeführt, die ein Produkt erwerben, z. B. eine Appliance oder einen Computer. Berechtigungsprüfungen werden von Service Desk-Mitarbeitern durchgeführt, um zu bestimmen, welche Services Kunden für die von ihnen erworbenen Produkte erhalten können. Verwenden Sie Berechtigung API zum Definieren und Abrufen von Berechtigungen.  
Diese API greift auf Daten in den folgenden Tabellen zu und speichert sie:

* Account \[Customer_Account\]
* Verbraucher \[csm_Consumer\]
* Haushalt \[csm_Haushalt\]
* Installationsbasis \[sn_install_base_item\]
* Produktmodell \[cmdb_model\]
* Produktangebot \[sn_prd_pm_product_offering\]
* Verkauftes Produkt \[sn_install_base_sold_product\]  
Um auf diese API zuzugreifen, müssen die folgenden Plugins in der zugehörigen Instanz aktiviert werden:

* Kundenverträge und Berechtigungen (com.sn_pss_Core)  
* Kundenservice-Installationsbasisverwaltung (com.snc.install_base)
* Produktkatalog-Management Core (com.sn_prd_pm)

Darüber hinaus müssen Sie über die sn_pss_core.pss_integrator-Rolle verfügen, um diese API erfolgreich aufzurufen. Diese API wird in ausgeführt `sn_pss_Core `Namespace.

## Berechtigung -- GET /sn_pss_Core/entitlement/{ID} {#ariaid-title2}

Gibt den angegebenen Berechtigungsdatensatz, die zugehörige Abdeckung und die neuesten Nutzungsdetails zurück.
Im Folgenden finden Sie die Liste der Tabellen, in denen die Berechtigungsdaten gespeichert sind:

* Merkmale \[sn_pss_core_entitlement_characteristic\]
* Berechtigung \[Service_entitlement\]
* Berechtigungsnutzung \[sn_pss_core_entitlement_usage\]
* Abgedecktes verkauftes Produkt \[sn_install_base_m2m_contract_sold_product\]: Diese Tabelle enthält Informationen zu den abgedeckten verkauften Produkten und den abgedeckten Installationsbasiselementen.
{#entitlement-GET-entitlement__ul_hcl_vlb_tzb}

### URL-Format {#entitlement-GET-entitlement__section_jby_sbk_3xb}

Versionierte URL: /api/sn_pss_Core/{api_Version}/Entitlement/{ID}

Standard-URL: /api/sn_pss_Core/entitlement/{ID}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#entitlement-GET-entitlement__entry__2}{#entitlement-GET-entitlement__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| ID | SYS_ID des abzurufenden Berechtigungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigung \[Service_entitlement\] |
[Tabelle : 1. Pfad-Parameter]

{#entitlement-GET-entitlement__entry__8}

| Name | Beschreibung |
|-|-|
| Display_value | Typ der zurückzugebenden Daten. Gültige Werte: * Falsch: Gibt zurück `Wert `Für alle Felder. Beispiel: `„status":„Entwurf" `. * Wahr: Gibt zurück `Display_value `Für alle Felder. Beispiel: `„status":„Entwurf" ` * Alle: Gibt alle Informationen für alle Felder zurück. {#entitlement-GET-entitlement__ul_ohj_gjv_szb} Datentyp: Zeichenfolge Standard: Falsch |
[Tabelle : 2. Abfrageparameter]

{#entitlement-GET-entitlement__entry__12}

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

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#entitlement-GET-entitlement__entry__16}{#entitlement-GET-entitlement__accept-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 4. Anforderungskopfzeilen.]

{#entitlement-GET-entitlement__entry__20}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#entitlement-GET-entitlement__entry__24}{#entitlement-GET-entitlement__entry-200-status-code}{#entitlement-GET-entitlement__entry-400-status-code}{#entitlement-GET-entitlement__entry-403-status-code}{#entitlement-GET-entitlement__entry-404-status-code}{#entitlement-GET-entitlement__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt. |
| 403 | Unzulässig. Der Anwender hat keine Zugriffsrechte für den angegebenen Datensatz. |
| 404 | Nicht gefunden. Das angeforderte Element wurde nicht gefunden. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter

{#entitlement-GET-entitlement__entry__36}

| Name | Beschreibung |
|-|-|
| Account | SYS_ID des Account-Datensatzes, zu dem die Berechtigung gehört. Datentyp: Zeichenfolge Tabelle: Account \[Customer_Account\] |
| consumer | SYS_ID des Verbraucherdatensatzes, zu dem die Berechtigung gehört. Datentyp: Zeichenfolge Tabelle: Verbraucher \[csm_Consumer\] |
| contract | SYS_ID des Vertragsdatensatzes, zu dem die Berechtigung gehört. Datentyp: Zeichenfolge Tabelle: Servicevertrag \[sn_pss_core_service_contract\] |
| end_date | Enddatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Endet nie, bis sie manuell entfernt wurde. |
| Entitlement_characteristics | Liste der Merkmale, die der Berechtigung zugeordnet sind. Datentyp: Array von Objekten "entitlement_characteristics" [ { "characteristic": "String", "characteristic_option": "String", "entitlement": "String", "entitlement_usage": [Array], "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" } ] Gespeichert in: Merkmal \[sn_pss_core_entitlement_characteristic\] |
| Entitlement_characteristics. ​Merkmal | SYS_ID des Merkmalsdatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Merkmal \[sn_prd_pm_characteristic\] |
| Entitlement_characteristics. ​Merkmal_Option | SYS_ID des Merkmalsoptionsdatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Merkmalsoption \[sn_prd_pm_characteristic_option\] |
| Entitlement_characteristics. ​Berechtigung | SYS_ID des zugeordneten Berechtigungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigung \[Service_entitlement\] |
| Entitlement_characteristics. ​Entitlement_usage | Liste der Berechtigungsnutzungen, die dem Berechtigungsmerkmal zugeordnet sind. Datentyp: Array von Objekten "entitlement_usage": [ { "entitlement": "String", "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "service_contract_line": "String", "sys_created_by": "String", "sys_created_on": "String", "sys_id": "String", "sys_updated_by": "String", "sys_updated_on": "String", "total_units": "String", "used_units": "String" } ] |
| Entitlement_characteristics. ​Entitlement_usage. ​Berechtigung | SYS_ID des Berechtigungsdatensatzes, der der Berechtigungsnutzung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Berechtigung \[Service_entitlement\] |
| Entitlement_characteristics. ​Entitlement_usage. ​Entitlement_Merkmal | SYS_ID des Berechtigungsmerkmalsdatensatzes, der der Berechtigungsnutzung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Merkmal \[sn_pss_core_entitlement_characteristic\] |
| Entitlement_characteristics. ​Entitlement_usage. ​Period_end | Enddatum, an dem die Berechtigungsnutzung nicht mehr nachverfolgt wird. Datentyp: Zeichenfolge Format: jjjj-mm-tt |
| Entitlement_characteristics. ​Entitlement_usage. ​Period_Start | Startdatum, an dem die Berechtigungsnutzung nachverfolgt wird. Datentyp: Zeichenfolge Format: jjjj-mm-tt |
| Entitlement_characteristics. ​Entitlement_usage. ​Service_Contract_line | SYS_ID der Servicevertragsposition, zu der die aktuelle Berechtigungsnutzung gehört. Datentyp: Zeichenfolge |
| Entitlement_characteristics. ​Entitlement_usage. ​sys_created_by | Name des Anwenders, der den Berechtigungsnutzungsdatensatz erstellt hat. Datentyp: Zeichenfolge |
| Entitlement_characteristics. ​Entitlement_usage. ​sys_created_on | Datum und Uhrzeit der Erstellung des Berechtigungsnutzungsdatensatzes. Datentyp: Zeichenfolge |
| Entitlement_characteristics. ​Entitlement_usage. ​sys_ID | SYS_ID des Berechtigungsnutzungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigungsnutzung \[sn_pss_core_entitlement_usage\] |
| Entitlement_characteristics. ​Entitlement_usage. ​sys_updated_by | Name des Anwenders, der den Berechtigungsnutzungsdatensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge |
| Entitlement_characteristics. ​Entitlement_usage. ​sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des Berechtigungsnutzungsdatensatzes. Datentyp: Zeichenfolge |
| Entitlement_characteristics. ​Entitlement_usage. ​Total_units | Gesamtabdeckungswert des zugehörigen Berechtigungsmerkmals. Datentyp: Zeichenfolge |
| Entitlement_characteristics. ​Entitlement_usage. ​Used_units | Anzahl der Einheiten, die vom Account oder Verbraucher zwischen verwendet werden period_startUnd period_end. Datentyp: Zeichenfolge |
| Entitlement_characteristics. ​Typ | Typ des Berechtigungsmerkmals. Gültige Werte: * Abdeckung * Abdeckung_und_Nutzung Datentyp: Zeichenfolge |
| Entitlement_characteristics. ​Wert | Wert des Merkmals. Datentyp: Zeichenfolge |
| Entitlement_Name | Name der Berechtigung. Datentyp: Zeichenfolge |
| Haushalt | SYS_ID des Haushaltsdatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Haushalt \[csm_Household\] |
| install_base_items_covered | Liste der Installationsbasiselemente, die unter die Berechtigung fallen. 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" } ] Tabelle: Abgedecktes verkauftes Produkt \[sn_install_base_m2m_contract_sold_product\] |
| install_base_items_covered. ​Hinzugefügt | Datum, an dem das zugehörige Installationsbasiselement der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge |
| install_base_items_covered. ​Vertrag | SYS_ID des Servicevertragsdatensatzes, der dem Installationsbasiselement zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Servicevertrag \[sn_pss_core_service_contract\] |
| install_base_items_covered. ​Install_Base | SYS_ID des Installationsbasiselements, das von der Servicevertragsposition abgedeckt wird. Datentyp: Zeichenfolge Tabelle: Installationsbasiselement \[sn_install_base_item\] |
| install_base_items_covered. ​Entfernt | Datum, an dem das zugehörige Installationsbasiselement aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge |
| install_base_items_covered. ​Berechtigung | SYS_ID des Berechtigungsdatensatzes, der dem Installationsbasiselement zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Berechtigung \[Service_entitlement\] |
| install_base_items_covered. ​Service_Contract_line | SYS_ID des zugehörigen Servicevertragspositionsdatensatzes. Datentyp: Zeichenfolge Tabelle: Servicevertragsposition \[sn_pss_core_service_contract_line\] |
| install_base_items_covered. ​sys_created_by | Name des Anwenders, der den Installationsbasiselement-Datensatz erstellt hat. Datentyp: Zeichenfolge |
| install_base_items_covered. ​sys_created_on | Datum und Uhrzeit der Erstellung des Installationsbasiselementdatensatzes. Datentyp: Zeichenfolge |
| install_base_items_covered. ​sys_ID | SYS_ID des abgedeckten Installationsbasiselements. Datentyp: Zeichenfolge Tabelle: Abgedecktes verkauftes Produkt \[sn_install_base_m2m_contract_sold_product\] |
| install_base_items_covered. ​sys_updated_by | Name des Anwenders, der den Datensatz des Installationsbasiselements zuletzt aktualisiert hat. Datentyp: Zeichenfolge |
| install_base_items_covered. ​sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des Installationsbasiselementdatensatzes. Datentyp: Zeichenfolge |
| Produkt | SYS_ID des Produktmodelldatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktmodell \[cmdb_model\] |
| Product_Offering | SYS_ID des Produktangebotsdatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot \[sn_prd_pm_product_offering\] |
| Sold_entitlement | SYS_ID des Datensatzes für verkaufte Produkte, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Verkauftes Produkt \[sn_install_base_sold_product\] |
| Sold_products_Covered | Liste der abgedeckten Produkte. 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" } ] Tabelle: Abgedecktes verkauftes Produkt \[sn_install_base_m2m_contract_sold_product\] |
| Sold_products_Covered. ​Hinzugefügt | Datum, an dem das zugehörige verkaufte Produkt der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum |
| Sold_products_Covered. ​Vertrag | SYS_ID des Servicevertragsdatensatzes, der dem abgedeckten verkauften Produkt zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Servicevertrag \[sn_pss_core_service_contract\] |
| Sold_products_Covered. ​Berechtigung | SYS_ID des Berechtigungsdatensatzes, der dem abgedeckten verkauften Produkt zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Berechtigung \[Service_entitlement\] |
| Sold_products_Covered.removed | Datum, an dem das zugehörige verkaufte Produkt aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum |
| Sold_products_Covered. ​Service_Contract_line | SYS_ID des Servicevertragspositionsdatensatzes, der dem abgedeckten verkauften Produkt zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Servicevertragsposition \[sn_pss_core_service_contract_line\] |
| Sold_products_Covered. ​Sold_Product | SYS_ID des von der Berechtigung abgedeckten Produkts. Datentyp: Zeichenfolge Tabelle: Verkauftes Produkt \[sn_install_base_sold_product\] |
| Sold_products_Covered. ​sys_created_by | Name des Anwenders, der den Datensatz für das abgedeckte verkaufte Produkt erstellt hat. Datentyp: Zeichenfolge |
| Sold_products_Covered. ​sys_created_on | Datum und Uhrzeit der Erstellung des Datensatzes für verkauftes Produkt. Datentyp: Zeichenfolge |
| Sold_products_Covered. ​sys_ID | SYS_ID des von diesem Servicevertrag abgedeckten Produkts. Datentyp: Zeichenfolge Tabelle: Abgedecktes verkauftes Produkt \[sn_install_base_m2m_contract_sold_product\] |
| Sold_products_Covered. ​sys_updated_by | Name des Anwenders, der den Datensatz des abgedeckten verkauften Produkts zuletzt aktualisiert hat. Datentyp: Zeichenfolge |
| Sold_products_Covered. ​sys_updated_on | Datum und Uhrzeit der letzten Aktualisierung des Datensatzes für verkauftes Produkt. Datentyp: Zeichenfolge |
| start_date | Startdatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt |
| Staat | Aktueller Status der Berechtigung. Gültige Werte: (Groß-/Kleinschreibung beachten) * aktiv * Abgebrochen * Entwurf * abgelaufen * Angehalten Datentyp: Zeichenfolge |
| sys_created_by | Name des Anwenders, der den Berechtigungsdatensatz erstellt hat. Datentyp: Zeichenfolge |
| sys_created_on | Datum und Uhrzeit der Erstellung des Berechtigungsdatensatzes. Datentyp: Zeichenfolge |
| sys_id | SYS_ID des zugeordneten Berechtigungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigung \[Service_entitlement\] |
| sys_updated_by | Name des Anwenders, der den Berechtigungsdatensatz zuletzt aktualisiert hat. Datentyp: Zeichenfolge |
| sys_updated_on | Datum und Uhrzeit der Erstellung des Berechtigungsdatensatzes. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Das folgende Beispiel zeigt, wie dieser Endpunkt aufgerufen wird, um eine Berechtigungsvorlage abzurufen.

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

Antwort:

    {
      "result": {
        "sys_id": "5a651515d1f53110f8776589fa411f7b",
        "sys_created_by": "admin",
        "sys_updated_by": "admin",
        "sys_created_on": "2023-10-09 11:31:59",
        "sys_updated_on": "2023-10-09 11:31:59",
        "entitlement_name": "indep entl",
        "account": "4c325111d1f53110f8776589fa411f3d",
        "consumer": null,
        "household": null,
        "contract": null,
        "service_contract_line": null,
        "state": "active",
        "product_offering": null,
        "sold_entitlement": null,
        "product": null,
        "start_date": "2023-10-03",
        "end_date": "2024-12-03",
        "sold_products_covered": [
          {
            "sys_id": "d6651515d1f53110f8776589fa411f7c",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:31:59",
            "sys_updated_on": "2023-10-09 11:31:59",
            "contract": null,
            "service_contract_line": null,
            "entitlement": "5a651515d1f53110f8776589fa411f7b",
            "sold_product": "0df21151d1f53110f8776589fa411f1b",
            "added": "",
            "removed": ""
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "12651515d1f53110f8776589fa411f7d",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:31:59",
            "sys_updated_on": "2023-10-09 11:31:59",
            "contract": null,
            "service_contract_line": null,
            "entitlement": "5a651515d1f53110f8776589fa411f7b",
            "install_base": "e2639951d1f53110f8776589fa411f2b",
            "added": "",
            "removed": ""
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "12651515d1f53110f8776589fa411f7e",
            "sys_created_by": "admin",
            "sys_updated_by": "admin",
            "sys_created_on": "2023-10-09 11:31:59",
            "sys_updated_on": "2023-10-09 11:31:59",
            "service_contract_line": null,
            "entitlement": "5a651515d1f53110f8776589fa411f7b",
            "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
            "value": "5",
            "characteristic": "63418db7539e61106bfcddeeff7b1238",
            "type": "coverage_and_usage",
            "entitlement_usage": [
              {
                "sys_id": "de651515d1f53110f8776589fa411f7e",
                "sys_created_by": "admin",
                "sys_updated_by": "admin",
                "sys_created_on": "2023-10-09 11:31:59",
                "sys_updated_on": "2023-10-09 11:31:59",
                "entitlement": "5a651515d1f53110f8776589fa411f7b",
                "service_contract_line": null,
                "entitlement_characteristic": "12651515d1f53110f8776589fa411f7e",
                "period_start": "2023-10-03",
                "period_end": "2024-12-03",
                "total_units": "5",
                "used_units": "25"
              }
            ]
          }
        ]
      }
    }

## Berechtigung -- NACH /sn_pss_Core/entitlement {#ariaid-title3}

Erstellt einen Berechtigungsdatensatz und alle zugehörigen Detaildatensätze.
Im Folgenden finden Sie die Liste der Tabellen, in denen die Berechtigungsdaten gespeichert sind:

* Merkmal \[sn_pss_core_entitlement_characteristic\]
* Berechtigung \[Service_entitlement\]
* Berechtigungsnutzung \[sn_pss_core_entitlement_usage\]
* Abgedeckte verkaufte Produkte \[sn_install_base_m2m_contract_sold_product\]: Diese Tabelle enthält Informationen zu den abgedeckten verkauften Produkten und den abgedeckten Installationsbasiselementen.

### URL-Format

Versionierte URL: /api/sn_pss_Core/{api_Version}/berechtigung

Standard-URL: /api/sn_pss_Core/entitlement  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#entitlement-POST-entitlement__entry__2}{#entitlement-POST-entitlement__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
[Tabelle : 7. Pfad-Parameter]

{#entitlement-POST-entitlement__entry__6}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 8. Abfrageparameter]

{#entitlement-POST-entitlement__entry__10}

| Name | Beschreibung |
|-|-|
| Account | Erforderlich, wenn consumerParameter wurde nicht übergeben. SYS_ID des Account-Datensatzes, zu dem die Berechtigung gehört. Datentyp: Zeichenfolge Tabelle: Account \[Customer_Account\] |
| consumer | Erforderlich, wenn accountParameter wurde nicht übergeben. SYS_ID des Verbraucherdatensatzes, zu dem die Berechtigung gehört. Datentyp: Zeichenfolge Tabelle: Verbraucher \[csm_Consumer\] |
| end_date | Enddatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Endet nie, bis sie manuell entfernt wurde. |
| Entitlement_characteristics | Liste der Merkmale, die der Berechtigung zugeordnet sind. Datentyp: Array von Objekten "entitlement_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "entitlement_usage": {Object}, "type": "String", "value": "String" } ] Gespeichert in: Merkmal \[sn_pss_core_entitlement_characteristic\] |
| Entitlement_characteristics. ​Merkmal | Erforderlich. SYS_ID des Merkmalsdatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Merkmal \[sn_prd_pm_characteristic\] |
| Entitlement_characteristics. ​Merkmal_Option | SYS_ID des Merkmalsoptionsdatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Merkmalsoption \[sn_prd_pm_characteristic_option\] |
| Entitlement_characteristics. ​Entitlement_usage | Verwendeter Einheitenwert für das zugehörige Berechtigungsmerkmal. Übergeben Sie diesen Parameter nur, wenn sich die entitlement_characteristics unter der Berechtigung befinden. Datentyp: Objekt "entitlement_usage": { "used_units": "String" } Gespeichert in: Berechtigungsnutzung \[sn_pss_core_entitlement_usage\] |
| Entitlement_characteristics. ​Entitlement_usage. ​Usage_units | Verwendung des zugehörigen Berechtigungsmerkmals. Datentyp: Zeichenfolge |
| Entitlement_characteristics. ​Typ | Typ des Berechtigungsmerkmals. Gültige Werte: * Abdeckung * Abdeckung_und_Nutzung Datentyp: Zeichenfolge |
| Entitlement_characteristics. ​Wert | Erforderlich, wenn input_typeParameter, der in dem in angegebenen Datensatz enthalten ist entitlement_characteristics.characteristicParameter, ist nicht `Auswahl `. Wert des Merkmals. Datentyp: Zeichenfolge |
| Entitlement_Name | Erforderlich. Name der Berechtigung. Datentyp: Zeichenfolge |
| Haushalt | Nur bestanden, wenn die Haushalts-Plugins aktiv sind und consumerParameter wird übergeben. SYS_ID des Haushaltsdatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Haushalt \[csm_Household\] |
| install_base_items_covered | Liste der Installationsbasiselemente, die unter die Berechtigung fallen. Die Informationen in diesem Array werden in die Tabelle „abgedecktes verkauftes Produkt" \[sn_install_base_m2m_contract_sold_product\] eingefügt. Datentyp: Array von Objekten "install_base_items_covered": [ { "added": "String", "install_base": "String", "removed": "String" } ] Für weitere Informationen zu Installationsbasiselementen [Configure install base](https://www.servicenow.com/docs/access?context=configure-install-base&version=yokohama&pubname=yokohama-customer-service-management&ft:locale=en-US). |
| install_base_items_covered.added | Datum, an dem das zugehörige Installationsbasiselement der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum |
| install_base_items_covered. ​Install_Base | SYS_ID des zugehörigen Installationsbasiselementdatensatzes. Datentyp: Zeichenfolge Tabelle: Installationsbasiselement \[sn_install_base_item\] |
| install_base_items_covered. ​Entfernt | Datum, an dem das zugehörige Installationsbasiselement aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum |
| Produkt | SYS_ID des Produktmodelldatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktmodell \[cmdb_model\] |
| Product_Offering | SYS_ID des Produktangebotsdatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot \[sn_prd_pm_product_offering\] |
| Sold_entitlement | SYS_ID des Datensatzes für verkaufte Produkte, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Verkauftes Produkt \[sn_install_base_sold_product\] |
| Sold_products_Covered | Liste der von der Berechtigung abgedeckten Produkte. Datentyp: Array von Objekten "sold_products_covered": [ { "added": "String", "removed": "String", "sold_product": "String" } ] Gespeichert in: Abgedecktes verkauftes Produkt \[sn_install_base_m2m_contract_sold_product\] |
| Sold_products_Covered.added | Datum, an dem das zugehörige verkaufte Produkt der Berechtigung hinzugefügt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Aktuelles Datum |
| Sold_products_Covered.removed | Datum, an dem das zugehörige verkaufte Produkt aus der Berechtigung entfernt wurde. Datentyp: Zeichenfolge Format: jjjj-mm-tt Standard: Kein Enddatum |
| sold_products_covered.sold_product | SYS_ID des von der Berechtigung abgedeckten Produkts. Datentyp: Zeichenfolge Tabelle: Verkauftes Produkt \[sn_install_base_sold_product\] |
| start_date | Erforderlich. Startdatum der Berechtigung. Datentyp: Zeichenfolge Format: jjjj-mm-tt |
| Staat | Erforderlich. Aktueller Status der Berechtigung. Gültige Werte: (Groß-/Kleinschreibung beachten) * aktiv * Abgebrochen * Entwurf * abgelaufen * Angehalten Datentyp: Zeichenfolge |
[Tabelle : 9. Anforderungstext-Parameter (JSON)]

### Header {#entitlement-POST-entitlement__section_bdz_2rp_4xb}

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#entitlement-POST-entitlement__table_cdz_2rp_4xb__entry__2}{#entitlement-POST-entitlement__accept-RESTAPI}{#entitlement-POST-entitlement__content_type-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
| Inhaltstyp | Datenformat des Anforderungstexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 10. Anforderungskopfzeilen.]

{#entitlement-POST-entitlement__table_cdz_2rp_4xb} {#entitlement-POST-entitlement__table_ddz_2rp_4xb__entry__2}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. Antwort-Header]

{#entitlement-POST-entitlement__table_ddz_2rp_4xb}

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#entitlement-POST-entitlement__entry__72}{#entitlement-POST-entitlement__entry-400-status-code}{#entitlement-POST-entitlement__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 201 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet, und die Datensätze wurden erstellt. |
| 400 | Ungültige Anforderung. Ein ungültiger Anforderungstyp oder eine fehlerhafte Anforderung wurde erkannt. |
| 403 | Unzulässig. Der Anwender hat keine Berechtigung zum Zugriff auf die API. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 12. Statuscodes]

### Antworttext-Parameter (JSON)

{#entitlement-POST-entitlement__entry__82}

| Name | Beschreibung |
|-|-|
| Entitlement_characteristics | Liste der Berechtigungsmerkmalsobjekte , die unter der Berechtigung erstellt wurden. Datentyp: Array von Objekten "entitlement_characteristics" [ { "entitlement_usage": {Object}, "sys_id": "String" } ] |
| Entitlement_characteristics. ​Entitlement_usage | Berechtigungsnutzungsobjekt, das unter „entitlement_Merkmal" eingefügt wurde. Datentyp: Objekt "entitlement_usage": { "sys_id": "String" } |
| Entitlement_characteristics. ​Entitlement_usage. ​sys_ID | SYS_ID des Berechtigungsnutzungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigungsnutzung \[sn_pss_core_entitlement_usage\] |
| Entitlement_characteristics. ​sys_ID | SYS_ID eines Berechtigungsmerkmalsdatensatzes, der der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Merkmal \[sn_pss_core_entitlement_characteristic\] |
| Entitlement_Name | Name der Berechtigung. Datentyp: Zeichenfolge |
| install_base_items_covered | Liste der sys_IDs der Installationsbasiselemente, die unter die Berechtigung fallen. Datentyp: Array von Objekten "install_base_items_covered": [ { "sys_id": "String" } ] |
| install_base_items_covered. ​sys_ID | SYS_ID eines Installationsbasiselements, die von der Berechtigung abgedeckt werden. Datentyp: Zeichenfolge Tabelle: Abgedecktes verkauftes Produkt \[sn_install_base_m2m_contract_sold_product\] |
| Sold_prodocts_Covered | Liste der sys_IDs der von der Berechtigung abgedeckten Produkte. Datentyp: Array von Objekten "sold_products_covered": [ { "sys_id": "String" } ] |
| Sold_products_Covered. ​sys_ID | SYS_ID eines Produkts, das der Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Abgedecktes verkauftes Produkt \[sn_install_base_m2m_contract_sold_product\] |
| sys_id | SYS_ID des zugeordneten Berechtigungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigung \[Service_entitlement\] |
[ ]

### Curl-Anforderung

Das folgende Beispiel zeigt, wie eine Berechtigungsvorlage erstellt wird.

    curl "https://instance.servicenow.com/api/sn_pss_core/entitlement" \
    --request POST \
    --header "Accept:application/json" \
    --data
    {
      "state": "active",
      "entitlement_name": "indep entl",
      "account": "4c325111d1f53110f8776589fa411f3d",
      "start_date": "2023-10-03",
      "end_date": "2024-12-03",
      "sold_products_covered": [
        {
          "sold_product": "0df21151d1f53110f8776589fa411f1b"
        }
      ], 
      "install_base_items_covered": [
        {
          "install_base": "e2639951d1f53110f8776589fa411f2b"
        }
      ],
      "entitlement_characteristics": [
        {
          "characteristic": "63418db7539e61106bfcddeeff7b1238",
          "characteristic_option": "495149b7539e61106bfcddeeff7b1262",
          "value": "20",
          "type": "coverage_and_usage",
          "entitlement_usage": {
            "used_units": "25"
          } 
        }
      ]
    }

Antwort:

    {
      "result": {
        "sys_id": "5a651515d1f53110f8776589fa411f7b",
        "entitlement_name": "indep entl",
        "sold_products_covered": [
          {
            "sys_id": "d6651515d1f53110f8776589fa411f7c"
          }
        ],
        "install_base_items_covered": [
          {
            "sys_id": "12651515d1f53110f8776589fa411f7d"
          }
        ],
        "entitlement_characteristics": [
          {
            "sys_id": "12651515d1f53110f8776589fa411f7e",
            "entitlement_usage": {
              "sys_id": "de651515d1f53110f8776589fa411f7e"
            }
          }
        ]
      }
    }


