REST API를 사용하여 파일 업로드 Software Bill of Materials

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기2분

    • API를 사용하여 파일을 업로드 Software Bill of Materials 하기 전에 다음 정보를 검토하십시오.

    REST API

    API를 사용하여 데이터를 업로드하려면 다음 스크립팅된 REST 엔드포인트를 사용합니다. sn_sbom_core.sbom_ingest 역할이 필요합니다.

    <host_name>/api/sbom/core/upload입니다.
    주:
    ServiceNow<host_name>는 인스턴스 이름입니다.

    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 요청의 본문으로 또는 데이터 파일이 있는 명령줄 요청을 통해 API로 보낼 수 있습니다 SBOM . 예를 들어, 사용자에게 파일을 관리하는 자체 프로세스가 있는 경우 curl 명령줄 도구를 사용할 수 있습니다.

    또한 제품 모델 및 비즈니스 애플리케이션의 sys_id 쿼리 매개변수에 포함할 수 있습니다. BOM 엔터티는 이러한 매개변수를 포함하는 경우 해당 매개변수에 매핑됩니다. 다음 매개변수가 지원됩니다.

    • 제품 모델 ID
    • 비즈니스 애플리케이션 ID

    모든 API 호출이 큐에 대기하고 큐에 대기 중인 레코드의 sys_id API 응답으로 반환됩니다.

    REST API SBOM 를 통해 데이터가 인스턴스 Now Platform 로 전송됩니다.

    데이터가 업로드되면 구문 분석됩니다. 데이터를 구문 분석하기 전에 다음 요구 사항이 확인됩니다.

    • 들어오는 데이터가 유효한 JSON인지 확인합니다.
    • BOM 형식이 지원됩니다. 이 통합의 경우 CycloneDX 형식만 지원됩니다.
    • 데이터를 구문 분석할 수 있도록 최소 필드를 사용할 수 있습니다.

    이러한 확인이 확인되면 BOM [sn_sbom_doc] 테이블에 들어오는 SBOM 데이터가 첨부 파일로 입력됩니다.

    Process BOM file 비즈니스 규칙은 기록 삽입 및 데이터 구문 분석의 결과로 자동으로 트리거됩니다.
    주:
    이 비즈니스 규칙은 기본적으로 Core를 SBOM 설치하는 동안 활성화됩니다.

    에 SBOM 나열된 모든 구성 요소에는 정의된 유형이 있습니다.

    • 파일이 업로드된 SBOM 구성요소는 BOM 도면요소로 간주됩니다.
    • type=library로 나열된 구성 요소는 타사 구성 요소로 간주됩니다.