REST API

API を使用してデータをアップロードするには、次のスクリプト化された REST エンドポイントを使用します。sn_sbom_core.sbom_ingest ロールが必要です。

SBOMが正常に処理された後、アップロードされたレコードをどこで表示するかは、使用しているアプリケーションによって異なります。

• 応答を使用している場合SBOM、BOM エンティティレコードは、ワークスペースの BOM キューモジュールの SBOM [取り込みステータス] リストに表示されますSBOM。
• SBOM Core を使用している場合は、次に移動します。 SBOM Core > BOM 取り込みステータス.

REST API の使用

アップロードできるのは、CycloneDX JSON形式のファイルのみです SBOM 。

呼び出し元ユーザーが正常に認証され、インスタンスで ServiceNow sn_sbom_core.sbom_ingest ロールを持っている場合は、インスタンスの外部から API にアクセスしてデータをアップロード SBOM できます。

SBOM コンテンツは、HTTP 要求の本文として、またはデータ ファイルを含む SBOM コマンド ライン要求を介して API に送信できます。たとえば、ユーザーがファイルを管理するための独自のプロセスを持っている場合は、 curl コマンド ライン ツールを使用できます。

さらに、クエリパラメーターに製品モデルとビジネスアプリケーションの sys_id を含めることができます。これらのパラメーターを含めると、BOM エンティティはそれらにマップされます。次のパラメーターがサポートされています。

• productModelId
• businessApplicationId

すべての API 呼び出しがキューに格納され、キューに格納されたレコードの sys_id が API 応答として返されます。

REST API を介して、 SBOM データがインスタンスに送信されます Now Platform 。

データがアップロードされると、そのデータが解析されます。データが解析される前に、次の要件が検証されます。

• 受信データがチェックされ、有効な JSON であることが確認されている。
• BOM 形式がサポートされている。この統合では、CycloneDX 形式のみがサポートされています。
• データを解析できるように、最小限のフィールドが利用可能である。

これらのチェックが検証されると、部品表 [sn_sbom_doc] テーブルにエントリが作成され、受信 SBOM データが添付ファイルとして含まれます。

にリストされている SBOM すべてのコンポーネントには、 定義済みの型があります。

• ファイルがアップロードされた SBOM コンポーネントは、BOM エンティティと見なされます。
• type=library としてリストされているコンポーネントは、サードパーティのコンポーネントと見なされます。