Skip to content

Latest commit

 

History

History
240 lines (180 loc) · 8.09 KB

SavedReportControllerApi.md

File metadata and controls

240 lines (180 loc) · 8.09 KB
Raw

SavedReportControllerApi

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

Method HTTP request Description
createSavedReport POST /reports create
deleteSavedReport DELETE /reports/{id} delete
listSavedReport GET /reports list
readSavedReport GET /reports/{id} read

createSavedReport

ApiResultSavedReport createSavedReport(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.SavedReportControllerApi;

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

SavedReportControllerApi apiInstance = new SavedReportControllerApi();
SavedReport resource = new SavedReport(); // SavedReport | resource
try {
    ApiResultSavedReport result = apiInstance.createSavedReport(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SavedReportControllerApi#createSavedReport");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
resource SavedReport resource

Return type

ApiResultSavedReport

Authorization

FortifyToken

HTTP request headers

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

deleteSavedReport

ApiResultVoid deleteSavedReport(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.SavedReportControllerApi;

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

SavedReportControllerApi apiInstance = new SavedReportControllerApi();
Long id = 789L; // Long | id
try {
    ApiResultVoid result = apiInstance.deleteSavedReport(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SavedReportControllerApi#deleteSavedReport");
    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

listSavedReport

ApiResultListSavedReport listSavedReport(fields, start, limit, q, fulltextsearch, embed, 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.SavedReportControllerApi;

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

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

Return type

ApiResultListSavedReport

Authorization

FortifyToken

HTTP request headers

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

readSavedReport

ApiResultSavedReport readSavedReport(id, fields, embed)

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

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

SavedReportControllerApi apiInstance = new SavedReportControllerApi();
Long id = 789L; // Long | id
String fields = "fields_example"; // String | Output fields
String embed = "embed_example"; // String | Fields to embed
try {
    ApiResultSavedReport result = apiInstance.readSavedReport(id, fields, embed);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SavedReportControllerApi#readSavedReport");
    e.printStackTrace();
}

Parameters

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

Return type

ApiResultSavedReport

Authorization

FortifyToken

HTTP request headers

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