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


---

# Überprüfen Sie die API für Berechtigungen

# Überprüfen Sie die API für Berechtigungen {#ariaid-title1}

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

Die Überprüfen Sie die API für Berechtigungen Stellt Endpunkte bereit, mit denen Sie eine Liste gültiger Berechtigungen, Details zu den Merkmalen von Berechtigungen und die neuesten Nutzungsinformationen einer Berechtigung abrufen können.
Um auf diese API zuzugreifen, muss das Plugin „Berechtigungsverifizierung" (com.sn_ent_verify) aktiviert sein.

Diese API wird in bereitgestellt `sn_ent_Verifizieren `Namespace.

Der aufrufende Anwender muss über die Rolle „sn_pss_core.pss_integrator" verfügen.  
Die REST-Endpunkte dieser API-Abfragedaten aus den folgenden Tabellen:

* Account \[Customer_Account\]
* Verbraucher \[csm_Consumer\]
* Berechtigung \[Service_entitlement\]
* Berechtigungsmerkmal \[sn_pss_core_entitlement_characteristic\]
* Berechtigungsnutzungen \[sn_pss_core_entitlement_usage\]
* Haushalt \[csm_Haushalt\]
* Installationsbasis \[sn_install_base_item\]
* Produktmodell \[cmdb_model\]
* Produktangebot \[sn_prd_pm_product_offering\]
* Produktspezifikation \[sn_prd_pm_product_specification\]
* Servicevertrag \[sn_pss_core_service_contract\]
* Servicevertragsposition \[sn_pss_core_service_contract_line\]
* Verkauftes Produkt \[sn_install_base_sold_product\]

## Berechtigungen verifizieren -- RUFT /sn_ent_verify/verifyberechtigungen AB {#ariaid-title2}

Gibt die gültigen Berechtigungsdatensätze basierend auf dem angegebenen Filter zurück.
Sie können Berechtigungen filtern basierend auf:

