Skip to content

Latest commit

 

History

History
128 lines (96 loc) · 4.66 KB

CloudWorkerControllerApi.md

File metadata and controls

128 lines (96 loc) · 4.66 KB
Raw

CloudWorkerControllerApi

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

Method HTTP request Description
listCloudWorker GET /cloudworkers list
readCloudWorker GET /cloudworkers/{uuid} read

listCloudWorker

ApiResultListCloudWorker listCloudWorker(fields, start, limit, q, fulltextsearch, 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.CloudWorkerControllerApi;

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

CloudWorkerControllerApi apiInstance = new CloudWorkerControllerApi();
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
try {
    ApiResultListCloudWorker result = apiInstance.listCloudWorker(fields, start, limit, q, fulltextsearch, orderby);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CloudWorkerControllerApi#listCloudWorker");
    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]

Return type

ApiResultListCloudWorker

Authorization

FortifyToken

HTTP request headers

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

readCloudWorker

ApiResultCloudWorker readCloudWorker(uuid, 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.CloudWorkerControllerApi;

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

CloudWorkerControllerApi apiInstance = new CloudWorkerControllerApi();
String uuid = "uuid_example"; // String | uuid
String fields = "fields_example"; // String | Output fields
try {
    ApiResultCloudWorker result = apiInstance.readCloudWorker(uuid, fields);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CloudWorkerControllerApi#readCloudWorker");
    e.printStackTrace();
}

Parameters

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

Return type

ApiResultCloudWorker

Authorization

FortifyToken

HTTP request headers

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