All URIs are relative to https://SSC:8080/ssc/api/v1
Method | HTTP request | Description |
---|---|---|
createAttributeDefinition | POST /attributeDefinitions | create |
deleteAttributeDefinition | DELETE /attributeDefinitions/{id} | delete |
listAttributeDefinition | GET /attributeDefinitions | list |
multiDeleteAttributeDefinition | DELETE /attributeDefinitions | multiDelete |
readAttributeDefinition | GET /attributeDefinitions/{id} | read |
updateAttributeDefinition | PUT /attributeDefinitions/{id} | update |
ApiResultAttributeDefinition createAttributeDefinition(resource)
create
// 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.AttributeDefinitionControllerApi;
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");
AttributeDefinitionControllerApi apiInstance = new AttributeDefinitionControllerApi();
AttributeDefinition resource = new AttributeDefinition(); // AttributeDefinition | resource
try {
ApiResultAttributeDefinition result = apiInstance.createAttributeDefinition(resource);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AttributeDefinitionControllerApi#createAttributeDefinition");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
resource | AttributeDefinition | resource |
- Content-Type: application/json
- Accept: application/json
ApiResultVoid deleteAttributeDefinition(id)
delete
// 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.AttributeDefinitionControllerApi;
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");
AttributeDefinitionControllerApi apiInstance = new AttributeDefinitionControllerApi();
Long id = 789L; // Long | id
try {
ApiResultVoid result = apiInstance.deleteAttributeDefinition(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AttributeDefinitionControllerApi#deleteAttributeDefinition");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | Long | id |
- Content-Type: application/json
- Accept: application/json
ApiResultListAttributeDefinition listAttributeDefinition(fields, start, limit, q, orderby)
list
// 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.AttributeDefinitionControllerApi;
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");
AttributeDefinitionControllerApi apiInstance = new AttributeDefinitionControllerApi();
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 orderby = "orderby_example"; // String | Fields to order by
try {
ApiResultListAttributeDefinition result = apiInstance.listAttributeDefinition(fields, start, limit, q, orderby);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AttributeDefinitionControllerApi#listAttributeDefinition");
e.printStackTrace();
}
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] |
orderby | String | Fields to order by | [optional] |
ApiResultListAttributeDefinition
- Content-Type: application/json
- Accept: application/json
ApiResultVoid multiDeleteAttributeDefinition(ids)
multiDelete
// 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.AttributeDefinitionControllerApi;
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");
AttributeDefinitionControllerApi apiInstance = new AttributeDefinitionControllerApi();
String ids = "ids_example"; // String | A comma-separated list of resource identifiers
try {
ApiResultVoid result = apiInstance.multiDeleteAttributeDefinition(ids);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AttributeDefinitionControllerApi#multiDeleteAttributeDefinition");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
ids | String | A comma-separated list of resource identifiers |
- Content-Type: application/json
- Accept: application/json
ApiResultAttributeDefinition readAttributeDefinition(id, fields)
read
// 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.AttributeDefinitionControllerApi;
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");
AttributeDefinitionControllerApi apiInstance = new AttributeDefinitionControllerApi();
Long id = 789L; // Long | id
String fields = "fields_example"; // String | Output fields
try {
ApiResultAttributeDefinition result = apiInstance.readAttributeDefinition(id, fields);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AttributeDefinitionControllerApi#readAttributeDefinition");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | Long | id | |
fields | String | Output fields | [optional] |
- Content-Type: application/json
- Accept: application/json
ApiResultAttributeDefinition updateAttributeDefinition(id, resource)
update
// 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.AttributeDefinitionControllerApi;
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");
AttributeDefinitionControllerApi apiInstance = new AttributeDefinitionControllerApi();
Long id = 789L; // Long | id
AttributeDefinition resource = new AttributeDefinition(); // AttributeDefinition | resource
try {
ApiResultAttributeDefinition result = apiInstance.updateAttributeDefinition(id, resource);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AttributeDefinitionControllerApi#updateAttributeDefinition");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
id | Long | id | |
resource | AttributeDefinition | resource |
- Content-Type: application/json
- Accept: application/json