API de classification des données

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 8 minutes de lecture

    • L’API de classification des données fournit des points de terminaison pour regrouper les données par type.

    Avec l’API de classification des données, vous pouvez :
    • Affectez des classifications de données aux entrées de dictionnaire existantes.
    • Recherchez les classifications de données pour des entrées de dictionnaire spécifiques.
    • Supprimez toutes les classifications de données associées à des entrées de dictionnaire spécifiques.
    • Récupérez une liste de toutes les classifications de données disponibles dans le domaine actuel.

    Cette API nécessite le module d’extension Data Classification [com.glide.data_classification].

    Pour plus d’informations, consultez Classification des données.

    Classification des données : GET /data_classification/getAllDataClasses

    Renvoie une liste de toutes les classifications de données disponibles dans le domaine actuel.

    Nécessite un rôle administrateur, data_classification_admin ou data_classification_auditor.

    Format d'URL

    URL par défaut : /api/now/data_classification/getAllDataClasses

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 2. Paramètres de requête
    Nom Description
    Néant
    Tableau 3. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    Néant

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 4. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 5. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 6. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat

    Résultat de la demande. Renvoie le sys_id et le nom de chaque classification de données disponible. S’il n’existe aucune classification de données, renvoie un tableau vide.

    Les classifications de données peuvent être organisées en relations parent-enfant. S’il existe des classifications de données parentes, elles sont identifiées dans le résultat.

    Type de données : tableau

    "result": [
  {
    "parent": {Object},
    "sys_id": "String",
    "name": "String"
  }
]
    résultat.parent Entrée pour une classification de données parent.

    Type de données : objet

    "parent": {
  "sys_id": "String",
  "name": "String"
}
    result.parent.sys_id Sys_id de la classification des données parente à partir de la table Classification des données [data_classification].

    Type de données : chaîne
    result.parent.name Nom de la classification des données parente.

    Type de données : chaîne
    result.sys_id Sys_id de la classification des données à partir de la table Classification des données [data_classification].

    Type de données : chaîne
    result.name Nom de la classification des données.

    Type de données : chaîne

    Demande cURL

    Récupère une liste de toutes les classifications de données disponibles.

    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"
    }
  ]
}

    Classification des données : POST /data_classification/classify

    Affecte des classifications de données prédéfinies ou définies par l’utilisateur aux entrées de dictionnaire existantes.

    Nécessite le rôle administrateur ou data_classification_admin.

    Format d'URL

    URL par défaut : /api/now/data_classification/classify

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 8. Paramètres de requête
    Nom Description
    Néant
    Tableau 9. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    dictionary_entries Requis. La sys_ids des enregistrements que vous souhaitez classer. Les sys_ids proviennent de la table du dictionnaire [sys_dictionary]. Saisie sous la forme d’une liste séparée par des virgules entourée d’une chaîne.

    Type de données : chaîne
    data_classes Requis. La sys_ids des classifications de données que vous souhaitez affecter. Les sys_ids proviennent de la table Classification des données [data_classification]. Saisie sous la forme d’une liste séparée par des virgules entourée d’une chaîne.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 10. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Type de contenu Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 11. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 12. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Message décrivant le résultat de l’opération.

    Type de données : chaîne

    Demande cURL

    Affecte une classification de données à une entrée de dictionnaire.

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

    Classification des données : POST /data_classification/effacer

    Supprime toutes les classifications de données pour les entrées de dictionnaire spécifiées.

    Nécessite le rôle administrateur ou data_classification_admin.

    Format d'URL

    URL par défaut : /api/now/data_classification/clear

    Paramètres de demande pris en charge

    Tableau 13. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 14. Paramètres de requête
    Nom Description
    Néant
    Tableau 15. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    dictionary_entries Requis. La sys_ids des enregistrements dont vous souhaitez supprimer les classifications. Les sys_ids proviennent de la table du dictionnaire [sys_dictionary]. Saisie sous la forme d’une liste séparée par des virgules entourée d’une chaîne.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 16. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Type de contenu Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 17. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 18. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat Message décrivant le résultat de l’opération.

    Type de données : chaîne

    Demande cURL

    Efface les classifications de données pour une entrée de dictionnaire.

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

    Classification des données : POST /data_classification/getClassification

    Récupère toutes les classifications de données pour les entrées de dictionnaire spécifiées.

    Nécessite un rôle administrateur, data_classification_admin ou data_classification_auditor.

    Format d'URL

    URL par défaut : /api/now/data_classification/getClassification

    Paramètres de demande pris en charge

    Tableau 19. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 20. Paramètres de requête
    Nom Description
    Néant
    Tableau 21. Paramètres de corps de demande (XML ou JSON)
    Nom Description
    dictionary_entries Requis. La sys_ids des enregistrements pour lesquels vous souhaitez récupérer les classifications. Les sys_ids proviennent de la table du dictionnaire [sys_dictionary]. Saisie sous la forme d’une liste séparée par des virgules entourée d’une chaîne.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir une liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 22. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Type de contenu Format de données du corps de la demande. Types pris en charge : application/json ou application/xml.

    Valeur par défaut : application/json
    Tableau 23. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir une liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 24. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON ou XML)

    Nom Description
    résultat

    Résultat de la demande. Renvoie un objet JSON contenant les sys_id de chaque entrée de dictionnaire avec un tableau de ses classifications de données associées. S’il n’y a pas de classifications de données associées, elle renvoie un message décrivant le résultat de l’opération.

    Les classifications de données peuvent être organisées en relations parent-enfant. S’il existe des classifications de données parentes, elles sont identifiées dans le résultat.

    Type de données : objet

    "result": {
  <sys_dictionary_sys_id>: [
    {
      "parent": {Object},
      "sys_id": "String",
      "name": "String"
    }
  ]
}
    result.name Nom de la classification des données.

    Type de données : chaîne
    résultat.parent Entrée pour une classification de données parent.

    Type de données : objet

    "parent": {
  "sys_id": "String",
  "name": "String"
}
    result.parent.name Nom de la classification des données parente.

    Type de données : chaîne
    result.parent.sys_id Sys_id de la classification des données parente à partir de la table Classification des données [data_classification].

    Type de données : chaîne
    result.sys_id Sys_id de la classification des données à partir de la table Classification des données [data_classification].

    Type de données : chaîne

    Demande cURL

    Obtenir les classifications de données associées à une entrée de dictionnaire spécifique.

    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"
      }
    ]
  }
}