New APIs

The following new APIs were added in this release.

New APIs

Resource

API Name/Endpoint

Method

Function Change Description

Jobs

Export project inventory to SBOM Insights

/jobs/sbomexport/{projectId}

POST

Exports inventory data from the specified project to SBOM Insights. Once initiated, the export is scheduled in the Jobs queue. (The JobId is listed in the response.) To monitor the status of the job, use the jobs/{jobId} API.

Only Project Analysts can perform this export.

Calling this API requires that Code Insight and the project be properly configured to support exports to SBOM Insights. See Project Inventory Export to SBOM Insights for more information.

Note:The export is not initiated (nor is a job added) if any of these jobs are already in progress or queued for the project: scan, rescan, Project Copy, or another SBOM Insights export.

Update project notices

/jobs/notices/{projectId}

POST

Automatically updates the notices text across inventory in a project. You can choose to update the notices text for all inventory (overwriting any existing notices text) or update only those inventory items that have no notices text assigned. See Automatic Update of Notices Across Inventory in a Project for more information.

Once initiated, the update is scheduled in the Jobs queue. (The JobId is listed in the response.) To monitor the status of the job, use the jobs/{jobId} API.

Project Analysts and Project Reviewers can perform a notices update through this REST API. (In the UI, only Project Analysts can perform the update.)

Note:The notices update is not initiated (nor is a job added) if any of these jobs are already in progress or queued for the project: scan, rescan, Project Copy, Project Branch, or another notices update.

License

Update Licenses External Id

/licenses/{licenseId}

PATCH

Enables a Code Insight system administrator to map a specified license (identified by licenseId) to a corresponding ID in an external system (such as your site’s license-tracking system). The following is an example request body identifying the external ID, which is a string value:

{
"externalId": "L156"
}

For more information, see License Mapping to External IDs.