Skip to content

Latest commit

 

History

History
288 lines (214 loc) · 8.66 KB

PersonaControllerApi.md

File metadata and controls

288 lines (214 loc) · 8.66 KB
Raw

PersonaControllerApi

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

Method HTTP request Description
createPersona POST /personas create
deletePersona DELETE /personas/{id} delete
listPersona GET /personas list
readPersona GET /personas/{id} read
updatePersona PUT /personas/{id} update

createPersona

ApiResultPersona createPersona(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.PersonaControllerApi;

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

PersonaControllerApi apiInstance = new PersonaControllerApi();
Persona resource = new Persona(); // Persona | resource
try {
    ApiResultPersona result = apiInstance.createPersona(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonaControllerApi#createPersona");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
resource Persona resource

Return type

ApiResultPersona

Authorization

FortifyToken

HTTP request headers

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

deletePersona

ApiResultVoid deletePersona(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.PersonaControllerApi;

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

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

listPersona

ApiResultListPersona listPersona(start, limit, q, fields)

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

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

PersonaControllerApi apiInstance = new PersonaControllerApi();
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 fields = "fields_example"; // String | Output fields
try {
    ApiResultListPersona result = apiInstance.listPersona(start, limit, q, fields);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling PersonaControllerApi#listPersona");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
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]
fields String Output fields [optional]

Return type

ApiResultListPersona

Authorization

FortifyToken

HTTP request headers

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

readPersona

ApiResultPersona readPersona(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.PersonaControllerApi;

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

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

Parameters

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

Return type

ApiResultPersona

Authorization

FortifyToken

HTTP request headers

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

updatePersona

ApiResultPersona updatePersona(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.PersonaControllerApi;

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

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

Parameters

Name Type Description Notes
id Long id
resource Persona resource

Return type

ApiResultPersona

Authorization

FortifyToken

HTTP request headers

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