Skip to content

Latest commit

 

History

History
292 lines (218 loc) · 8.96 KB

JobControllerApi.md

File metadata and controls

292 lines (218 loc) · 8.96 KB
Raw

JobControllerApi

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

Method HTTP request Description
cancelJob POST /jobs/action/cancel cancel
doActionJob POST /jobs/{jobName}/action doAction
listJob GET /jobs list
readJob GET /jobs/{jobName} read
updateJob PUT /jobs/{jobName} update

cancelJob

ApiResultVoid cancelJob(resource)

cancel

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

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

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

Parameters

Name Type Description Notes
resource JobCancelRequest resource

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

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

doActionJob

ApiResultApiActionResponse doActionJob(jobName, 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.JobControllerApi;

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

JobControllerApi apiInstance = new JobControllerApi();
String jobName = "jobName_example"; // String | jobName
ApiResourceAction resourceAction = new ApiResourceAction(); // ApiResourceAction | resourceAction
try {
    ApiResultApiActionResponse result = apiInstance.doActionJob(jobName, resourceAction);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling JobControllerApi#doActionJob");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobName String jobName
resourceAction ApiResourceAction resourceAction

Return type

ApiResultApiActionResponse

Authorization

FortifyToken

HTTP request headers

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

listJob

ApiResultListJob listJob(fields, start, limit, q, 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.JobControllerApi;

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

JobControllerApi apiInstance = new JobControllerApi();
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 query
String orderby = "orderby_example"; // String | Fields to order by
try {
    ApiResultListJob result = apiInstance.listJob(fields, start, limit, q, orderby);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling JobControllerApi#listJob");
    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 query [optional]
orderby String Fields to order by [optional]

Return type

ApiResultListJob

Authorization

FortifyToken

HTTP request headers

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

readJob

ApiResultJob readJob(jobName, 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.JobControllerApi;

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

JobControllerApi apiInstance = new JobControllerApi();
String jobName = "jobName_example"; // String | jobName
String fields = "fields_example"; // String | Output fields
try {
    ApiResultJob result = apiInstance.readJob(jobName, fields);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling JobControllerApi#readJob");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobName String jobName
fields String Output fields [optional]

Return type

ApiResultJob

Authorization

FortifyToken

HTTP request headers

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

updateJob

ApiResultJob updateJob(jobName, 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.JobControllerApi;

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

JobControllerApi apiInstance = new JobControllerApi();
String jobName = "jobName_example"; // String | jobName
Job resource = new Job(); // Job | resource
try {
    ApiResultJob result = apiInstance.updateJob(jobName, resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling JobControllerApi#updateJob");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobName String jobName
resource Job resource

Return type

ApiResultJob

Authorization

FortifyToken

HTTP request headers

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