Verify Entitlements API

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 12 Minuten Lesedauer

    • Die Verify Entitlements API stellt Endpunkte bereit, mit denen Sie eine Liste gültiger Berechtigungen, Details zu den Merkmalen von Berechtigungen und die aktuellen Nutzungsinformationen einer Berechtigung abrufen können.

    Für den Zugriff auf diese API muss das Plugin „Entitlement Verification“ (sn_ent_verify) aktiviert sein.

    Diese API wird im Namespace sn_ent_verify bereitgestellt.

    Der anrufende Benutzer muss über die Rolle sn_pss_core.pss_integrator verfügen.

    Die REST-Endpunkte dieser API fragen Daten aus den folgenden Tabellen ab:
    • Account [customer_account]
    • Verbraucher [csm_consumer]
    • Berechtigung [service_entitlement]
    • Berechtigungsmerkmal [sn_pss_core_entitlement_charakteristik]
    • Berechtigungsnutzungen [sn_pss_core_entitlement_usage]
    • Haushalt [csm_household]
    • Installationsbasis [sn_install_base_item]
    • Produktangebot [sn_prd_pm_product_offering]
    • Produktmodell [cmdb_model]
    • Servicevertrag [sn_pss_core_service_contract]
    • Servicevertragsposition [sn_pss_core_service_contract_line]
    • Verkauftes Produkt [sn_install_base_sold_product]

    Berechtigungen überprüfen: /sn_ent_verify/verifyentitlements

    Gibt die gültigen Berechtigungsdatensätze basierend auf dem angegebenen Filter zurück.

    Sie können Berechtigungen basierend auf Folgendem filtern:
    • Account
    • Verbraucher
    • Vertrag
    • Haushalt
    • Installationsbasis
    • Produktmodell
    • Produktangebot
    • Servicevertragsposition
    • Verkauft – Berechtigung
    • Verkauftes Produkt
    • Status
    Sie müssen mindestens das Konto oder den Verbraucher angeben, für den die Berechtigungen gefiltert werden sollen.

    Wenn mehrere Filterparameter übergeben werden, wendet der Endpunkt den AND- Operator auf die Parameter an. Wenn Sie beispielsweise Filterparameter wie „account = Boxeo“ und „Status = Entwurf“übergeben, gibt der Endpunkt alle Berechtigungen mit Account = Boxeo UND Status = Entwurf zurück.

    Sie können eine Paginierung für die zurückgegebenen Ergebnisse implementieren, indem Sie die Systempaginierungsparameter sysparm_offset und sysparm_limitübergeben. Standardmäßig ist sysparm_offset auf 0 und sysparm_limit 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

    URL mit Versionsnummer: /api/sn_ent_verify/v1/verifyentitlements

    Standard-URL: /api/sn_ent_verify/verifyentitlements

    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
    sysparm_limit Optional.
    Maximale Anzahl der zurückzugebenden Datensätze. Verwenden Sie für Anforderungen, die diese Anzahl von Datensätzen überschreiten, den Parameter sysparm_offset, um den Datensatzabruf zu paginieren.

    In der Antwort wird der boolesche Parameter hasMore zurückgegeben. Gibt an, ob weitere Datensätze zurückgegeben werden, die die Filterkriterien erfüllen.

    Datentyp: Zahl

    Standard: 10

    Maximum: 100
    sysparm_offset Optional.
    Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren. Diese Funktion ermöglicht das Abrufen aller Datensätze in kleinen, verwaltbaren Abschnitten, unabhängig von der Anzahl der Datensätze.

    Wenn zum Beispiel dieser Endpunkt zum ersten Mal aufgerufen wird, ist sysparm_offset auf „0“ eingestellt. Verwenden Sie sysparm_offset=sysparm_offset+sysparm_limit zum einfachen Durchblättern aller verfügbaren Datensätze, bis das Ende aller Datensätze erreicht ist.

    Übergeben Sie keine negative Zahl im Parameter sysparm_offset.

    Datentyp: Zahl

    Standard: 0
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Account Entweder der Parameter account oder consumer muss übergeben werden. Sie schließen sich gegenseitig aus. Sys_id des Account-Datensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Befindet sich in der Tabelle „Account“ [customer_account].

    Datentyp: Zeichenfolge

    Standard: Keine
    consumer Entweder der Parameter account oder consumer muss übergeben werden. Sie schließen sich gegenseitig aus. Sys_id des Verbraucherdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer].

    Datentyp: Zeichenfolge

    Standard: Keine
    contract Sys_id des Vertragsdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Befindet sich in der Tabelle „Vertrag“ [sn_pss_core_service_contract].

    Datentyp: Zeichenfolge

    Standard: Keine
    display_value Kennzeichnung, die angibt, ob der zugeordnete Feldwert, der Anzeigewert oder beides zurückgegeben werden soll.
    Gültige Werte:
    • wahr: Antwort enthält nur die Anzeigewerte der Felder. Beispiel: "state": "Draft".
    • „falsch“: Antwort enthält nur die Werte der Felder. Beispiel: "state": "draft".
    • all: Antwort enthält alle Informationen für die Felder.

      Beispiel:

      "state": {
"name": "state",
"label": "State",
"value": "draft",
"display_value": "Draft",
"type": "string"
},

    Datentyp: Zeichenfolge

    Standardwert: false
    ​Haushalt Sys_id des Haushaltsdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Befindet sich in der Tabelle „Haushalt“ [csm_household].

    Datentyp: Zeichenfolge

    Standard: Keine
    install_base Sys_id des Installationsbasisdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Befindet sich in der Tabelle „Installationsbasis“ [sn_install_base_item].

    Der Endpunkt verwendet die sys_id des Installationsbasis-Datensatzes, um die Tabelle „Abgedeckte verkaufte Produkte [sn_install_base_m2m_contract_sold_product]“ zu durchsuchen und alle von der zugehörigen Installationsbasis abgedeckten Berechtigungen zurückzugeben.

    Datentyp: Zeichenfolge

    Standard: Keine
    product Sys_id des Produktdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model].

    Datentyp: Zeichenfolge

    Standard: Keine
    product_offering Sys_id des Produktangebotdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge

    Standard: Keine
    service_contract_line Sys_id des Datensatzes der Servicevertragsposition, für den Berechtigungsdatensätze zurückgegeben werden sollen. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line].

    Datentyp: Zeichenfolge

    Standard: Keine
    „sold_entitlement“ Sys_id des verkauften Berechtigungsdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product].

    Datentyp: Zeichenfolge

    Standard: Keine
    „sold_product“ Sys_id des verkauften Produktdatensatzes, für den Berechtigungsdatensätze zurückgegeben werden sollen. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product].

    Der Endpunkt verwendet die sys_id des Datensatzes „Verkauftes Produkt“, um die Tabelle „Verkauftes Produkt abgedeckt“ [sn_install_base_m2m_contract_sold_product] zu durchsuchen und alle Berechtigungen zurückzugeben, die vom zugehörigen verkauften Produkt abgedeckt werden.

    Datentyp: Zeichenfolge

    Standard: Keine
    Staat Status der zurückzugebenden Berechtigungen.
    Gültige Werte:
    • aktiv
    • abgebrochen,
    • Entwurf
    • abgelaufen
    • ausgesetzt

    Datentyp: Zeichenfolge

    Standard: Alle
    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.
    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. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    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",
    "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. Befindet sich in der Tabelle „Account“ [customer_account].

    Datentyp: Zeichenfolge
    entitlements.consumer Sys_id des Verbraucherdatensatzes, der dieser Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Verbraucher“ [csm_consumer].

    Datentyp: Zeichenfolge
    berechtigungen.vertrag Sys_id des Vertragsdatensatzes, der dieser Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Vertrag“ [sn_pss_core_service_contract].

    Datentyp: Zeichenfolge
    end_date Wert des Felds „Enddatum“ im zugeordneten Berechtigungsdatensatz.

    Datentyp: Zeichenfolge
    berechtigungen.berechtigung_name Name der Berechtigung.

    Datentyp: Zeichenfolge
    Berechtigungen.Haushalt Sys_id des Haushaltsdatensatzes, der dieser Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Haushalt“ [csm_household].

    Datentyp: Zeichenfolge
    berechtigungen.produkt Sys_id des Produktdatensatzes, der dieser Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Produktmodell“ [cmdb_model].

    Datentyp: Zeichenfolge
    berechtigungen.product_offering Sys_id des Produktangebotsdatensatzes, der dieser Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Produktangebot“ [sn_prd_pm_product_offering].

    Datentyp: Zeichenfolge
    berechtigungen.service_contract_line Sys_id des Datensatzes der Servicevertragsposition, der dieser Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Servicevertragsposition“ [sn_pss_core_service_contract_line].

    Datentyp: Zeichenfolge
    berechtigungen.sold_entitlement Sys_id des verkauften Berechtigungsdatensatzes, der dieser Berechtigung zugeordnet ist. Befindet sich in der Tabelle „Verkaufte Produkte“ [sn_install_base_sold_product].

    Datentyp: Zeichenfolge
    berechtigungen.startdatum Wert des Felds „Startdatum“ im zugeordneten Berechtigungsdatensatz.

    Datentyp: Zeichenfolge
    berechtigungen.status Status des Berechtigungsdatensatzes.
    Gültige Werte:
    • aktiv
    • Abgebrochen
    • Entwurf
    • abgelaufen
    • ausgesetzt

    Datentyp: Zeichenfolge
    berechtigungen.sys_id Sys_id des Berechtigungsdatensatzes. Befindet sich in der Tabelle „Berechtigung“ [service_entitlement].

    Datentyp: Zeichenfolge
    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 ganze Zahl zwischen 1 und 100 sein

      Fehlerbedingung: Ungültiger Parameter sysparm_limit übergeben. Der Parameter sysparm_limit muss zwischen 1 und 100 liegen.

    • Fehlermeldung: Seiten-Offset -23 ist ungültig. Offset muss eine Ganzzahl größer oder gleich 0 sein

      Fehlerbedingung: Ungültiger Parameter sysparm_offset übergeben. Der Parameter sysparm_offset muss eine ganze Zahl sein.

    • Fehlermeldung: Ungültiger Abfrageparameter – Account

      Fehlerbedingung: Der ungültige Abfrageparameter „acnt“ wurde übergeben. Parameter muss „account“ sein.

    • Fehlermeldung: Ungültiger Auswahlwert: Status = DRFT

      Fehlerbedingung: Der ungültige Wert „drft“ wurde übergeben. Parameterwert muss „Entwurf“ sein.
    Fehler.detail Detaillierte Informationen dazu, warum der Endpunktaufruf fehlgeschlagen ist.

    Datentyp: Zeichenfolge
    Fehlernachricht Meldung, die den Fehler auf allgemeiner Ebene beschreibt.

    Datentyp: Zeichenfolge
    hasMore Kennzeichnung, die angibt, ob weitere Berechtigungsdatensätze für die Rückgabe vorhanden sind.
    Gültige Werte:
    • „wahr“: Weitere zurückzugebende Berechtigungsdatensätze.
    • „falsch“: Keine weiteren Berechtigungsdatensätze.

    Datentyp: Boolesch
    status Status des Endpunktaufrufs.
    Gültige Werte:
    • Fehler: Bei der Verarbeitung der Anforderung ist ein Fehler aufgetreten.
    • erfolgreich: Der Anruf wurde erfolgreich verarbeitet.

    Datentyp: Zeichenfolge
    sysparm_limit Wenn der Parameter sysparm_limit im Endpunktaufruf übergeben wurde, enthält er den übergebenen Wert, andernfalls enthält er den Standardwert.

    Datentyp: Zahl
    sysparm_offset Wenn der Parameter sysparm_offset im Endpunktaufruf übergeben wurde, enthält er den übergebenen Wert, andernfalls enthält er 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,
        "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,
        "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,
          "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 – /sn_ent_verify/verifyentitlements/getEntitlementCharacterific/{id}

    Gibt Details zum angegebenen Berechtigungsmerkmalsdatensatz und zu seinem aktuellen Nutzungsdatensatz zurück.

    Der Datensatz der letzten Verwendung für ein Merkmal ist als der Datensatz definiert, bei dem das Startdatum des Zeitraums kleiner als oder gleich dem aktuellen Datum und das Enddatum des Zeitraums größer als oder gleich dem aktuellen Datum ist.

    URL-Format

    URL mit Versionsangabe: /api/sn_ent_verify/v1/verifyentitlements/getEntitlementCharacterific/{id}

    Standard-URL: /api/sn_ent_verify/verifyentitlements/getEntitlementCharacterific/{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 zurückzugebenden Berechtigungsmerkmalsdatensatzes. Befindet sich in der Tabelle „Berechtigungsmerkmal“ [sn_pss_core_entitlement_characterific].

    Datentyp: Zeichenfolge
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    display_value Kennzeichnung, die angibt, ob der zugeordnete Feldwert, der Anzeigewert oder beides zurückgegeben werden soll.
    Gültige Werte:
    • wahr: Antwort enthält nur die Anzeigewerte der Felder. Beispiel: "state": "Draft".
    • „falsch“: Antwort enthält nur die Werte der Felder. Beispiel: "state": "draft".
    • all: Antwort enthält alle Informationen für die Felder.

      Beispiel:

      "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

    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 : 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.
    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. Der Antworttext enthält Informationen zum Fehler.

    Parameter des Antworttexts (JSON oder XML)

    Name Beschreibung
    Merkmal Sys_id des zugeordneten Berechtigungsmerkmalsdatensatzes. Befindet sich in der Tabelle „Merkmal“ [sn_prd_pm_charakteristik].

    Datentyp: Zeichenfolge
    Merkmal_Option Sys_id des zugeordneten Datensatzes mit Merkmaloptionen. Befindet sich in der Tabelle „Merkmaloption“ [sn_prd_pm_characterist_option].

    Datentyp: Zeichenfolge
    „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“ Sys_id des zugeordneten Berechtigungsmerkmalsdatensatzes. Befindet sich in der Tabelle „Berechtigungsmerkmal“ [sn_pss_core_entitlement_characterific].

    Datentyp: Zeichenfolge
    „entitlement_usage.​period_end“ Wert des Felds „Zeitraumende“ 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 „Zeitraumstart“ 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. Befindet sich in der Tabelle „Berechtigungsnutzungen“ [sn_pss_core_entitlement_usage].

    Datentyp: Zeichenfolge
    „entitlement_usage.​total_units“ Gesamtanzahl der gekauften Einheiten. Befindet sich im Feld „Gesamteinheiten“ im Berechtigungsnutzungsdatensatz.

    Datentyp: Zeichenfolge
    entitlement_usage.​used_units Anzahl der verwendeten Einheiten. Befindet sich im Feld „Verwendete Einheiten“ im Berechtigungsnutzungsdatensatz.

    Datentyp: Zeichenfolge
    sys_id Sys-ID des Berechtigungsmerkmals-Datensatzes. Befindet sich in der Tabelle „Berechtigungsmerkmal“ [sn_pss_core_entitlement_characterific].

    Datentyp: Zeichenfolge
    type Wert des Typfelds im Berechtigungsmerkmalsdatensatz.
    Mögliche Werte:
    • Abdeckung
    • „Abdeckung_und_Nutzung“

    Datentyp: Zeichenfolge
    Wert Abdeckung, die das Merkmal angibt.

    Für einige Merkmale werden Abdeckungen in der Tabelle „Merkmalsoptionen“ definiert. Wenn jedoch in der Merkmaloptionstabelle keine Abdeckungen definiert sind, können Sie die Abdeckungsinformationen im Parameter value übergeben.

    Merkmalsoptionen werden nur für die Merkmalstypen definiert:
    • Checkbox
    • Auswahl
    • ja/nein
    Für alle anderen Arten von Merkmalen sollte der Parameter value den Abdeckungswert enthalten.

    Wenn das Merkmal beispielsweise „Anzahl der Ersatzprodukte“ ist und seine Abdeckungen nicht in der Merkmalsoptionstabelle definiert sind, können Sie die Abdeckungen wie „10“ oder „20“ in diesem Parameter angeben.

    Hinweis:
    Dieser Parameter enthält den endgültigen Abdeckungswert für das Merkmal. Wenn in der Merkmaloptionstabelle Informationen vorhanden sind, werden sie an diesen Parameter weitergegeben.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Das folgende Codebeispiel zeigt, wie dieser Endpunkt mit all seinen 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"
        }
      }
    ]  
  }
}