Datenklassifizierungs-API

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 6 Minuten Lesedauer

    • Die Datenklassifizierung Die API stellt Endpunkte bereit, um Daten nach Typ zu gruppieren.

    Mit Datenklassifizierungs-API , Sie können:
    • Weisen Sie vorhandenen Wörterbucheinträgen Datenklassifizierungen zu.
    • Suchen Sie die Datenklassifizierungen für bestimmte Wörterbucheinträge.
    • Entfernen Sie alle Datenklassifizierungen, die bestimmten Wörterbucheinträgen zugeordnet sind.
    • Ruft eine Liste aller in der aktuellen Domäne verfügbaren Datenklassifizierungen ab.

    Diese API erfordert das Plugin „Datenklassifizierung“ [com.Glide.Data_classification].

    Weitere Informationen finden Sie unter Datenklassifizierung .

    Datenklassifizierung – GET /Data_classification/getAllDataClasses AB

    Gibt eine Liste aller Datenklassifizierungen zurück, die in der aktuellen Domäne verfügbar sind.

    Erfordert die Rolle admin, Data_classification_admin oder Data_classification_Auditor.

    URL-Format

    Standard-URL: /api/now/Data_classification/getAllDataClasses

    Unterstützte Anforderungsparameter

    Tabelle : 1. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 2. Abfrageparameter
    Name Beschreibung
    Keine
    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 REST API-HTTP-Antwortcodes .

    Tabelle : 6. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Ergebnis der Anforderung. Gibt die sys_ID und den Namen für jede verfügbare Datenklassifizierung zurück. Wenn keine Datenklassifizierungen vorhanden sind, wird ein leeres Array zurückgegeben.

    Datenklassifizierungen können in über- und untergeordnete Beziehungen organisiert werden. Wenn übergeordnete Datenklassifizierungen vorhanden sind, werden sie im Ergebnis identifiziert.

    Datentyp: Array von Objekten

    "result": [
  {
    "name": "String",
    "parent": {Object},
    "sys_id": "String"
  }
]
    result.name Name der Datenklassifizierung.

    Datentyp: Zeichenfolge
    Ergebnis.übergeordnetes Element Eintrag für eine übergeordnete Datenklassifizierung.

    Datentyp: Objekt

    "parent": {
  "name": "String",
  "sys_id": "String"
}
    result.parent.name Name der übergeordneten Datenklassifizierung.

    Datentyp: Zeichenfolge
    Ergebnis.parent.sys_ID SYS_ID des übergeordneten Datensatzes der Datenklassifizierung.

    Datentyp: Zeichenfolge

    Tabelle: Datenklassifizierung [Data_classification]
    Ergebnis.sys_ID SYS_ID des Datensatzes der Datenklassifizierung.

    Datentyp: Zeichenfolge

    Tabelle: Datenklassifizierung [Data_classification]

    cURL-Anforderung

    Ruft eine Liste aller verfügbaren Datenklassifizierungen ab.

    curl "https://instance.servicenow.com/api/now/data_classification/getAllDataClasses" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
    {
  "result": [
    {
      "parent": {
        "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
        "name": "Confidential"
      },
      "sys_id": "348107b951d71010f877f3f178e7dd0d",
      "name": "Personally identifiable information"
    },
    {
      "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
      "name": "Confidential"
    },
    {
      "sys_id": "59b7070b73fc1010ae8dd21efaf6a764",
      "name": "Restricted"
    },
    {
      "sys_id": "11d60fc773fc1010ae8dd21efaf6a744",
      "name": "Internal"
    },
    {
      "sys_id": "f5b4cf4773fc1010ae8dd21efaf6a766",
      "name": "Public"
    }
  ]
}

    Datenklassifizierung: POST /Data_classification/Classify

    Weist vorhandenen Wörterbucheinträgen vordefinierte oder anwenderdefinierte Datenklassifizierungen zu.

    Erfordert die Rolle admin oder Data_classification_admin.

    URL-Format

    Standard-URL: /api/now/Data_classification/Classify

    Unterstützte Anforderungsparameter

    Tabelle : 7. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 8. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 9. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Dictionary_entry Erforderlich.
    SYS_IDs der Datensätze, die Sie klassifizieren möchten. Wird als kommagetrennte Liste eingegeben, die in einer Zeichenfolge eingeschlossen ist.

    Tabelle: Wörterbuchtabelle [sys_dictionary]

    Datentyp: Zeichenfolge
    Data_classes Erforderlich.
    SYS_IDs der Datenklassifizierungen, die Sie zuweisen möchten. Wird als kommagetrennte Liste eingegeben, die in einer Zeichenfolge eingeschlossen ist.

    Tabelle: Datenklassifizierung [Data_classification]

    Datentyp: Zeichenfolge

    Header

    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
    Content-Type Datenformat des Anforderungstexts. 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 REST API-HTTP-Antwortcodes .

    Tabelle : 12. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Nachricht, die das Ergebnis des Vorgangs beschreibt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Weist einem Wörterbucheintrag eine Datenklassifizierung zu.

    curl "https://instance.servicenow.com/api/now/data_classification/classify" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\",
    \"data_classes\": \"40edb1f51bbcec50b92a10a61a4bcb8a\"
}" \
--user 'username':'password'

    {
  "result": "Successfully stored the data classification configurations"
}

    Datenklassifizierung: POST /Data_classification/Clear

    Entfernt alle Datenklassifizierungen für die angegebenen Wörterbucheinträge.

    Erfordert die Rolle admin oder Data_classification_admin.

    URL-Format

    Standard-URL: /api/now/Data_classification/Clear

    Unterstützte Anforderungsparameter

    Tabelle : 13. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 14. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 15. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Dictionary_entry Erforderlich.
    SYS_IDs der Datensätze, aus denen Sie Klassifizierungen entfernen möchten. Wird als kommagetrennte Liste eingegeben, die in einer Zeichenfolge eingeschlossen ist.

    Tabelle: Wörterbuch [sys_dictionary]

    Datentyp: Zeichenfolge

    Header

    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 : 16. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 17. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 18. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Nachricht, die das Ergebnis des Vorgangs beschreibt.

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Löscht die Datenklassifizierungen für einen Wörterbucheintrag.

    curl "https://instance.servicenow.com/api/now/data_classification/clear" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\"
}" \
--user 'username':'password'

    {
  "result": "Classifications removed for the specified dictionary entries"
}

    Datenklassifizierung: POST /Data_classification/getClassification

    Ruft alle Datenklassifizierungen für die angegebenen Wörterbucheinträge ab.

    Erfordert die Rolle admin, Data_classification_admin oder Data_classification_Auditor.

    URL-Format

    Standard-URL: /api/now/Data_classification/getClassification

    Unterstützte Anforderungsparameter

    Tabelle : 19. Pfadparameter
    Name Beschreibung
    Keine
    Tabelle : 20. Abfrageparameter
    Name Beschreibung
    Keine
    Tabelle : 21. Anforderungstextparameter (XML oder JSON)
    Name Beschreibung
    Dictionary_entry Erforderlich.
    SYS_IDs der Datensätze, für die Sie Klassifizierungen abrufen möchten. Wird als kommagetrennte Liste eingegeben, die in einer Zeichenfolge eingeschlossen ist.

    Tabelle: Wörterbuch [sys_dictionary]

    Datentyp: Zeichenfolge

    Header

    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 : 22. Anforderungskopfzeilen
    Kopfzeile Beschreibung
    Akzeptieren Datenformat des Antworttexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Content-Type Datenformat des Anforderungstexts. Unterstützte Typen: application/json oder application/xml.

    Standard: application/json
    Tabelle : 23. Antwortkopfzeilen
    Kopfzeile Beschreibung
    Keine

    Statuscodes

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

    Tabelle : 24. Statuscodes
    Statuscode Beschreibung
    200 Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet.
    500 Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Der Antworttext enthält Informationen zum Fehler.

    Antworttext-Parameter (JSON oder XML)

    Name Beschreibung
    Ergebnis Ergebnis der Anforderung. Gibt ein JSON-Objekt zurück, das die sys_ID jedes Wörterbucheintrags mit einem Array der zugehörigen Datenklassifizierungen enthält. Wenn keine zugeordneten Datenklassifizierungen vorhanden sind, wird eine Nachricht zurückgegeben, die das Ergebnis des Vorgangs beschreibt.

    Datenklassifizierungen können in über- und untergeordnete Beziehungen organisiert werden. Wenn übergeordnete Datenklassifizierungen vorhanden sind, werden sie im Ergebnis identifiziert.

    Datentyp: Objekt

    "result": {
  <sys_dictionary_sys_id>: [
    {
      "name": "String",
      "parent": {Object},
      "sys_id": "String"
    }
  ]
}
    result.name Name der Datenklassifizierung.

    Datentyp: Zeichenfolge
    Ergebnis.übergeordnetes Element Eintrag für eine übergeordnete Datenklassifizierung.

    Datentyp: Objekt

    "parent": {
  "name": "String",
  "sys_id": "String"
}
    result.parent.name Name der übergeordneten Datenklassifizierung.

    Datentyp: Zeichenfolge
    Ergebnis.parent.sys_ID SYS_ID des übergeordneten Datensatzes der Datenklassifizierung.

    Datentyp: Zeichenfolge

    Tabelle: Datenklassifizierung [Data_classification]
    Ergebnis.sys_ID SYS_ID des Datensatzes der Datenklassifizierung.

    Datentyp: Zeichenfolge

    Tabelle: Datenklassifizierung [Data_classification]

    cURL-Anforderung

    Ruft die Datenklassifizierungen ab, die einem bestimmten Wörterbucheintrag zugeordnet sind.

    curl "https://instance.servicenow.com/api/now/data_classification/getClassification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\"
}" \
--user 'username':'password'

    {
  "result": {
    "445de0a6dba30300efc57416bf9619b0": [
      {
        "parent": {
          "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
          "name": "Confidential"
        },
        "sys_id": "348107b951d71010f877f3f178e7dd0d",
        "name": "Personally identifiable information"
      }
    ]
  }
}