REST API v2

To call the functions of FOSSLight, you can use the REST API.

How to start

To call the REST API, you need to issue a TOKEN. Please follow the steps below.

1. Log in with your Admin account
2. In the System > User Management tab, you can issue a Token for each User.

REST API List

Refer to the link below for API operation and return value.

- For Demo service: https://demo.fosslight.org/swagger-ui/index.html (integration server : https://demo.fosslight.org/)

0. Header

How to Enter Token When Using Swagger UI

• Click the Authorize button.

• After entering the token information in the Value field of the popup, click the Authorize button.

1. Check OSS & License information

2. Check 3rd Party information

3. Check project information, upload OSS Report/Packaging, export/comparison of BOM

API	Response Format	Description
GET /api/v2/projects	JSON	Retrieve information about the Project including the following items: createDate: Query based on the date the Project was created (fromDate-toDate) creator: Query based on the information of the person who created it division: Query based on division information modelName: Query based on the model name prjIdList: Query based on project ID. Multiple IDs can be input in list form prjName: Query based on the project name prjNameExactYn: Set to true to retrieve only projects that exactly match the input project name status: Query based on the status of the Project updateDate: Query based on the date the Project was modified (fromDate-toDate) countPerPage: Number of items to be listed at once (default = 1000, max = 1000) page: Page number to query (default = 1)
POST /api/v2/projects	JSON	API for Project Creation. The generated project ID will be returned. additional Information: Additional information about the project distributionSite: Select the distribution site (input as /api/v2/codes value) distributionType: Select the distribution type (input as /api/v2/codes value) networkServerType: Select whether it is a network server noticeType: Select the type of notice (input as /api/v2/codes value) noticeTypeEtc: If it is Platform-generate, select the type (input as /api/v2/codes value) (required) osType: Select the OS type (input as /api/v2/codes value) osTypeEtc: Additional OS type information priority: Select priority based on the urgency of the project (input as /api/v2/codes value) (required) prjName: Project name prjVersion: Project version publicYn: View Permission information (Y: Everyone, N: Creator & Editor) (default = Y) userComment: User comment
GET /api/v2/projects/models	JSON	Query model information for the Project. (required) prjIdList: Information of the project IDs to be queried. Multiple IDs can be input in list form.
DELETE /api/v2/projects/{id}	JSON	Delete project (Only projects that have not been distributed can be deleted). (required) id: Target project ID
GET /api/v2/projects/{id}/bom/compare-with/{compareId}	JSON	Project BOM Compare. (required) compareId: Project ID to be compared (required) id: Reference project ID
GET /api/v2/projects/{id}/bom/file	JSON	Project BOM export - Download in file format. (required) format: File format to be extracted (required) id: Target project ID saveFlag: Choose whether to update the BOM based on the information at the time of API execution (default = Y)
GET /api/v2/projects/{id}/bom/json-data	JSON	Project BOM export - Received in JSON format. (required) id: Target project ID saveFlag: Choose whether to update the BOM based on the information at the time of API execution (default = Y)
POST /api/v2/projects/{id}/editors	JSON	Add an editor to the project. (required) emailList: Email information of the editors to be added (required) id: Target project ID
POST /api/v2/projects/{id}/models	JSON	Update the project's Model information through a list of model information strings. (Note: This will only add models; they will not be distributed. If distribution is needed after adding model information, please go to the Distribution tab and proceed with distribution.) (required) id: Target project ID (required) modelListToUpdate: Model information string list (format: MODEL_NAME|Category|Release Date) - ex. MODEL_NAME|ETC > Etc|20220428
POST ​/api​/v2​/projects​/{id}​/models​/upload	JSON	Update the project's Model information using a Model List Excel file. (Note: This will only add models; they will not be distributed. If distribution is needed after adding model information, please go to the Distribution tab and proceed with distribution.) (required) id: Target project ID (required) modelReport: Excel file of the Model List: Project > Project Information tab > Click the Download button
GET /api/v2/projects/{id}/notice	JSON	Notice for receiving files for the project ID (required) id: Target project ID
POST /api/v2/projects/{id}/packages	JSON	Upload a package file to the project. packageFile: Package file to be uploaded (required) id: Target project ID verifyFlag: Choose whether to verify the uploaded file (default = N)
GET /api/v2/projects/{id}/security/json-data	JSON	Query security vulnerability information detected in the project in JSON format (required) id: Target project ID
POST /api/v2/projects/{id}/{tab_name}/oss-load	-	Load open-source information reviewed in previous projects into the project (Only projects with identification confirmed can be loaded). (required) id: Target project ID prjToLoad: Project ID to load (input if the search condition is id) prjNameToLoad: Project name to load (input if the search condition is name) prjVersionToLoad: Project version to load (input if the search condition is name) resetFlag: Whether to reset existing entered information when loading (default = Y). N - Append while maintaining existing OSS Table entries (required) searchCondition: Criteria for searching the project to load (required) tab_name: Target tab name (bin/dep/src)
POST /api/v2/projects/{id}/{tab_name}/reports	-	Upload an open-source analyzed report file to the project. ossReport: Report file to be uploaded comment: User comment (required) id: Target project ID resetFlag: Whether to reset existing entered information when uploading the file (default = Y). N - Append while maintaining existing OSS Table entries sheetNames: If you want to update specific sheet names from the uploaded report file, input here. If not entered, information will be loaded based on the default prefixes DEP, SRC, BIN. Multiple sheets can be entered, separated by commas. (required) tab_name: Target tab name
POST /api/v2/projects/{id}/{tab_name}/reset	-	Reset the tab selected in Project > Identification. (required) id: arget project ID (required) tab_name: Target tab name

4. Check Vulnerability information

5. Create Self-Check and register OSS Report

6. Check the value of the code used when using API

7. Check Binary DB

8. Compliance Status

Error code

In case of an error, an HTTP Response Code other than 2xx will be returned.