Skip to content

project.md

Latest commit

 

History

History
84 lines (58 loc) · 2.94 KB

project.md

File metadata and controls

84 lines (58 loc) · 2.94 KB

Project

A Project represents an open-source project available in the Maven repository which might have direct/indirect associated NVD security vulnerabilities.

Properties (to be completed)

  • id The unique ID for the Project.

  • name The public name for this Project.

  • groupID The associated Maven groupId for the project.

  • artifactID The associated Maven artifactId for the project.

  • version The associated Maven version number for the project.

  • cpeID The associated NVD ID for the project.

  • vulnerabilities The directly associated NVD vulnerabilities for the project. This can be seen only when the "detailed" parameter is set to "true".

  • dependencies The transitive dependencies for the project. This can be seen only when the "detailed" parameter is set to "true".

Making API Calls

These URLs allow you to access the search functionality of SE-GPS from any non-browser user agent. Note that the "wt" parameter present in every URL determines the format of the results.

Setting "wt" equal to "json" will provide a JSON response, while setting "wt" equal to "xml" will provide the same response formatted as an XML document.

Another common parameter is "rows," which limits the number of results returned by the server.

The "detailed" parameter limits the details returned. Setting "detailed" to "false", will return only the basic details about the project(s); setting the value to "true" will return extra details such as transitive dependencies (Transitive dependency depth are limited to 2 at the moment).

NOTE: Most of the URLs in this document have been URL-decoded for the sake of readability. They should work when pasted into a web browser, but you may have to URL-encode them to function when called programmatically

To get a list of Projects:

https://aseg.cs.concordia.ca/segps-rest/project/list?rows={rows}&wt={wt}

To search project(s) based on criteria:

Search by GroupID, ArtifactId & Version
https://aseg.cs.concordia.ca/segps-rest/search/project/select?g={groupID}&a={artifactID}&v={version}&rows={rows}&wt={wt}
Search by GroupID & ArtifactId
https://aseg.cs.concordia.ca/segps-rest/search/project/select?g={groupID}&a={artifactID}&rows={rows}&wt={wt}
Search by ArtifactId & Version
https://aseg.cs.concordia.ca/segps-rest/search/project/select?a={artifactID}&v={version}&rows={rows}&wt={wt}
Search by GroupId
https://aseg.cs.concordia.ca/segps-rest/search/project/select?g={groupID}&rows={rows}&wt={wt}
Search by ArtifactId
https://aseg.cs.concordia.ca/segps-rest/search/project/select?a={artifactID}&rows={rows}&wt={wt}
Search by cpeID
https://aseg.cs.concordia.ca/segps-rest/search/project/select?cpe={cpeID}&rows={rows}&wt={wt}

To get a single Project:

https://aseg.cs.concordia.ca/segps-rest/project/{id}&wt={wt}&detailed={detailed}