Skip to content

Latest commit

 

History

History
350 lines (262 loc) · 12 KB

IssueAttachmentOfIssueControllerApi.md

File metadata and controls

350 lines (262 loc) · 12 KB
Raw

IssueAttachmentOfIssueControllerApi

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

Method HTTP request Description
createIssueAttachmentOfIssue POST /issues/{parentId}/attachments create
deleteIssueAttachmentOfIssue DELETE /issues/{parentId}/attachments/{id} delete
listIssueAttachmentOfIssue GET /issues/{parentId}/attachments list
multiDeleteIssueAttachmentOfIssue DELETE /issues/{parentId}/attachments multiDelete
readIssueAttachmentOfIssue GET /issues/{parentId}/attachments/{id} read
updateIssueAttachmentOfIssue PUT /issues/{parentId}/attachments/{id} update

createIssueAttachmentOfIssue

ApiResultIssueAttachment createIssueAttachmentOfIssue(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.IssueAttachmentOfIssueControllerApi;

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

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

Parameters

Name Type Description Notes
parentId Long parentId
resource IssueAttachment resource

Return type

ApiResultIssueAttachment

Authorization

FortifyToken

HTTP request headers

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

deleteIssueAttachmentOfIssue

ApiResultVoid deleteIssueAttachmentOfIssue(parentId, 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.IssueAttachmentOfIssueControllerApi;

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

IssueAttachmentOfIssueControllerApi apiInstance = new IssueAttachmentOfIssueControllerApi();
Long parentId = 789L; // Long | parentId
Long id = 789L; // Long | id
try {
    ApiResultVoid result = apiInstance.deleteIssueAttachmentOfIssue(parentId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueAttachmentOfIssueControllerApi#deleteIssueAttachmentOfIssue");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
parentId Long parentId
id Long id

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

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

listIssueAttachmentOfIssue

ApiResultListIssueAttachment listIssueAttachmentOfIssue(parentId, 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.IssueAttachmentOfIssueControllerApi;

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

IssueAttachmentOfIssueControllerApi apiInstance = new IssueAttachmentOfIssueControllerApi();
Long parentId = 789L; // Long | parentId
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 {
    ApiResultListIssueAttachment result = apiInstance.listIssueAttachmentOfIssue(parentId, start, limit);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueAttachmentOfIssueControllerApi#listIssueAttachmentOfIssue");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
parentId Long parentId
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

ApiResultListIssueAttachment

Authorization

FortifyToken

HTTP request headers

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

multiDeleteIssueAttachmentOfIssue

ApiResultVoid multiDeleteIssueAttachmentOfIssue(parentId, 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.IssueAttachmentOfIssueControllerApi;

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

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

Parameters

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

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

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

readIssueAttachmentOfIssue

ApiResultIssueAttachment readIssueAttachmentOfIssue(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.IssueAttachmentOfIssueControllerApi;

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

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

Parameters

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

Return type

ApiResultIssueAttachment

Authorization

FortifyToken

HTTP request headers

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

updateIssueAttachmentOfIssue

ApiResultIssueAttachment updateIssueAttachmentOfIssue(parentId, id, data)

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

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

IssueAttachmentOfIssueControllerApi apiInstance = new IssueAttachmentOfIssueControllerApi();
Long parentId = 789L; // Long | parentId
Long id = 789L; // Long | id
IssueAttachment data = new IssueAttachment(); // IssueAttachment | data
try {
    ApiResultIssueAttachment result = apiInstance.updateIssueAttachmentOfIssue(parentId, id, data);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueAttachmentOfIssueControllerApi#updateIssueAttachmentOfIssue");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
parentId Long parentId
id Long id
data IssueAttachment data

Return type

ApiResultIssueAttachment

Authorization

FortifyToken

HTTP request headers

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