Skip to content

UploadRoutesApi.md

Latest commit

 

History

History
565 lines (427 loc) · 15.7 KB

UploadRoutesApi.md

File metadata and controls

565 lines (427 loc) · 15.7 KB

UploadRoutesApi

All URIs are relative to http://localhost

Method HTTP request Description
deleteById DELETE /api/v1/upload/{id}
download GET /api/v1/upload/download
downloadBulk POST /api/v1/upload/download-bulk
findAllUploads GET /api/v1/upload/find-all
makeThumb POST /api/v1/upload/{id}/make-thumb
metadata GET /api/v1/upload/metadata
ping GET /api/v1/upload/ping
upload POST /api/v1/upload
uploadUpdate POST /api/v1/upload/{id}/update

deleteById

deleteById(id)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.UploadRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    UploadRoutesApi apiInstance = new UploadRoutesApi(defaultClient);
    String id = "id_example"; // String | 
    try {
      apiInstance.deleteById(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling UploadRoutesApi#deleteById");
      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 String

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Delete a file by id -

download

File download(id)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.UploadRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    UploadRoutesApi apiInstance = new UploadRoutesApi(defaultClient);
    String id = "id_example"; // String | 
    try {
      File result = apiInstance.download(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UploadRoutesApi#download");
      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 String

Return type

File

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 Download file -

downloadBulk

File downloadBulk(downloadBulkRequestUriParams)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.UploadRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    UploadRoutesApi apiInstance = new UploadRoutesApi(defaultClient);
    DownloadBulkRequestUriParams downloadBulkRequestUriParams = new DownloadBulkRequestUriParams(); // DownloadBulkRequestUriParams | 
    try {
      File result = apiInstance.downloadBulk(downloadBulkRequestUriParams);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UploadRoutesApi#downloadBulk");
      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
downloadBulkRequestUriParams DownloadBulkRequestUriParams

Return type

File

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Download multiple files as a zip -

findAllUploads

List<FileUploadV2> findAllUploads(correlationId)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.UploadRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    UploadRoutesApi apiInstance = new UploadRoutesApi(defaultClient);
    String correlationId = "correlationId_example"; // String | 
    try {
      List<FileUploadV2> result = apiInstance.findAllUploads(correlationId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UploadRoutesApi#findAllUploads");
      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
correlationId String [optional]

Return type

List<FileUploadV2>

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Find all upload -

makeThumb

FileUploadV2 makeThumb(id)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.UploadRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    UploadRoutesApi apiInstance = new UploadRoutesApi(defaultClient);
    String id = "id_example"; // String | 
    try {
      FileUploadV2 result = apiInstance.makeThumb(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UploadRoutesApi#makeThumb");
      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 String

Return type

FileUploadV2

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Make thumbnail -

metadata

FileUploadV2 metadata(id)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.UploadRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    UploadRoutesApi apiInstance = new UploadRoutesApi(defaultClient);
    String id = "id_example"; // String | 
    try {
      FileUploadV2 result = apiInstance.metadata(id);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UploadRoutesApi#metadata");
      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 String

Return type

FileUploadV2

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Get upload metadata -

ping

ping()

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.UploadRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    UploadRoutesApi apiInstance = new UploadRoutesApi(defaultClient);
    try {
      apiInstance.ping();
    } catch (ApiException e) {
      System.err.println("Exception when calling UploadRoutesApi#ping");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Ping -

upload

List<FileUploadV2> upload(files, correlationId, isPublic, withoutThumbnail)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.UploadRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    UploadRoutesApi apiInstance = new UploadRoutesApi(defaultClient);
    List<File> files = Arrays.asList(); // List<File> | 
    String correlationId = "correlationId_example"; // String | 
    Boolean isPublic = true; // Boolean | 
    Boolean withoutThumbnail = true; // Boolean | 
    try {
      List<FileUploadV2> result = apiInstance.upload(files, correlationId, isPublic, withoutThumbnail);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UploadRoutesApi#upload");
      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
files List<File>
correlationId String [optional]
isPublic Boolean [optional]
withoutThumbnail Boolean [optional]

Return type

List<FileUploadV2>

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Upload a file -

uploadUpdate

FileUploadV2 uploadUpdate(id, _file, correlationId, isPublic, withoutThumbnail)

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.UploadRoutesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    UploadRoutesApi apiInstance = new UploadRoutesApi(defaultClient);
    String id = "id_example"; // String | 
    File _file = new File("/path/to/file"); // File | 
    String correlationId = "correlationId_example"; // String | 
    Boolean isPublic = true; // Boolean | 
    Boolean withoutThumbnail = true; // Boolean | 
    try {
      FileUploadV2 result = apiInstance.uploadUpdate(id, _file, correlationId, isPublic, withoutThumbnail);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling UploadRoutesApi#uploadUpdate");
      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 String
_file File
correlationId String [optional]
isPublic Boolean [optional]
withoutThumbnail Boolean [optional]

Return type

FileUploadV2

Authorization

No authorization required

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Upload (and update) a file -