org.bonitasoft.web.client.api.BdmApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bonita-java-client Show documentation
Java client for Bonita REST API
The newest version!
/** 
 * Copyright (C) 2024 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2.0 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package org.bonitasoft.web.client.api;

import java.io.File;
import java.util.HashMap;
import java.util.List;

import org.bonitasoft.web.client.invoker.ApiClient;
import org.bonitasoft.web.client.invoker.EncodingUtils;
import org.bonitasoft.web.client.model.ApiResponse;
import org.bonitasoft.web.client.model.BDMInstallRequest;
import org.bonitasoft.web.client.model.Bdm;
import org.bonitasoft.web.client.model.BusinessData;

import feign.*;

@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0")
public interface BdmApi extends ApiClient.Api {

    /**
     * Get the BDM
     * Returns the current BDM. Make this call to get the status the BDM.
     * 
     * @return Bdm
     */
    @RequestLine("GET /API/tenant/bdm")
    @Headers({
            "Accept: application/json",
    })
    Bdm getBdm();

    /**
     * Get the BDM
     * Similar to getBdm but it also returns the http response headers .
     * Returns the current BDM. Make this call to get the status the BDM.
     * 
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("GET /API/tenant/bdm")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse getBdmWithHttpInfo();

    /**
     * Install a BDM
     * Install a BDM Warning: as of 9.0.0, importing a BDM using this API is deprecated.
     * 
     * @param bdMInstallRequest (optional)
     * @deprecated
     */
    @Deprecated
    @RequestLine("POST /API/tenant/bdm")
    @Headers({
            "Content-Type: application/json",
            "Accept: application/json",
    })
    void installBDM(BDMInstallRequest bdMInstallRequest);

    /**
     * Install a BDM
     * Similar to installBDM but it also returns the http response headers .
     * Install a BDM Warning: as of 9.0.0, importing a BDM using this API is deprecated.
     * 
     * @param bdMInstallRequest (optional)
     * @deprecated
     */
    @Deprecated
    @RequestLine("POST /API/tenant/bdm")
    @Headers({
            "Content-Type: application/json",
            "Accept: application/json",
    })
    ApiResponse installBDMWithHttpInfo(BDMInstallRequest bdMInstallRequest);

    /**
     * Finds business data attribute by id
     * Gets the business data attribute of business data according to its identifier and attribute name. Request url.
     * 
     * @param businessDataType Business Data Type (required)
     * @param persistenceId Business data ID (required)
     * @param attributeName Business data attribute name (required)
     * @return BusinessData
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}/{persistenceId}/{attributeName}")
    @Headers({
            "Accept: application/json",
    })
    BusinessData searchBusinessDataAttributeById(@Param("businessDataType") String businessDataType,
            @Param("persistenceId") String persistenceId, @Param("attributeName") String attributeName);

    /**
     * Finds business data attribute by id
     * Similar to searchBusinessDataAttributeById but it also returns the http response headers .
     * Gets the business data attribute of business data according to its identifier and attribute name. Request url.
     * 
     * @param businessDataType Business Data Type (required)
     * @param persistenceId Business data ID (required)
     * @param attributeName Business data attribute name (required)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}/{persistenceId}/{attributeName}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse searchBusinessDataAttributeByIdWithHttpInfo(
            @Param("businessDataType") String businessDataType, @Param("persistenceId") String persistenceId,
            @Param("attributeName") String attributeName);

    /**
     * Finds business data by Id
     * Finds business data specified by its identifier.
     * 
     * @param businessDataType Business Data Type (required)
     * @param persistenceId Business data ID (required)
     * @return BusinessData
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}/{persistenceId}")
    @Headers({
            "Accept: application/json",
    })
    BusinessData searchBusinessDataById(@Param("businessDataType") String businessDataType,
            @Param("persistenceId") String persistenceId);

    /**
     * Finds business data by Id
     * Similar to searchBusinessDataById but it also returns the http response headers .
     * Finds business data specified by its identifier.
     * 
     * @param businessDataType Business Data Type (required)
     * @param persistenceId Business data ID (required)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}/{persistenceId}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse searchBusinessDataByIdWithHttpInfo(@Param("businessDataType") String businessDataType,
            @Param("persistenceId") String persistenceId);

    /**
     * Finds business data By Ids
     * Finds business data specified by their identifiers.
     * 
     * @param businessDataType Business Data Type (required)
     * @param ids list of persistenceIds (comma separated) (required)
     * @return List<BusinessData>
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}/findByIds?ids={ids}")
    @Headers({
            "Accept: application/json",
    })
    List searchBusinessDataByIds(@Param("businessDataType") String businessDataType,
            @Param("ids") String ids);

    /**
     * Finds business data By Ids
     * Similar to searchBusinessDataByIds but it also returns the http response headers .
     * Finds business data specified by their identifiers.
     * 
     * @param businessDataType Business Data Type (required)
     * @param ids list of persistenceIds (comma separated) (required)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}/findByIds?ids={ids}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse> searchBusinessDataByIdsWithHttpInfo(
            @Param("businessDataType") String businessDataType, @Param("ids") String ids);

    /**
     * Finds business data By Ids
     * Finds business data specified by their identifiers.
     * Note, this is equivalent to the other searchBusinessDataByIds method,
     * but with the query parameters collected into a single Map parameter. This
     * is convenient for services with optional query parameters, especially when
     * used with the {@link SearchBusinessDataByIdsQueryParams} class that allows for
     * building up this map in a fluent style.
     * 
     * @param businessDataType Business Data Type (required)
     * @param queryParams Map of query parameters as name-value pairs
     *        The following elements may be specified in the query map:
     *        
     *        ids - list of persistenceIds (comma separated) (required)
     *        
     * @return List<BusinessData>
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}/findByIds?ids={ids}")
    @Headers({
            "Accept: application/json",
    })
    List searchBusinessDataByIds(@Param("businessDataType") String businessDataType,
            @QueryMap(encoded = true) SearchBusinessDataByIdsQueryParams queryParams);

    /**
     * Finds business data By Ids
     * Finds business data specified by their identifiers.
     * Note, this is equivalent to the other searchBusinessDataByIds that receives the query parameters as a map,
     * but this one also exposes the Http response headers
     * 
     * @param businessDataType Business Data Type (required)
     * @param queryParams Map of query parameters as name-value pairs
     *        The following elements may be specified in the query map:
     *        
     *        ids - list of persistenceIds (comma separated) (required)
     *        
     * @return List<BusinessData>
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}/findByIds?ids={ids}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse> searchBusinessDataByIdsWithHttpInfo(
            @Param("businessDataType") String businessDataType,
            @QueryMap(encoded = true) SearchBusinessDataByIdsQueryParams queryParams);

    /**
     * A convenience class for generating query parameters for the
     * searchBusinessDataByIds method in a fluent style.
     */
    public static class SearchBusinessDataByIdsQueryParams extends HashMap {

        public SearchBusinessDataByIdsQueryParams ids(final String value) {
            put("ids", EncodingUtils.encode(value));
            return this;
        }
    }

    /**
     * Upload a file
     * Upload file. **NOTE:** If this file is a BDM zip, to do this, your tenant services need to be paused. In Enterprise editions, if you have an access control
     * file installed on your tenant, you need to delete it before installing or updating your BDM.
     * 
     * @param file (optional)
     * @return String
     */
    @RequestLine("POST /portal/fileUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json,text/plain",
    })
    String uploadFile(@Param("file") File file);

    /**
     * Upload a file
     * Similar to uploadFile but it also returns the http response headers .
     * Upload file. **NOTE:** If this file is a BDM zip, to do this, your tenant services need to be paused. In Enterprise editions, if you have an access control
     * file installed on your tenant, you need to delete it before installing or updating your BDM.
     * 
     * @param file (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("POST /portal/fileUpload")
    @Headers({
            "Content-Type: multipart/form-data",
            "Accept: application/json,text/plain",
    })
    ApiResponse uploadFileWithHttpInfo(@Param("file") File file);

}