Skip to content

Latest commit

 

History

History
344 lines (256 loc) · 11.4 KB

ReportDefinitionControllerApi.md

File metadata and controls

344 lines (256 loc) · 11.4 KB
Raw

ReportDefinitionControllerApi

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

Method HTTP request Description
createReportDefinition POST /reportDefinitions create
deleteReportDefinition DELETE /reportDefinitions/{id} delete
listReportDefinition GET /reportDefinitions list
multiDeleteReportDefinition DELETE /reportDefinitions multiDelete
readReportDefinition GET /reportDefinitions/{id} read
updateReportDefinition PUT /reportDefinitions/{id} update

createReportDefinition

ApiResultReportDefinition createReportDefinition(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.ReportDefinitionControllerApi;

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

ReportDefinitionControllerApi apiInstance = new ReportDefinitionControllerApi();
ReportDefinition resource = new ReportDefinition(); // ReportDefinition | resource
try {
    ApiResultReportDefinition result = apiInstance.createReportDefinition(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReportDefinitionControllerApi#createReportDefinition");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
resource ReportDefinition resource

Return type

ApiResultReportDefinition

Authorization

FortifyToken

HTTP request headers

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

deleteReportDefinition

ApiResultVoid deleteReportDefinition(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.ReportDefinitionControllerApi;

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

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

listReportDefinition

ApiResultListReportDefinition listReportDefinition(fields, start, limit, q, groupby)

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

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

ReportDefinitionControllerApi apiInstance = new ReportDefinitionControllerApi();
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 groupby = "groupby_example"; // String | Fields to group by
try {
    ApiResultListReportDefinition result = apiInstance.listReportDefinition(fields, start, limit, q, groupby);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReportDefinitionControllerApi#listReportDefinition");
    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]
groupby String Fields to group by [optional]

Return type

ApiResultListReportDefinition

Authorization

FortifyToken

HTTP request headers

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

multiDeleteReportDefinition

ApiResultVoid multiDeleteReportDefinition(ids)

multiDelete

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

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

ReportDefinitionControllerApi apiInstance = new ReportDefinitionControllerApi();
String ids = "ids_example"; // String | A comma-separated list of resource identifiers
try {
    ApiResultVoid result = apiInstance.multiDeleteReportDefinition(ids);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ReportDefinitionControllerApi#multiDeleteReportDefinition");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
ids String A comma-separated list of resource identifiers

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

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

readReportDefinition

ApiResultReportDefinition readReportDefinition(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.ReportDefinitionControllerApi;

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

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

Parameters

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

Return type

ApiResultReportDefinition

Authorization

FortifyToken

HTTP request headers

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

updateReportDefinition

ApiResultReportDefinition updateReportDefinition(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.ReportDefinitionControllerApi;

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

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

Parameters

Name Type Description Notes
id Long id
resource ReportDefinition resource

Return type

ApiResultReportDefinition

Authorization

FortifyToken

HTTP request headers

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