All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

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.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 feign.*;

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

    /**
     * Finds Business Data
     * Finds Business Data with pagination params and filters by calling a `Named Query`. The business data query REST API resource is used to call a
     * default or custom business data query. It is available from version 6.5. **Data parameters**: * businessDataType - the fully-qualified business data type
     * name * q=queryName - the query name * p=0 - the page number * c=10 - the maximum number of results in the page * f=parameter=value -
     * sets the parameter value according to business data query parameters defined in Bonita Studio For a Boolean parameter, the accepted values are
     * `true` or `false`. By default, for a Date parameter can use the following formats: * yyyy-MM-dd * HH:mm:ss * yyyy-MM-dd HH:mm:ss *
     * yyyy-MM-dd'T'HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss.SSS
     * 
     * @param businessDataType Business Data Type (required)
     * @param q Named query to use (required)
     * @param p index of the page to display (required)
     * @param c maximum number of elements to retrieve (required)
     * @param f can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
     * @return List<Object>
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}?q={q}&p={p}&c={c}&f={f}")
    @Headers({
            "Accept: application/json",
    })
    List searchBusinessData(@Param("businessDataType") String businessDataType, @Param("q") String q,
            @Param("p") Integer p, @Param("c") Integer c, @Param("f") List f);

    /**
     * Finds Business Data
     * Similar to searchBusinessData but it also returns the http response headers .
     * Finds Business Data with pagination params and filters by calling a `Named Query`. The business data query REST API resource is used to call a
     * default or custom business data query. It is available from version 6.5. **Data parameters**: * businessDataType - the fully-qualified business data type
     * name * q=queryName - the query name * p=0 - the page number * c=10 - the maximum number of results in the page * f=parameter=value -
     * sets the parameter value according to business data query parameters defined in Bonita Studio For a Boolean parameter, the accepted values are
     * `true` or `false`. By default, for a Date parameter can use the following formats: * yyyy-MM-dd * HH:mm:ss * yyyy-MM-dd HH:mm:ss *
     * yyyy-MM-dd'T'HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss.SSS
     * 
     * @param businessDataType Business Data Type (required)
     * @param q Named query to use (required)
     * @param p index of the page to display (required)
     * @param c maximum number of elements to retrieve (required)
     * @param f can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
     * @return A ApiResponse that wraps the response boyd and the http headers.
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}?q={q}&p={p}&c={c}&f={f}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse> searchBusinessDataWithHttpInfo(@Param("businessDataType") String businessDataType,
            @Param("q") String q, @Param("p") Integer p, @Param("c") Integer c, @Param("f") List f);

    /**
     * Finds Business Data
     * Finds Business Data with pagination params and filters by calling a `Named Query`. The business data query REST API resource is used to call a
     * default or custom business data query. It is available from version 6.5. **Data parameters**: * businessDataType - the fully-qualified business data type
     * name * q=queryName - the query name * p=0 - the page number * c=10 - the maximum number of results in the page * f=parameter=value -
     * sets the parameter value according to business data query parameters defined in Bonita Studio For a Boolean parameter, the accepted values are
     * `true` or `false`. By default, for a Date parameter can use the following formats: * yyyy-MM-dd * HH:mm:ss * yyyy-MM-dd HH:mm:ss *
     * yyyy-MM-dd'T'HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss.SSS
     * Note, this is equivalent to the other searchBusinessData 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 SearchBusinessDataQueryParams} 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:

     *        
    
     *        
  • q - Named query to use (required)
    • 
     *        
  • p - index of the page to display (required)
    • 
     *        
  • c - maximum number of elements to retrieve (required)
    • 
     *        
  • f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string.
     *        (optional)
    • 
     *        

     * @return List<Object>
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}?q={q}&p={p}&c={c}&f={f}")
    @Headers({
            "Accept: application/json",
    })
    List searchBusinessData(@Param("businessDataType") String businessDataType,
            @QueryMap(encoded = true) SearchBusinessDataQueryParams queryParams);

    /**
     * Finds Business Data
     * Finds Business Data with pagination params and filters by calling a `Named Query`. The business data query REST API resource is used to call a
     * default or custom business data query. It is available from version 6.5. **Data parameters**: * businessDataType - the fully-qualified business data type
     * name * q=queryName - the query name * p=0 - the page number * c=10 - the maximum number of results in the page * f=parameter=value -
     * sets the parameter value according to business data query parameters defined in Bonita Studio For a Boolean parameter, the accepted values are
     * `true` or `false`. By default, for a Date parameter can use the following formats: * yyyy-MM-dd * HH:mm:ss * yyyy-MM-dd HH:mm:ss *
     * yyyy-MM-dd'T'HH:mm:ss * yyyy-MM-dd'T'HH:mm:ss.SSS
     * Note, this is equivalent to the other searchBusinessData 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:

     *        
    
     *        
  • q - Named query to use (required)
    • 
     *        
  • p - index of the page to display (required)
    • 
     *        
  • c - maximum number of elements to retrieve (required)
    • 
     *        
  • f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string.
     *        (optional)
    • 
     *        

     * @return List<Object>
     */
    @RequestLine("GET /API/bdm/businessData/{businessDataType}?q={q}&p={p}&c={c}&f={f}")
    @Headers({
            "Accept: application/json",
    })
    ApiResponse> searchBusinessDataWithHttpInfo(@Param("businessDataType") String businessDataType,
            @QueryMap(encoded = true) SearchBusinessDataQueryParams queryParams);

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

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

        public SearchBusinessDataQueryParams p(final Integer value) {
            put("p", EncodingUtils.encode(value));
            return this;
        }

        public SearchBusinessDataQueryParams c(final Integer value) {
            put("c", EncodingUtils.encode(value));
            return this;
        }

        public SearchBusinessDataQueryParams f(final List value) {
            put("f", EncodingUtils.encodeCollection(value, "multi"));
            return this;
        }
    }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy