- Checkmarx Documentation
- Checkmarx SAST
- SAST API Guide
- CxSAST (SOAP) API
- Working with CxSAST Projects
- Getting Projects for Display
The API client can get a list of CxSAST projects available to the current user. This is used primarily for display purposes.
public CxWSResponseProjectsDisplayData GetProjectsDisplayData(
string sessionID
);
sessionID: The current Session ID
Array of projects. Each project contains data for display.
internal void Main(string [] args)
{
String sessionID = args[0];
CxSDKWebServiceSoapClient cxSDKProxy = new CxSDKWebServiceSoapClient();
//request for all the projects related to current user
CxWSResponseProjectsDisplayData response= cxSDKProxy.GetProjectsDisplayData(sessionID);
//set the project data mainly for display use
ProjectsData = response.projectList;
}
This section covers SOAP to REST migration and mapping of our legacy SOAP based SDK to the new REST APIs. It is recommended to use this reference only once CxSAST V8.8.0 is installed.
GetProjectsDisplayData | GET /projects | Gets details of all projects. Returns wide-ranging project information - owning team, latest scan, all project scans, scan settings and custom fields. |
---|---|---|
GET /customFields | Get details of all custom fields. | |
PUT /projects/{id} | Update an existing project’s details. Parameters include – name, owningTeam and customFields (id and value). |
GetProjectsDisplayData | GET /projects | Gets details of all projects. Returns wide-ranging project information - owning team, latest scan, all project scans, scan settings and custom fields. |
---|---|---|
GET /customFields | Get details of all custom fields. | |
PUT /projects/{id} | Update an existing project’s details. Parameters include – name, owningTeam and customFields (id and value). |
For more mapping information, refer to API Mapping (SOAP to REST). You can also find a summary of our REST APIshere.