Skip to content

Latest commit

 

History

History
238 lines (178 loc) · 9.26 KB

ProjectVersionOfCloudPoolControllerApi.md

File metadata and controls

238 lines (178 loc) · 9.26 KB

ProjectVersionOfCloudPoolControllerApi

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

Method HTTP request Description
assignProjectVersionOfCloudPool POST /cloudpools/{parentId}/versions/action/assign assign
doActionProjectVersionOfCloudPool POST /cloudpools/{parentId}/versions/action doAction
listProjectVersionOfCloudPool GET /cloudpools/{parentId}/versions list
replaceProjectVersionOfCloudPool POST /cloudpools/{parentId}/versions/action/replace replace

assignProjectVersionOfCloudPool

ApiResultCloudPoolProjectVersionActionResponse assignProjectVersionOfCloudPool(parentId, resource)

assign

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.ProjectVersionOfCloudPoolControllerApi;

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");

ProjectVersionOfCloudPoolControllerApi apiInstance = new ProjectVersionOfCloudPoolControllerApi();
String parentId = "parentId_example"; // String | parentId
CloudPoolProjectVersionAssignRequest resource = new CloudPoolProjectVersionAssignRequest(); // CloudPoolProjectVersionAssignRequest | resource
try {
    ApiResultCloudPoolProjectVersionActionResponse result = apiInstance.assignProjectVersionOfCloudPool(parentId, resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionOfCloudPoolControllerApi#assignProjectVersionOfCloudPool");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
parentId String parentId
resource CloudPoolProjectVersionAssignRequest resource

Return type

ApiResultCloudPoolProjectVersionActionResponse

Authorization

FortifyToken

HTTP request headers

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

doActionProjectVersionOfCloudPool

ApiResultApiActionResponse doActionProjectVersionOfCloudPool(parentId, collectionAction)

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.ProjectVersionOfCloudPoolControllerApi;

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");

ProjectVersionOfCloudPoolControllerApi apiInstance = new ProjectVersionOfCloudPoolControllerApi();
String parentId = "parentId_example"; // String | parentId
ApiCollectionActionlong collectionAction = new ApiCollectionActionlong(); // ApiCollectionActionlong | collectionAction
try {
    ApiResultApiActionResponse result = apiInstance.doActionProjectVersionOfCloudPool(parentId, collectionAction);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionOfCloudPoolControllerApi#doActionProjectVersionOfCloudPool");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
parentId String parentId
collectionAction ApiCollectionActionlong collectionAction

Return type

ApiResultApiActionResponse

Authorization

FortifyToken

HTTP request headers

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

listProjectVersionOfCloudPool

ApiResultListProjectVersion listProjectVersionOfCloudPool(parentId, fields, start, limit, orderby)

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.ProjectVersionOfCloudPoolControllerApi;

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");

ProjectVersionOfCloudPoolControllerApi apiInstance = new ProjectVersionOfCloudPoolControllerApi();
String parentId = "parentId_example"; // String | parentId
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 orderby = "orderby_example"; // String | Fields to order by
try {
    ApiResultListProjectVersion result = apiInstance.listProjectVersionOfCloudPool(parentId, fields, start, limit, orderby);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionOfCloudPoolControllerApi#listProjectVersionOfCloudPool");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
parentId String parentId
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]
orderby String Fields to order by [optional]

Return type

ApiResultListProjectVersion

Authorization

FortifyToken

HTTP request headers

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

replaceProjectVersionOfCloudPool

ApiResultCloudPoolProjectVersionActionResponse replaceProjectVersionOfCloudPool(parentId, resource)

replace

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.ProjectVersionOfCloudPoolControllerApi;

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");

ProjectVersionOfCloudPoolControllerApi apiInstance = new ProjectVersionOfCloudPoolControllerApi();
String parentId = "parentId_example"; // String | parentId
CloudPoolProjectVersionReplaceRequest resource = new CloudPoolProjectVersionReplaceRequest(); // CloudPoolProjectVersionReplaceRequest | resource
try {
    ApiResultCloudPoolProjectVersionActionResponse result = apiInstance.replaceProjectVersionOfCloudPool(parentId, resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProjectVersionOfCloudPoolControllerApi#replaceProjectVersionOfCloudPool");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
parentId String parentId
resource CloudPoolProjectVersionReplaceRequest resource

Return type

ApiResultCloudPoolProjectVersionActionResponse

Authorization

FortifyToken

HTTP request headers

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