| GET /api/v2/projects | JSON | 아래 항목을 포함한 Project의 정보를 조회합니다.
-
createDate: Project 생성한 날짜 기준으로 조회 (fromDate-toDate)
-
creator: 생성한 사람 정보 기준으로 조회
-
division: division 정보 기준으로 조회
-
modelName: model 이름 기준으로 조회
-
modelNameExactYn: true로 설정하면 model name에 입력한 값과 정확히 일치하는 프로젝트만 조회
-
ossName: 입력한 oss name을 사용하는 project list 조회
-
ossVersion: 입력한 oss version을 사용하는 project list 조회
-
prjIdList: project ID 기준으로 조회. list형태로 여러개 입력 가능
-
prjName: project 이름 기준으로 조회
-
prjNameExactYn: true로 설정하면 project name에 입력한 값과 정확히 일치하는 프로젝트만 조회
-
status: Project의 status기준으로 조회
-
updateDate: Project의 수정한 날짜 기준으로 조회 (fromDate-toDate)
-
couterPerPage: 한 번에 조회할 아이템의 개수 (default = 1000, max = 1000)
-
page: 조회할 페이지 번호 (default = 1)
|
| POST /api/v2/projects | JSON | Project 생성을 위한 API. 생성된 project ID가 리턴됨
-
additional Information: 프로젝트의 추가 정보
-
distributionSite: 배포 사이트 선택 (/api/v2/codes 값으로 입력)
-
distributionType: 배포 타입 선택 (/api/v2/codes 값으로 입력)
-
networkServerType: 네트워크 서버 여부 선택
-
noticeType: 고지문 타입 선택 (/api/v2/codes 값으로 입력)
-
noticeTypeEtc: Platform-generate인 경우 타입 선택 (/api/v2/codes 값으로 입력)
-
(required) osType: OS 타입 선택 (/api/v2/codes 값으로 입력)
-
osTypeEtc: 추가적인 OS 타입 정보
-
priority: 프로젝트의 긴급 여부에 따라 우선순위 선택 (/api/v2/codes 값으로 입력)
-
(required) prjName: 프로젝트 이름
-
prjVersion: 프로젝트 버전
-
publicYn: View Permission 정보 (Y: Everyone, N: Creator & Editor) (default = Y)
-
userComment: 유저 커맨트
|
| GET /api/v2/projects/models | >JSON
| Project의 모델 정보 조회
-
(required) prjIdList: 조회할 대상인 project ID 정보. list형태로 입력 가능
|
| DELETE /api/v2/projects/{id} | JSON | Project를 삭제함 (Distribution 진행되지 않은 프로젝트만 삭제 가능)
-
(required) id: 기준 project ID
|
| GET /api/v2/projects/{id}/sbom/compare-with/{compareId} | JSON | Project SBOM Compare
-
(required) compareId: 비교할 project ID
-
(required) id: 기준 project ID
|
| GET /api/v2/projects/{id}/sbom/file | JSON | Project SBOM export - 파일 형태로 다운로드
-
(required) format: 추출할 파일 포맷
-
(required) id: 대상 project ID
-
saveFlag: API 실행 시점의 정보로, SBOM을 최신화 할지 여부 선택 (default = Y)
|
| GET /api/v2/projects/{id}/sbom/json-data | JSON | Project SBOM export - JSON 형태로 받음
-
(required) id: 대상 project ID
-
saveFlag: API 실행 시점의 정보로, SBOM을 최신화 할지 여부 선택 (default = Y)
|
| POST /api/v2/projects/{id}/editors | JSON | Project에 editor를 추가함
-
(required) emailList: 추가할 editor의 이메일 정보
-
(required) id: 대상 project ID
|
| POST /api/v2/projects/{id}/models | JSON | Model 정보 문자열 목록을 통해 Project의 Model 정보를 업데이트합니다.
(단, Model을 추가할 뿐 Distribute 되지는 않습니다. Model 정보를 추가 후 Distribute가 필요한 경우 Distribution탭으로 이동 후 Distribute 진행해주시기 바랍니다.)
-
(required) id: 대상 project ID
-
(required) modelListToUpdate: Model 정보 문자열 목록 (format: MODEL_NAME|Category|Release Date)
- ex. MODEL_NAME|ETC > Etc|20220428 |
| POST /api/v2/projects/{id}/models/upload | JSON | Model List 엑셀 파일을 통해 Project의 Model 정보를 업데이트합니다.
(단, Model을 추가할 뿐 Distribute 되지는 않습니다. Model 정보를 추가 후 Distribute가 필요한 경우 Distribution탭으로 이동 후 Distribute 진행해주시기 바랍니다.)
-
(required) id: 대상 project ID
-
(required) modelReport: Model List의 엑셀 파일 : Project > Project Information 탭 > Download 버튼 클릭
 |
