Chargement de Nomenclature logicielle fichiers à l’aide d’une API REST

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

    • Passez en revue les informations suivantes avant de Nomenclature logicielle charger des fichiers à l’aide d’une API.

    API REST

    Pour charger des données avec une API, utilisez le point de terminaison REST scripté suivant. Le rôle sn_sbom_core.sbom_ingest est requis.

    <host_name>/api/sbom/core/upload.
    Remarque :
    <host_name> 'est le nom de votre ServiceNow instance.

    Une fois qu’une SBOM opération est traitée avec succès, l’emplacement d’affichage des enregistrements chargés dépend des applications que vous utilisez.

    • Si vous utilisez SBOM la réponse, l’enregistrement de l’entité BOM est affiché sur la liste État d’ingestion SBOM du module File d’attente BOM de l’espace SBOM de travail.
    • Si vous utilisez SBOM Core, accédez à SBOM principal > État de l'ingestion BOM.

    Utiliser l’API REST

    Vous ne pouvez charger que SBOM des fichiers au format JSON CycloneDX.

    Si l’utilisateur appelant est authentifié avec succès et qu’il dispose du rôle sn_sbom_core.sbom_ingest dans votre ServiceNow instance, vous pouvez accéder à l’API depuis l’extérieur de votre instance pour charger les SBOM données.

    SBOM Le contenu peut être envoyé à l’API en tant que corps de la requête HTTP ou via une requête de ligne de commande avec un SBOM fichier de données. Par exemple, vous pouvez utiliser l’outil de ligne de commande curl à condition que vos utilisateurs disposent de leur propre processus pour gérer les fichiers.

    En outre, vous pouvez inclure la sys_id du modèle de produit et de l’application d’entreprise dans vos paramètres de requête. L’entité BOM est mappée à ces paramètres si vous les incluez. Les paramètres suivants sont pris en charge :

    • ID modèle produit
    • ID d’application commerciale

    Chaque appel d’API est mis en file d’attente et une sys_id de l’enregistrement en file d’attente est renvoyée comme réponse API.

    Via l’API REST, les SBOM données sont envoyées à votre Now Platform instance.

    Une fois les données chargées, elles sont analysées. Avant l’analyse des données, les exigences suivantes sont vérifiées :

    • Les données entrantes sont vérifiées pour vérifier qu’il s’agit d’un JSON valide.
    • Le format BOM est pris en charge. Pour cette intégration, seul le format CycloneDX est pris en charge.
    • Les champs minimum sont disponibles afin que les données puissent être analysées.

    Une fois ces vérifications vérifiées, une entrée est effectuée dans la table Nomenclature [sn_sbom_doc] avec les données entrantes SBOM en pièce jointe.

    La Process BOM file règle métier est déclenchée automatiquement suite à l’insertion de l’enregistrement et à l’analyse des données.
    Remarque :
    Par défaut, cette règle métier est activée lors de l’installation de SBOM Core.

    Tous les composants répertoriés dans un SBOM ont un type défini.

    • Les composants pour lesquels SBOM les fichiers ont été chargés sont considérés comme des entités BOM.
    • Les composants répertoriés comme type=library sont considérés comme des composants tiers.