openapi-java-client

FileApi

• API version: 0.13
  • Build date: 2025-11-10T19:26:24.374477156+01:00[Europe/Brussels]
  • Generator version: 7.17.0

File Api V1

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-java-client</artifactId>
  <version>0.13</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'openapi-java-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'openapi-java-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "org.openapitools:openapi-java-client:0.13"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/openapi-java-client-0.13.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TemplateRoutesApi;

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

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
TemplateRoutesApi	deleteTemplById	DELETE /api/v1/template/{id}
TemplateRoutesApi	findAll	GET /api/v1/template/find-all
TemplateRoutesApi	findByContext	GET /api/v1/template/find-by-context
TemplateRoutesApi	findByIds	GET /api/v1/template/find-by-ids
TemplateRoutesApi	findByType	GET /api/v1/template/find-by-type
TemplateRoutesApi	findOne	GET /api/v1/template/find-one/{templ_id}
TemplateRoutesApi	render	POST /api/v1/template/render
TemplateRoutesApi	upsert	POST /api/v1/template
UploadRoutesApi	deleteById	DELETE /api/v1/upload/{id}
UploadRoutesApi	download	GET /api/v1/upload/download
UploadRoutesApi	downloadBulk	POST /api/v1/upload/download-bulk
UploadRoutesApi	findAllUploads	GET /api/v1/upload/find-all
UploadRoutesApi	makeThumb	POST /api/v1/upload/{id}/make-thumb
UploadRoutesApi	metadata	GET /api/v1/upload/metadata
UploadRoutesApi	ping	GET /api/v1/upload/ping
UploadRoutesApi	upload	POST /api/v1/upload
UploadRoutesApi	uploadUpdate	POST /api/v1/upload/{id}/update

Documentation for Models

• Context
• DownloadBulkRequestUriParams
• DownloadFileRequestUriParams
• FileUploadV2
• FindAllQueryParams
• OpenApiDocUploadFormSimpleFile
• RenderRequest
• TemplateType
• TemplateUpsert
• TemplateV2
• UploadFileRequestUriParams

Documentation for Authorization

Endpoints do not require authorization.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author