* Account
* Verbraucher
* Vertrag
* Haushalt
* Installationsbasis
* Produktmodell
* Produktangebot
* Produktspezifikation
* Servicevertragszeile
* Berechtigung verkauft
* Verkauftes Produkt
* Status
{#ver_entitle-GET-verify__ul_zgk_xd2_pzb}Mindestens müssen Sie entweder den Account oder den Verbraucher angeben, nach dem die Berechtigungen gefiltert werden sollen.

Wenn mehrere Filterparameter übergeben werden, wendet der Endpunkt an `UND `Operator für die Parameter. Beispiel: Wenn Sie Filterparameter wie übergeben `„Account = Boxeo" `Und `„Status = Entwurf" `, Der Endpunkt gibt alle Berechtigungen mit Account = boxeo zurück `UND `status = Entwurf.

Sie können Paginierung für die Rückgabeergebnisse implementieren, indem Sie die System-Paginierungsparameter übergeben sysparm_offsetUnd sysparm_limit. Standardmäßig sysparm_offsetIst auf 0 und festgelegt sysparm_limitIst auf 10 festgelegt. Wenn also nach dem Anwenden des Filters 100 Berechtigungen die Kriterien erfüllen, enthält die Antwort die ersten 10 Berechtigungen. Sie können diese Werte ändern, indem Sie sie im Endpunktaufruf übergeben.

### URL-Format

Versionierte URL: /api/sn_ent_verify/{api_Version}/verifyberechtigungen

Standard-URL: /api/sn_ent_verify/verifyberechtigungen  
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

{#ver_entitle-GET-verify__entry__2}{#ver_entitle-GET-verify__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 |
| Sysparm_limit | Optional. Maximale Anzahl zurückzugebender Datensätze. Für Anforderungen, die diese Anzahl von Datensätzen überschreiten, verwenden Sie sysparm_offsetParameter zum Paginieren des Datensatzabrufs. In der Antwort der boolesche Parameter hasMoreWird zurückgegeben. Gibt an, ob weitere zurückzugebende Datensätze vorhanden sind, die die Filterkriterien erfüllen. Datentyp: Zahl Standard: 10 Maximum: 100 |
| Sysparm_Offset | Optional. Startdatensatzindex, für den mit dem Abrufen von Datensätzen begonnen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktionalität ermöglicht den Abruf aller Datensätze, unabhängig von der Anzahl der Datensätze, in kleinen verwaltbaren Blöcken. Beispiel: Wenn Sie diesen Endpunkt zum ersten Mal aufrufen, sysparm_offsetIst auf „0" festgelegt. Um einfach alle verfügbaren Datensätze durchzublättern, verwenden Sie `Sysparm_Offset=sysparm_Offset+sysparm_limit `, Bis Sie das Ende aller Datensätze erreichen. Übergeben Sie keine negative Zahl in sysparm_offsetParameter. Datentyp: Zahl Standard: 0 |
[Tabelle : 1. Pfad-Parameter]

{#ver_entitle-GET-verify__entry__10}{#ver_entitle-GET-verify__csm-display_value-entry}

| Name | Beschreibung |
|-|-|
| Account | Entweder accountOder consumerParameter muss übergeben werden. Sie schließen sich gegenseitig aus. SYS_ID des Account-Datensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Keine Tabelle: Account \[Customer_Account\] |
| consumer | Entweder accountOder consumerParameter muss übergeben werden. Sie schließen sich gegenseitig aus. SYS_ID des Verbraucherdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Keine Tabelle: Verbraucher \[csm_Consumer\] |
| contract | SYS_ID des Vertragsdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Keine Tabelle: Vertrag \[sn_pss_core_service_contract\] |
| Display_value | Kennzeichnung, die angibt, ob der zugehörige Feldwert, der Anzeigewert oder beides zurückgegeben werden soll. Gültige Werte: * Wahr: Antwort enthält nur die Anzeigewerte der Felder. Beispiel: `„status": „Entwurf" `. * Falsch: Die Antwort enthält nur die Werte der Felder. Beispiel: `„status": „Entwurf" `. * Alle: Antwort enthält alle Informationen für die Felder. Zum Beispiel: "state": { "name": "state", "label": "State", "value": "draft", "display_value": "true", "type": "string" } Datentyp: Zeichenfolge Standard: Falsch |
| Haushalt | SYS_ID des Haushaltsdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Keine Tabelle: Haushalt \[csm_Household\] |
| Install_Base | SYS_ID des Installationsbasisdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Der Endpunkt verwendet die sys_ID des Installationsbasisdatensatzes, um die Tabelle „abgedecktes verkauftes Produkt" \[sn_install_base_m2m_contract_sold_product\] zu durchsuchen, um alle Berechtigungen zurückzugeben, die von der zugehörigen Installationsbasis abgedeckt werden. Datentyp: Zeichenfolge Standard: Keine Tabelle: Installationsbasis \[sn_install_base_item\] |
| Produkt | SYS_ID des Produktdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Keine Tabelle: Produktmodell \[cmdb_model\] |
| Product_Offering | SYS_ID des Produktangebotsdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Keine Tabelle: Produktangebot \[sn_prd_pm_product_offering\] |
| Product_Specification | SYS_ID des Produktspezifikationsdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Keine Tabelle: Produktspezifikation \[sn_prd_pm_product_specification\] |
| Service_Contract_line | SYS_ID des Servicevertragspositionsdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Keine Tabelle: Servicevertragsposition \[sn_pss_core_service_contract_line\] |
| Sold_entitlement | SYS_ID des verkauften Berechtigungsdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Datentyp: Zeichenfolge Standard: Keine Tabelle: Verkauftes Produkt \[sn_install_base_sold_product\] |
| Sold_Product | SYS_ID des Datensatzes des verkauften Produkts, für den Berechtigungsdatensätze zurückgegeben werden sollen. Der Endpunkt verwendet die sys_ID des Datensatzes „verkauftes Produkt", um die Tabelle „abgedecktes verkauftes Produkt" \[sn_install_base_m2m_contract_sold_product\] zu durchsuchen, um alle Berechtigungen zurückzugeben, die vom zugehörigen verkauften Produkt abgedeckt sind. Datentyp: Zeichenfolge Standard: Keine Tabelle: Verkauftes Produkt \[sn_install_base_sold_product\] |
| Staat | Status der zurückzugebenden Berechtigungen. Gültige Werte: * aktiv * Abgebrochen * Entwurf * abgelaufen * Angehalten {#ver_entitle-GET-verify__ul_vch_twr_pzb} Datentyp: Zeichenfolge Standard: Alle |
[Tabelle : 2. Abfrageparameter]

{#ver_entitle-GET-verify__entry__38}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Anforderungstext-Parameter (XML oder 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.").
{#ver_entitle-GET-verify__entry__42}{#ver_entitle-GET-verify__accept-RESTAPI}

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

{#ver_entitle-GET-verify__entry__46}

| 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.").
{#ver_entitle-GET-verify__entry__50}{#ver_entitle-GET-verify__entry-200-status-code}{#ver_entitle-GET-verify__entry-403-status-code}{#ver_entitle-GET-verify__entry-404-status-code}{#ver_entitle-GET-verify__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 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 (JSON oder XML)

{#ver_entitle-GET-verify__entry__60}

| Name | Beschreibung |
|-|-|
| Berechtigungen | Liste der Berechtigungen, die den übergebenen Filterkriterien entsprechen. Datentyp: Array von Objekten "entitlements": [ { "account": "String", "consumer": "String", "contract": "String", "end_date": "String", "entitlement_name": "String", "household": "String", "product": "String", "product_offering": "String", "product_specification": "String", "service_contract_line": "String", "sold_entitlement": "String", "start_date": "String", "state": "String", "sys_id": "String" } ] |
| Berechtigungen.Account | SYS_ID des Account-Datensatzes, der dieser Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Account \[Customer_Account\] |
| Berechtigungen.Verbraucher | SYS_ID des Verbraucherdatensatzes, der dieser Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Verbraucher \[csm_Consumer\] |
| Berechtigungen.Vertrag | SYS_ID des Vertragsdatensatzes, der dieser Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Vertrag \[sn_pss_core_service_contract\] |
| Berechtigungen.end_date | Wert des Felds „Enddatum" im zugehörigen Berechtigungsdatensatz. Datentyp: Zeichenfolge |
| Berechtigungen.Entitlement_Name | Name der Berechtigung. Datentyp: Zeichenfolge |
| Berechtigungen.Haushalt | SYS_ID des Haushaltsdatensatzes, der dieser Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Haushalt \[csm_Household\] |
| entitlements.product | SYS_ID des Produktdatensatzes, der dieser Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktmodell \[cmdb_model\] |
| entitlements.product_offering | SYS_ID des Produktangebotsdatensatzes, der dieser Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktangebot \[sn_prd_pm_product_offering\] |
| entitlements.product_specification | SYS_ID des Produktspezifikationsdatensatzes, der dieser Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Produktspezifikation \[sn_prd_pm_product_specification\] |
| entitlements.service_contract_line | SYS_ID des Servicevertragspositionsdatensatzes, der dieser Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Servicevertragsposition \[sn_pss_core_service_contract_line\] |
| Entitlements.sold_entitlement | SYS_ID des verkauften Berechtigungsdatensatzes, der dieser Berechtigung zugeordnet ist. Datentyp: Zeichenfolge Tabelle: Verkauftes Produkt \[sn_install_base_sold_product\] |
| Berechtigungen.Start_date | Wert des Felds Startdatum im zugehörigen Berechtigungsdatensatz. Datentyp: Zeichenfolge |
| Berechtigungen.Status | Status des Berechtigungsdatensatzes. Mögliche Werte: * aktiv * Abgebrochen * Entwurf * abgelaufen * Angehalten Datentyp: Zeichenfolge |
| Entitlements.sys_ID | SYS_ID des Berechtigungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigung \[Service_entitlement\] |
| Fehler | Beschreibt den aufgetretenen Fehler. Datentyp: Objekt "error": { "detail": "String", "message": "String" } Beispiele für Fehlerantworten: * Fehlermeldung: Seitengröße -20 ist ungültig. Die Seitengröße muss eine Ganzzahl zwischen 1 und 100 seinFehlerbedingung: Ungültig sysparm_limitParameter übergeben. Die sysparm_limitParameter muss zwischen 1 und 100 liegen. * Fehlermeldung: Seiten-Offset -23 ist ungültig. Offset muss eine Ganzzahl größer oder gleich 0 seinFehlerbedingung: Ungültig sysparm_offsetParameter übergeben. Die sysparm_offsetParameter muss eine ganze Zahl sein. * Fehlermeldung: Ungültiger Abfrageparameter -- AktFehlerbedingung: Ungültiger Abfrageparameter, „accnt", wurde übergeben. Parameter muss „Account" sein. * Fehlermeldung: Ungültiger Auswahlwert: status = drftFehlerbedingung: Ungültiger Wert, „drft", wurde übergeben. Parameterwert muss „Entwurf" sein. |
| error.detail | Detaillierte Informationen dazu, warum der Endpunktaufruf fehlgeschlagen ist. Datentyp: Zeichenfolge |
| Fehler.Nachricht | Nachricht, die den Fehler allgemein beschreibt. Datentyp: Zeichenfolge |
| hasMore | Kennzeichnung, die angibt, ob weitere Berechtigungsdatensätze zurückgegeben werden sollen. Mögliche Werte: * Wahr: Weitere zurückzugebende Berechtigungsdatensätze. * Falsch: Keine weiteren Berechtigungsdatensätze. Datentyp: Boolescher Wert |
| Status | Status des Endpunktaufrufs. Mögliche Werte: * Fehler: Beim Verarbeiten der Anforderung ist ein Fehler aufgetreten. * Erfolg: Der Anruf wurde erfolgreich verarbeitet. Datentyp: Zeichenfolge |
| Sysparm_limit | Wenn sysparm_limitParameter wurden im Endpunktaufruf übergeben. Sie enthalten den übergebenen Wert, andernfalls den Standardwert. Datentyp: Zahl |
| Sysparm_Offset | Wenn sysparm_offsetParameter wurden im Endpunktaufruf übergeben. Sie enthalten den übergebenen Wert, andernfalls den Standardwert. Datentyp: Zahl |
[ ]

### Curl-Anforderung

Das folgende Codebeispiel zeigt, wie Berechtigungen für einen bestimmten Account zurückgegeben werden.

    curl "https://instance.service-now.com/api/sn_ent_verify/verifyentitlements?account=9e2fd2ee11b43110f877366201dea674" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

Ergebnisse zurückgeben:

    {
      "result": {
        "sysparm_offset": "0",
        "sysparm_limit": "10",
        "has_more": "false",
        "entitlements": [
          {
            "sys_id": "38374bf251e27110f877bf82d3ddf30a",
            "entitlement_name": "test ent",
            "account": "9e2fd2ee11b43110f877366201dea674",
            "consumer": null,
            "household": null,
            "contract": "0e1747f251e27110f877bf82d3ddf31c",
            "service_contract_line": "da278fb251e27110f877bf82d3ddf3b7",
            "state": "active",
            "product_offering": null,
            "product_specification": null,
            "sold_entitlement": null,
            "product": null,
            "start_date": "2023-11-21",
            "end_date": ""
          },
          {
            "sys_id": "e6ad4e4151723d10f877bf82d3ddf3fb",
            "entitlement_name": "tets entitlement",
            "account": "9e2fd2ee11b43110f877366201dea674",
            "consumer": null,
            "household": null,
            "contract": "0e1747f251e27110f877bf82d3ddf31c",
            "service_contract_line": "e79dce4151723d10f877bf82d3ddf31d",
            "state": "active",
            "product_offering": null,
            "product_specification": null,
            "sold_entitlement": null,
            "product": null,
            "start_date": "2023-11-21",
            "end_date": ""
          }
        ],
        "status": "success"
      }
    }

### Curl-Anforderung

Das folgende Codebeispiel zeigt, wie Berechtigungen für einen bestimmten Account und eine bestimmte Servicevertragsposition zurückgegeben werden.

    curl "https://instance.service-now.com/api/sn_ent_verify/verifyentitlements?service_contract_line=e79dce4151723d10f877bf82d3ddf31d&account=9e2fd2ee11b43110f877366201dea674" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

Ergebnisse zurückgeben:

    {
      "result": {
        "sysparm_offset": "0",
        "sysparm_limit": "10",
        "has_more": "false",
        "entitlements": [
          {
            "sys_id": "e6ad4e4151723d10f877bf82d3ddf3fb",
            "entitlement_name": "test entitlement",
            "account": "9e2fd2ee11b43110f877366201dea674",
            "consumer": null,
            "household": null,
            "contract": "0e1747f251e27110f877bf82d3ddf31c",
            "service_contract_line": "e79dce4151723d10f877bf82d3ddf31d",
            "state": "active",
            "product_offering": null,
            "product_specification": null,
            "sold_entitlement": null,
            "product": null,
            "start_date": "2023-11-21",
            "end_date": ""
          }
        ],
        "status": "success"
      }
    }

### Curl-Anforderung

Das folgende Codebeispiel zeigt eine Fehlerantwort.

    curl "https://instance.service-now.com/api/sn_ent_verify/verifyentitlements?service_contract_line=e79dce4151723d10f877bf82d3ddf31d" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

Ergebnisse zurückgeben:

    {
      "error": {
        "detail": "At least one of Account or Consumer parameter is mandatory.",
        "message": "At least one of Account or Consumer parameter is mandatory."
      },
      "status": "failure"
    }

## Berechtigungen verifizieren -- GET /sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/{ID} {#ariaid-title3}

Gibt Details des angegebenen Berechtigungsmerkmalsdatensatzes und des aktuellen Nutzungsdatensatzes zurück.
Der letzte Nutzungsdatensatz für ein Merkmal ist definiert als der Datensatz, bei dem das Periodenstartdatum kleiner oder gleich dem aktuellen Datum ist und das Periodenenddatum größer oder gleich dem aktuellen Datum ist.

### URL-Format {#ver_entitle-GET-getEntitleChar__section_wzv_ksv_qzb}

Versionierte URL: /api/sn_ent_verify/{api_Version}/verifyberechlements/getEntitlementCharacteristic/{ID}

Standard-URL: /api/sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/{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

{#ver_entitle-GET-getEntitleChar__entry__2}{#ver_entitle-GET-getEntitleChar__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 zurückzugebenden Berechtigungsmerkmalsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigungsmerkmal \[sn_pss_core_entitlement_characteristic\] |
[Tabelle : 7. Pfad-Parameter]

{#ver_entitle-GET-getEntitleChar__entry__8}{#ver_entitle-GET-getEntitleChar__csm-display_value-entry}

| Name | Beschreibung |
|-|-|
| Display_value | Kennzeichnung, die angibt, ob der zugehörige Feldwert, der Anzeigewert oder beides zurückgegeben werden soll. Gültige Werte: * Wahr: Antwort enthält nur die Anzeigewerte der Felder. Beispiel: `„status": „Entwurf" `. * Falsch: Die Antwort enthält nur die Werte der Felder. Beispiel: `„status": „Entwurf" `. * Alle: Antwort enthält alle Informationen für die Felder. Zum Beispiel: "state": { "name": "state", "label": "State", "value": "draft", "display_value": "true", "type": "string" } Datentyp: Zeichenfolge Standard: Falsch |
[Tabelle : 8. Abfrageparameter]

{#ver_entitle-GET-getEntitleChar__entry__12}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 9. Anforderungstext-Parameter (XML oder 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.").
{#ver_entitle-GET-getEntitleChar__entry__16}{#ver_entitle-GET-getEntitleChar__accept-RESTAPI}

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

{#ver_entitle-GET-getEntitleChar__entry__20}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 11. 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.").
{#ver_entitle-GET-getEntitleChar__entry__24}{#ver_entitle-GET-getEntitleChar__entry-200-status-code}{#ver_entitle-GET-getEntitleChar__entry-403-status-code}{#ver_entitle-GET-getEntitleChar__entry-404-status-code}{#ver_entitle-GET-getEntitleChar__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 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 : 12. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#ver_entitle-GET-getEntitleChar__entry__34}

| Name | Beschreibung |
|-|-|
| Merkmal | SYS_ID des zugeordneten Berechtigungsmerkmalsdatensatzes. Datentyp: Zeichenfolge Tabelle: Merkmal \[sn_prd_pm_characteristic\] |
| Merkmal_Option | SYS_ID des zugehörigen Merkmalsoptionsdatensatzes. Datentyp: Zeichenfolge Tabelle: Merkmalsoption \[sn_prd_pm_characteristic_option\] |
| Entitlement_usage | Details zum Berechtigungsnutzungsdatensatz, der dem angegebenen Berechtigungsmerkmalsdatensatz zugeordnet ist. Datentyp: Array von Objekten "entitlement_usage": [ { "entitlement_characteristic": "String", "period_end": "String", "period_start": "String", "sys_id": "String", "total_units": "String", "used_units": "String" } ] |
| Entitlement_usage. ​Entitlement_Merkmal | SYS_ID des zugeordneten Berechtigungsmerkmalsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigungsmerkmal \[sn_pss_core_entitlement_characteristic\] |
| Entitlement_usage. ​Period_end | Wert des Felds „Periodenende" im Berechtigungsnutzungsdatensatz. Dieser Wert ist das Datum, an dem die Nutzungsnachverfolgung für diese Berechtigung endet. Datentyp: Zeichenfolge |
| Entitlement_usage. ​Period_Start | Wert des Felds „Periodenstart" im Berechtigungsnutzungsdatensatz. Dieser Wert ist das Datum, an dem die Nutzungsnachverfolgung für diese Berechtigung beginnt. Datentyp: Zeichenfolge |
| Entitlement_usage. ​sys_ID | SYS_ID des zurückgegebenen Berechtigungsnutzungsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigungsnutzungen \[sn_pss_core_entitlement_usage\] |
| Entitlement_usage. ​Total_units | Gesamtzahl der gekauften Einheiten. Datentyp: Zeichenfolge Tabelle: Im Feld total_units der Tabelle „Berechtigungsnutzungen" \[sn_pss_core_entitlement_usage\]. |
| Entitlement_usage. ​Used_units | Anzahl der verwendeten Einheiten. Datentyp: Zeichenfolge Tabelle: Im Feld used_units in der Tabelle „Berechtigungsnutzungen" \[sn_pss_core_entitlement_usage\]. |
| sys_id | SYS_ID des Berechtigungsmerkmalsdatensatzes. Datentyp: Zeichenfolge Tabelle: Berechtigungsmerkmal \[sn_pss_core_entitlement_characteristic\] |
| Typ | Wert des Typfelds im Berechtigungsmerkmalsdatensatz. Mögliche Werte: * Abdeckung * Abdeckung_und_Nutzung Datentyp: Zeichenfolge |
| Wert | Abdeckung, die das Merkmal gibt. Für einige Merkmale werden Abdeckungen in der Merkmalsoptionstabelle definiert. Wenn jedoch in der Merkmalsoptionstabelle keine Abdeckungen definiert sind, können Sie die Abdeckungsinformationen in übergeben valueParameter. Merkmalsoptionen sind nur für die Merkmalstypen definiert von: * Kontrollkästchen * Auswahl * ja/Nein Für alle anderen Arten von Merkmalen valueParameter muss den Abdeckungswert enthalten. Wenn das Merkmal beispielsweise „Anzahl der Ersetzungen" ist und seine Abdeckungen nicht in der Merkmalsoptionstabelle definiert sind, können Sie die Abdeckungen in diesem Parameter angeben, z. B. „10", „20". Hinweis: Dieser Parameter enthält den endgültigen Abdeckungswert für das Merkmal. Wenn Informationen in der Merkmalsoptionstabelle vorhanden sind, werden sie an diesen Parameter propagiert. Datentyp: Zeichenfolge |
[ ]

### Curl-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt mit allen Standardwerten aufgerufen wird.

    curl "https://instance.servicenow.com/api/sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/3c817faa43823110341605ed0bb8f23a" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

Ergebnisse zurückgeben:

    {
      "result": {
        "sys_id": "3c817faa43823110341605ed0bb8f23a",
        "characteristic": "b73177aa43823110341605ed0bb8f246",
        "type": "coverage",
        "characteristic_option": "ff617baa43823110341605ed0bb8f266",
        "value": "Minor parts",
        "entitlement_usage": [
          {
            "sys_id": "03e3224d51b23d10f877bf82d3ddf310",
            "period_start": "2022-12-12",
            "period_end": "2025-12-12",
            "entitlement_characteristic": "3c817faa43823110341605ed0bb8f23a",
            "total_units": "10",
            "used_units": "5"
          }
        ]
      }
    }

### Curl-Anforderung

Das folgende Codebeispiel zeigt, wie dieser Endpunkt aufgerufen und alle Anzeigewerte zurückgegeben werden.

    curl "https://instance.servicenow.com/api/sn_ent_verify/verifyentitlements/getEntitlementCharacteristic/3c817faa43823110341605ed0bb8f23a?display_value=all" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

Ergebnisse zurückgeben:

    {
      "result": {
        "sys_id": {
          "label": "Sys ID",
          "value": "3c817faa43823110341605ed0bb8f23a",
          "displayValue": "3c817faa43823110341605ed0bb8f23a",
          "type": "GUID"
        },
        "characteristic": {
          "name": "characteristic",
          "label": "Characteristic",
          "value": "b73177aa43823110341605ed0bb8f246",
          "display_value": "Repair parts covered",
          "type": "reference"
        },
        "type": {
          "name": "type",
          "label": "Type",
          "value": "coverage",
          "display_value": "Coverage",
          "type": "string"
        },
        "characteristic_option": {
          "name": "characteristic_option",
          "label": "Characteristic option",
          "value": "ff617baa43823110341605ed0bb8f266",
          "display_value": "Minor parts",
          "type": "reference"
        },
        "value": {
          "name": "value",
          "label": "Value",
          "value": "Minor parts",
          "display_value": "Minor parts",
          "type": "string"
        },
        "entitlement_usage": [
          {
            "sys_id": {
              "label": "Sys ID",
              "value": "03e3224d51b23d10f877bf82d3ddf310",
              "displayValue": "03e3224d51b23d10f877bf82d3ddf310",
              "type": "GUID"
            },
            "period_start": {
              "name": "period_start",
              "label": "Period start",
              "value": "2022-12-12",
              "display_value": "2022-12-12",
              "type": "glide_date"
            },
            "period_end": {
              "name": "period_end",
              "label": "Period end",
              "value": "2025-12-12",
              "display_value": "2025-12-12",
              "type": "glide_date"
            },
            "entitlement_characteristic": {
              "name": "entitlement_characteristic",
              "label": "Entitlement characteristic",
              "value": "3c817faa43823110341605ed0bb8f23a",
              "display_value": "Repair parts covered",
              "type": "reference"
            },
            "total_units": {
              "name": "total_units",
              "label": "Total units",
              "value": "10",
              "display_value": "10",
              "type": "string"
            },
            "used_units": {
              "name": "used_units",
              "label": "Used units",
              "value": "5",
              "display_value": "5",
              "type": "string"
            }
          }
        ]  
      }
    }


