ProjectVersionControllerApi.md

ProjectVersionControllerApi

All URIs are relative to https://SSC:8080/ssc/api/v1

Method	HTTP request	Description
auditByAuditAssistantProjectVersion	POST /projectVersions/action/auditByAuditAssistant	auditByAuditAssistant
copyCurrentStateForProjectVersion	POST /projectVersions/action/copyCurrentState	copyCurrentStateFor
copyProjectVersion	POST /projectVersions/action/copyFromPartial	copy
createProjectVersion	POST /projectVersions	create
deleteProjectVersion	DELETE /projectVersions/{id}	delete
doActionProjectVersion	POST /projectVersions/{id}/action	doAction
doCollectionActionProjectVersion	POST /projectVersions/action	doCollectionAction
listProjectVersion	GET /projectVersions	list
purgeProjectVersion	POST /projectVersions/action/purge	purge
readProjectVersion	GET /projectVersions/{id}	read
refreshProjectVersion	POST /projectVersions/action/refresh	refresh
testProjectVersion	POST /projectVersions/action/test	test
trainAuditAssistantProjectVersion	POST /projectVersions/action/trainAuditAssistant	trainAuditAssistant
updateProjectVersion	PUT /projectVersions/{id}	update

auditByAuditAssistantProjectVersion

ApiResultVoid auditByAuditAssistantProjectVersion(resource)

