Skip to content

Latest commit

 

History

History
234 lines (174 loc) · 8.06 KB

AttributeOfProjectVersionControllerApi.md

File metadata and controls

234 lines (174 loc) · 8.06 KB
Raw

AttributeOfProjectVersionControllerApi

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

Method HTTP request Description
createAttributeOfProjectVersion POST /projectVersions/{parentId}/attributes create
listAttributeOfProjectVersion GET /projectVersions/{parentId}/attributes list
readAttributeOfProjectVersion GET /projectVersions/{parentId}/attributes/{id} read
updateCollectionAttributeOfProjectVersion PUT /projectVersions/{parentId}/attributes updateCollection

createAttributeOfProjectVersion

ApiResultAttribute createAttributeOfProjectVersion(parentId, 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.AttributeOfProjectVersionControllerApi;

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

AttributeOfProjectVersionControllerApi apiInstance = new AttributeOfProjectVersionControllerApi();
Long parentId = 789L; // Long | parentId
Attribute resource = new Attribute(); // Attribute | resource
try {
    ApiResultAttribute result = apiInstance.createAttributeOfProjectVersion(parentId, resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AttributeOfProjectVersionControllerApi#createAttributeOfProjectVersion");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
parentId Long parentId
resource Attribute resource

Return type

ApiResultAttribute

Authorization

FortifyToken

HTTP request headers

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

listAttributeOfProjectVersion

ApiResultListAttribute listAttributeOfProjectVersion(parentId, 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.AttributeOfProjectVersionControllerApi;

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

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

Parameters

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

Return type

ApiResultListAttribute

Authorization

FortifyToken

HTTP request headers

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

readAttributeOfProjectVersion

ApiResultAttribute readAttributeOfProjectVersion(parentId, 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.AttributeOfProjectVersionControllerApi;

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

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

Parameters

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

Return type

ApiResultAttribute

Authorization

FortifyToken

HTTP request headers

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

updateCollectionAttributeOfProjectVersion

ApiResultListAttribute updateCollectionAttributeOfProjectVersion(parentId, data)

updateCollection

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

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

AttributeOfProjectVersionControllerApi apiInstance = new AttributeOfProjectVersionControllerApi();
Long parentId = 789L; // Long | parentId
List<Attribute> data = Arrays.asList(new Attribute()); // List<Attribute> | data
try {
    ApiResultListAttribute result = apiInstance.updateCollectionAttributeOfProjectVersion(parentId, data);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AttributeOfProjectVersionControllerApi#updateCollectionAttributeOfProjectVersion");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
parentId Long parentId
data List<Attribute> data

Return type

ApiResultListAttribute

Authorization

FortifyToken

HTTP request headers

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