| GET /api/v2/projects/{id}/notice | JSON | Notice 파일을 받을 project ID
-
(required) id: 대상 project ID
|
| POST /api/v2/projects/{id}/packages | JSON | Project에 package 파일 업로드
-
packageFile: 업로드할 패키지 파일
-
(required) id: 대상 project ID
-
verifyFlag: 업로드 한 파일에 대해 verify 진행 여부 (default = N)
|
| (LGE only)POST /api/v2/projects/{id}/platform/reports | JSON | Android/Yocto(Platform-generate) Project에 Report 파일 업로드
-
(required) id: 대상 project ID
-
(required) notice: 업로드할 Notice 파일
-
(required) ossReport: 업로드할 OSS Report 파일
-
comment: report upload에 대한 사용자 comment
-
(required) resetFlag: 파일 업로드 시, 기존 입력된 정보들을 Reset할지 여부 (default = Y)
- 주의: resetFlag=N인 경우에도, Report 및 Notice 파일은 마지막 업로드 한 파일만 유지됨
-
(required) sbomSave: Sbom 탭 update 여부 (default = "Y")
|
| (LGE only)POST /api/v2/projects/{id}/platform/reset | JSON | Android/Yocto(Platform-generate) Project의 Identification 정보를 reset합니다.
-
(required) id: 대상 project ID
|
| (LGE only)GET /api/v2/projects/{id}/platform/supplement-notice | FILE | Platform-generate(Android/Yocto) 프로젝트의 Supplement NOTICE 파일을 다운로드합니다.
-
(required) id : 대상 project ID
-
noticeOutputType : 다운로드할 고지문 형식 (아래 값 중 하나 입력)
-
ONE_FILE : NOTICE를 하나의 HTML 파일로 다운로드 -
BY_BINARY : Binary Path별로 NOTICE 파일을 생성하여 하나의 ZIP 파일로 다운로드 |
| POST /api/v2/projects/{id}/reports | JSON | 단일 엑셀 파일에서 여러 시트를 읽어 dep/src/bin 탭의 OSS 컴포넌트를 한번에 등록합니다 (Multi-sheet)
-
(required) ossReport: 업로드할 엑셀 파일 (최대 15MB)
-
(required) tabSheetMapping: 탭과 시트명 매핑 JSON
- 예시: {"src":["SRC_FL_Source"],"dep":["DEP_FL_Dependency"],"bin":["BIN_FL_Binary"]} -
comment: 업로드 시 추가 설명
-
(required) id: Report 파일을 업로드할 Project ID
|
| POST /api/v2/projects/{id}/security-mail | - | 해당 프로젝트에 대한 Vulnerability 메일 수신 여부를 업데이트 합니다.
-
(required) id: 대상 project ID
-
(required) secMailYn: Security Enable (Y: Enable, N: Disable)
-
secMailDesc: Disable로 설정하는 사유 (secMailYn이 N일때 필수 입력)
|
| POST /api/v2/projects/{id}/security-person | - |
Creator, Editor와 함께 FOSSLight Hub에서 발송되는 Security 메일을 받을 사람을 업데이트 합니다.
(LGE Only) PSMS에서 생성되는 이슈의 assignee를 업데이트 합니다.
-
(required) id: 대상 project ID
-
(required) userId: 대상 담당자 ID (FOSSLight Hub에 등록된 사람에 한하여 입력 가능함)
|
| GET /api/v2/projects/{id}/security/json-data | JSON | Project에서 검출된 보안취약점 정보를 JSON 형태로 받음
-
(required) id: 대상 project ID
|
| POST /api/v2/projects/{id}/{tab_name}/oss-load | - | Project에 이전 프로젝트에서 리뷰된 Open Source 정보를 로드함 (Identification confirm 된 프로젝트만 로드 가능)
-
(required) id: 대상 project ID
-
prjToLoad: 로드할 프로젝트 ID (search condition이 id인 경우 입력)
-
prjNameToLoad: 로드할 프로젝트 이름 (search condition이 name인 경우 입력)
-
prjVersionToLoad: 로드할 프로젝트 버전 (search condition이 name인 경우 입력)
-
resetFlag: 로드 할 때, 기존 입력된 정보들을 Reset할지 여부 (default = Y)
-
(required) searchCondition: 로드할 프로젝트를 검색하는 기준
-
(required) tab_name: 대상 탭 이름 (bin/dep/src)
|
| POST /api/v2/projects/{id}/{tab_name}/reports | - | Project에 Open Source 분석된 리포트 파일을 업로드함
-
ossReport: 업로드할 리포트 파일
-
sbomSave: SBOM탭 Save 여부
-
comment: 사용자 comment
-
(required) id: 대상 project ID
-
resetFlag: 파일 업로드 시, 기존 입력된 정보들을 Reset할지 여부 (default = Y)
-
sheetNames: 업로드할 리포트 파일에서 특정 sheet name을 업데이트 하고자 하는 경우 입력. 입력하지 않는 경우 기본으로 DEP, SRC, BIN prefix에 맞춰서 정보를 불러옴. , 로 구분하여 여러 Sheet를 입력 가능
-
(required) tab_name: 대상 탭 이름
|
| POST /api/v2/projects/{id}/{tab_name}/reset | - | Project > Identification에서 선택한 탭을 reset함
-
(required) id: 대상 project ID
-
(required) tab_name: 대상 탭 이름
|
| POST /api/v2/projects/{id}/{step}/review-requests | JSON | Project의 특정 단계(Identification, Packaging)에 대해 Review를 요청합니다.
-
(required) id : 대상 project ID
-
(required) step : Review를 요청할 단계 (현재는 identification만 동작하며, packaging은 추후 지원 예정)
-
comment : 요청 시 남길 유저 코멘트
※ 주의: identification 단계 요청 시 Red warning이 존재하는 경우 에러 메시지와 함께 요청이 실패합니다. (Blue warning은 무시하고 요청 가능) |