auditByAuditAssistant

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
ProjectVersionAuditByAssistantRequest resource = new ProjectVersionAuditByAssistantRequest(); // ProjectVersionAuditByAssistantRequest | resource
try {
    ApiResultVoid result = apiInstance.auditByAuditAssistantProjectVersion(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#auditByAuditAssistantProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
resource	ProjectVersionAuditByAssistantRequest	resource

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

copyCurrentStateForProjectVersion

ApiResultVoid copyCurrentStateForProjectVersion(resource)

copyCurrentStateFor

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
ProjectVersionCopyCurrentStateRequest resource = new ProjectVersionCopyCurrentStateRequest(); // ProjectVersionCopyCurrentStateRequest | resource
try {
    ApiResultVoid result = apiInstance.copyCurrentStateForProjectVersion(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#copyCurrentStateForProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
resource	ProjectVersionCopyCurrentStateRequest	resource

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

copyProjectVersion

ApiResultVoid copyProjectVersion(resource)

copy

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
ProjectVersionCopyPartialRequest resource = new ProjectVersionCopyPartialRequest(); // ProjectVersionCopyPartialRequest | resource
try {
    ApiResultVoid result = apiInstance.copyProjectVersion(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#copyProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
resource	ProjectVersionCopyPartialRequest	resource

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

createProjectVersion

ApiResultProjectVersion createProjectVersion(resource)

create

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
ProjectVersion resource = new ProjectVersion(); // ProjectVersion | resource
try {
    ApiResultProjectVersion result = apiInstance.createProjectVersion(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#createProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
resource	ProjectVersion	resource

Return type

ApiResultProjectVersion

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteProjectVersion

ApiResultVoid deleteProjectVersion(id)

delete

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
Long id = 789L; // Long | id
try {
    ApiResultVoid result = apiInstance.deleteProjectVersion(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#deleteProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Long	id

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

doActionProjectVersion

ApiResultApiActionResponse doActionProjectVersion(id, resourceAction)

doAction

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
Long id = 789L; // Long | id
ApiResourceAction resourceAction = new ApiResourceAction(); // ApiResourceAction | resourceAction
try {
    ApiResultApiActionResponse result = apiInstance.doActionProjectVersion(id, resourceAction);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#doActionProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Long	id
resourceAction	ApiResourceAction	resourceAction

Return type

ApiResultApiActionResponse

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

doCollectionActionProjectVersion

ApiResultApiActionResponse doCollectionActionProjectVersion(collectionAction)

doCollectionAction

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
ApiCollectionActionlong collectionAction = new ApiCollectionActionlong(); // ApiCollectionActionlong | collectionAction
try {
    ApiResultApiActionResponse result = apiInstance.doCollectionActionProjectVersion(collectionAction);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#doCollectionActionProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
collectionAction	ApiCollectionActionlong	collectionAction

Return type

ApiResultApiActionResponse

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

listProjectVersion

ApiResultListProjectVersion listProjectVersion(fields, start, limit, q, fulltextsearch, orderby, includeInactive, myAssignedIssues, onlyIfHasIssues)

list

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
String fields = "fields_example"; // String | Output fields
Integer start = 0; // Integer | A start offset in object listing
Integer limit = 200; // Integer | A maximum number of returned objects in listing, if '-1' or '0' no limit is applied
String q = "q_example"; // String | A search-spec of full text search query (see fulltextsearch parameter)
Boolean fulltextsearch = false; // Boolean | If 'true', interpret 'q' parameter as full text search query, defaults to 'false'
String orderby = "orderby_example"; // String | Fields to order by
Boolean includeInactive = false; // Boolean | includeInactive
Boolean myAssignedIssues = false; // Boolean | myAssignedIssues
Boolean onlyIfHasIssues = false; // Boolean | onlyIfHasIssues
try {
    ApiResultListProjectVersion result = apiInstance.listProjectVersion(fields, start, limit, q, fulltextsearch, orderby, includeInactive, myAssignedIssues, onlyIfHasIssues);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#listProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
fields	String	Output fields	[optional]
start	Integer	A start offset in object listing	[optional] [default to 0]
limit	Integer	A maximum number of returned objects in listing, if '-1' or '0' no limit is applied	[optional] [default to 200]
q	String	A search-spec of full text search query (see fulltextsearch parameter)	[optional]
fulltextsearch	Boolean	If 'true', interpret 'q' parameter as full text search query, defaults to 'false'	[optional] [default to false]
orderby	String	Fields to order by	[optional]
includeInactive	Boolean	includeInactive	[optional] [default to false]
myAssignedIssues	Boolean	myAssignedIssues	[optional] [default to false]
onlyIfHasIssues	Boolean	onlyIfHasIssues	[optional] [default to false]

Return type

ApiResultListProjectVersion

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

purgeProjectVersion

ApiResultVoid purgeProjectVersion(resource)

purge

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
ProjectVersionPurgeRequest resource = new ProjectVersionPurgeRequest(); // ProjectVersionPurgeRequest | resource
try {
    ApiResultVoid result = apiInstance.purgeProjectVersion(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#purgeProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
resource	ProjectVersionPurgeRequest	resource

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

readProjectVersion

ApiResultProjectVersion readProjectVersion(id, fields)

read

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
Long id = 789L; // Long | id
String fields = "fields_example"; // String | Output fields
try {
    ApiResultProjectVersion result = apiInstance.readProjectVersion(id, fields);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#readProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Long	id
fields	String	Output fields	[optional]

Return type

ApiResultProjectVersion

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

refreshProjectVersion

ApiResultProjectVersionRefreshResponse refreshProjectVersion(resource)

refresh

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
ProjectVersionRefreshRequest resource = new ProjectVersionRefreshRequest(); // ProjectVersionRefreshRequest | resource
try {
    ApiResultProjectVersionRefreshResponse result = apiInstance.refreshProjectVersion(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#refreshProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
resource	ProjectVersionRefreshRequest	resource

Return type

ApiResultProjectVersionRefreshResponse

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

testProjectVersion

ApiResultProjectVersionTestResponse testProjectVersion(projectVersionTestRequest)

test

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
ProjectVersionTestRequest projectVersionTestRequest = new ProjectVersionTestRequest(); // ProjectVersionTestRequest | projectVersionTestRequest
try {
    ApiResultProjectVersionTestResponse result = apiInstance.testProjectVersion(projectVersionTestRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#testProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
projectVersionTestRequest	ProjectVersionTestRequest	projectVersionTestRequest

Return type

ApiResultProjectVersionTestResponse

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

trainAuditAssistantProjectVersion

ApiResultVoid trainAuditAssistantProjectVersion(resource)

trainAuditAssistant

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
ProjectVersionTrainAuditAssistantRequest resource = new ProjectVersionTrainAuditAssistantRequest(); // ProjectVersionTrainAuditAssistantRequest | resource
try {
    ApiResultVoid result = apiInstance.trainAuditAssistantProjectVersion(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#trainAuditAssistantProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
resource	ProjectVersionTrainAuditAssistantRequest	resource

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json

updateProjectVersion

ApiResultProjectVersion updateProjectVersion(id, resource)

update

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.ProjectVersionControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

ProjectVersionControllerApi apiInstance = new ProjectVersionControllerApi();
Long id = 789L; // Long | id
ProjectVersion resource = new ProjectVersion(); // ProjectVersion | resource
try {
    ApiResultProjectVersion result = apiInstance.updateProjectVersion(id, resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionControllerApi#updateProjectVersion");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Long	id
resource	ProjectVersion	resource

Return type

ApiResultProjectVersion

Authorization

FortifyToken

HTTP request headers

• Content-Type: application/json
• Accept: application/json