Datenklassifizierungs-API

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 6 Minuten Lesedauer

    • Die Datenklassifizierungs -API bietet Endpunkte zum Gruppieren von Daten nach Typ.

    Mit der Datenklassifizierungs-APIkönnen Sie:
    • Weisen Sie vorhandenen Dictionary-Einträgen Datenklassifizierungen zu.
    • Suchen Sie in den Datenklassifizierungen nach bestimmten Wörterbucheinträgen.
    • Entfernen Sie alle Datenklassifizierungen, die bestimmten Wörterbucheinträgen zugeordnet sind.
    • Ruft eine Liste aller Datenklassifizierungen ab, die in der aktuellen Domäne verfügbar sind.

    Diese API erfordert das Plugin „Data Classification“ [com.glide.data_classification].

    Weitere Informationen finden Sie unter Datenklassifizierung.

    Datenklassifizierung – GET /data_classification/getAllDataClasses

    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 HTTP-Antwortcodesder REST-API.

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

    Antworttextparameter (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 Übergeordnet-Untergeordnet-Beziehungen organisiert werden. Wenn übergeordnete Datenklassifizierungen vorhanden sind, werden sie im Ergebnis identifiziert.

    Datentyp: Array

    "result": [
  {
    "parent": {Object},
    "sys_id": "String",
    "name": "String"
  }
]
    result.parent Eintrag für eine übergeordnete Datenklassifizierung.

    Datentyp: Objekt

    "parent": {
  "sys_id": "String",
  "name": "String"
}
    result.parent.sys_id Sys_id der übergeordneten Datenklassifizierung aus der Datenklassifizierungstabelle [data_classification].

    Datentyp: Zeichenfolge
    result.parent.name Name der übergeordneten Datenklassifizierung.

    Datentyp: Zeichenfolge
    result.sys_id Sys_id der Datenklassifizierung aus der Datenklassifizierungstabelle [data_classification].

    Datentyp: Zeichenfolge
    result.name Name der Datenklassifizierung.

    Datentyp: Zeichenfolge

    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 benutzerdefinierte 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_entries Erforderlich. Die sys_ids der Datensätze, die Sie klassifizieren möchten. Die sys_ids stammen aus der Wörterbuchtabelle [sys_dictionary]. Wird als kommagetrennte Liste in einer Zeichenfolge eingegeben.

    Datentyp: Zeichenfolge
    data_classes Erforderlich. Die sys_ids der Datenklassifizierungen, die Sie zuweisen möchten. Die sys_ids stammen aus der Datenklassifizierungstabelle [data_classification]. Wird als kommagetrennte Liste in einer Zeichenfolge eingegeben.

    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 HTTP-Antwortcodesder REST-API.

    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.

    Antworttextparameter (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_entries Erforderlich. Die sys_ids der Datensätze, aus denen Sie Klassifizierungen entfernen möchten. Die sys_ids stammen aus der Wörterbuchtabelle [sys_dictionary]. Wird als kommagetrennte Liste in einer Zeichenfolge eingegeben.

    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 HTTP-Antwortcodesder REST-API.

    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.

    Antworttextparameter (JSON oder XML)

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

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Löscht die Datenklassifizierungen für einen Dictionary-Eintrag.

    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_entries Erforderlich. Die sys_ids der Datensätze, für die Sie Klassifizierungen abrufen möchten. Die sys_ids stammen aus der Wörterbuchtabelle [sys_dictionary]. Wird als kommagetrennte Liste in einer Zeichenfolge eingegeben.

    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 HTTP-Antwortcodesder REST-API.

    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.

    Antworttextparameter (JSON oder XML)

    Name Beschreibung
    Ergebnis

    Ergebnis der Anforderung. Gibt ein JSON-Objekt zurück, das die sys_id jedes Dictionary-Eintrags 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 Übergeordnet-Untergeordnet-Beziehungen organisiert werden. Wenn übergeordnete Datenklassifizierungen vorhanden sind, werden sie im Ergebnis identifiziert.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    result.parent Eintrag für eine übergeordnete Datenklassifizierung.

    Datentyp: Objekt

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

    Datentyp: Zeichenfolge
    result.parent.sys_id Sys_id der übergeordneten Datenklassifizierung aus der Datenklassifizierungstabelle [data_classification].

    Datentyp: Zeichenfolge
    result.sys_id Sys_id der Datenklassifizierung aus der Datenklassifizierungstabelle [data_classification].

    Datentyp: Zeichenfolge

    cURL-Anforderung

    Ruft die Datenklassifizierungen ab, die einem bestimmten Dictionary-Eintrag 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"
      }
    ]
  }
}