Skip to content

FileApi.md

Latest commit

 

History

History
219 lines (158 loc) · 6.12 KB

FileApi.md

File metadata and controls

219 lines (158 loc) · 6.12 KB
Raw

FileApi

All URIs are relative to http://localhost:8443

Method HTTP request Description
download2 GET /api/v1/files/{id} Downloads a file.
getUploadUrl GET /api/v1/files/upload-url Returns an upload URL.
getUploadUrls GET /api/v1/files/upload-urls Returns multiple upload URLs.

download2

download2(id)

Downloads a file.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.FileApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        FileApi apiInstance = new FileApi(defaultClient);
        Long id = 56L; // Long | 
        try {
            apiInstance.download2(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileApi#download2");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id Long

Return type

null (empty response body)

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

getUploadUrl

FileResource getUploadUrl(projectId)

Returns an upload URL.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.FileApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        FileApi apiInstance = new FileApi(defaultClient);
        Long projectId = 56L; // Long | 
        try {
            FileResource result = apiInstance.getUploadUrl(projectId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileApi#getUploadUrl");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
projectId Long

Return type

FileResource

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -

getUploadUrls

List<FileResource> getUploadUrls(projectId, numberUrl)

Returns multiple upload URLs.

Example

// Import classes:
import com.katalon.testops.api.ApiClient;
import com.katalon.testops.api.ApiException;
import com.katalon.testops.api.Configuration;
import com.katalon.testops.api.auth.*;
import com.katalon.testops.api.models.*;
import com.katalon.testops.api.api.FileApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost:8443");
        
        // Configure HTTP basic authorization: basicScheme
        HttpBasicAuth basicScheme = (HttpBasicAuth) defaultClient.getAuthentication("basicScheme");
        basicScheme.setUsername("YOUR USERNAME");
        basicScheme.setPassword("YOUR PASSWORD");

        FileApi apiInstance = new FileApi(defaultClient);
        Long projectId = 56L; // Long | 
        Long numberUrl = 56L; // Long | 
        try {
            List<FileResource> result = apiInstance.getUploadUrls(projectId, numberUrl);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FileApi#getUploadUrls");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
projectId Long
numberUrl Long

Return type

List<FileResource>

Authorization

basicScheme

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 OK -