- Checkmarx Documentation
- Checkmarx SAST
- SAST API Guide
- CxSAST (SOAP) API
- Working with CxSAST Projects
- Getting Project Details
Getting Project Details
The API client can get configuration details and user permissions for a known project.
The obtained configuration detail object can be used to change project configuration.
CxSDKWebService.GetProjectConfiguration Method
public CxWSResponseProjectConfig GetProjectConfiguration( string sessionID, long projectID );
Parameters
sessionID: The current Session ID
projectID: Project identifier. Can be obtained from the server response upon running a scan.
Return Value
Project details, including the following fields:
.ProjectConfig: A Project Configuration object
.Permission: User permissions for this project
Example
To get project details for a project with a known ID of 200:
internal void Main(string [] args) { String sessionID = args[0]; CxSDKWebServiceSoapClient cxSDKProxy = new CxSDKWebServiceSoapClient(); //The project unique ID long projectID = 200; CxWSResponseProjectConfig response= cxSDKProxy.GetProjectConfiguration(sessionID, projectID); //project configuration ProjConfig = response.ProjectConfig; //user permissions for the project Permissions = response.Permission; }
SOAP to REST Mapping
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.
GetProjectConfiguration | GET /projects | Get details of all projects. |
---|---|---|
GET /projects/{id} | Get details of a specific project. |
For more mapping information, refer to API Mapping (SOAP to REST). You can also find a summary of our REST APIs here.