Skip to content

Latest commit

 

History

History
126 lines (94 loc) · 4.16 KB

IssueControllerApi.md

File metadata and controls

126 lines (94 loc) · 4.16 KB
Raw

IssueControllerApi

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

Method HTTP request Description
listIssue GET /issues list
readIssue GET /issues/{id} read

listIssue

ApiResultListProjectVersionIssue listIssue(q, fulltextsearch, fields, start, limit)

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

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

IssueControllerApi apiInstance = new IssueControllerApi();
String q = "q_example"; // String | A full text search query
String fulltextsearch = "true"; // String | Only 'true' is supported
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
try {
    ApiResultListProjectVersionIssue result = apiInstance.listIssue(q, fulltextsearch, fields, start, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueControllerApi#listIssue");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
q String A full text search query
fulltextsearch String Only 'true' is supported [default to true] [enum: true]
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]

Return type

ApiResultListProjectVersionIssue

Authorization

FortifyToken

HTTP request headers

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

readIssue

ApiResultProjectVersionIssue readIssue(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.IssueControllerApi;

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

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

Parameters

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

Return type

ApiResultProjectVersionIssue

Authorization

FortifyToken

HTTP request headers

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