org.bonitasoft.web.client.api.PageApi 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
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 createPage but it also returns the http response headers .
* Upload the page content using the `portal/pageUpload`. This returns a temporary file name that can be used as input for this operation. Warning: as
* of 9.0.0, creating a page using this API is deprecated.
*
* @param body Zip name as named in the temp folder after upload (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
* @deprecated
*/
@Deprecated
@RequestLine("POST /API/portal/page")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createPageWithHttpInfo(PageCreateRequest body);
/**
* Delete the Page by ID
* Delete the single Page for the given ID
*
* @param id ID of the Page to delete (required)
*/
@RequestLine("DELETE /API/portal/page/{id}")
@Headers({
"Accept: application/json",
})
void deletePageById(@Param("id") String id);
/**
* Delete the Page by ID
* Similar to deletePageById but it also returns the http response headers .
* Delete the single Page for the given ID
*
* @param id ID of the Page to delete (required)
*/
@RequestLine("DELETE /API/portal/page/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deletePageByIdWithHttpInfo(@Param("id") String id);
/**
* Finds the Page by ID
* Returns the single Page for the given ID
*
* @param id ID of the Page to return (required)
* @return Page
*/
@RequestLine("GET /API/portal/page/{id}")
@Headers({
"Accept: application/json",
})
Page getPageById(@Param("id") String id);
/**
* Finds the Page by ID
* Similar to getPageById but it also returns the http response headers .
* Returns the single Page for the given ID
*
* @param id ID of the Page to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/portal/page/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getPageByIdWithHttpInfo(@Param("id") String id);
/**
* Finds Pages
* Finds Pages with pagination params and filters - can search on `displayName`,`description` - can filter on
* `createdBy`,`contentType`
*
* @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)
* @param o can order on attributes (optional)
* @param s can search on attributes (optional)
* @return List<Page>
*/
@RequestLine("GET /API/portal/page?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchPages(@Param("p") Integer p, @Param("c") Integer c, @Param("f") List f,
@Param("o") String o, @Param("s") String s);
/**
* Finds Pages
* Similar to searchPages but it also returns the http response headers .
* Finds Pages with pagination params and filters - can search on `displayName`,`description` - can filter on
* `createdBy`,`contentType`
*
* @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)
* @param o can order on attributes (optional)
* @param s can search on attributes (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/portal/page?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchPagesWithHttpInfo(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o, @Param("s") String s);
/**
* Finds Pages
* Finds Pages with pagination params and filters - can search on `displayName`,`description` - can filter on
* `createdBy`,`contentType`
* Note, this is equivalent to the other searchPages 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 SearchPagesQueryParams} class that allows for
* building up this map in a fluent style.
*
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - 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)
* - o - can order on attributes (optional)
* - s - can search on attributes (optional)
*
* @return List<Page>
*/
@RequestLine("GET /API/portal/page?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
List searchPages(@QueryMap(encoded = true) SearchPagesQueryParams queryParams);
/**
* Finds Pages
* Finds Pages with pagination params and filters - can search on `displayName`,`description` - can filter on
* `createdBy`,`contentType`
* Note, this is equivalent to the other searchPages that receives the query parameters as a map,
* but this one also exposes the Http response headers
*
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - 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)
* - o - can order on attributes (optional)
* - s - can search on attributes (optional)
*
* @return List<Page>
*/
@RequestLine("GET /API/portal/page?p={p}&c={c}&f={f}&o={o}&s={s}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchPagesWithHttpInfo(@QueryMap(encoded = true) SearchPagesQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchPages method in a fluent style.
*/
public static class SearchPagesQueryParams extends HashMap {
public SearchPagesQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchPagesQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchPagesQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchPagesQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
public SearchPagesQueryParams s(final String value) {
put("s", EncodingUtils.encode(value));
return this;
}
}
/**
* Update the Page by ID
* Use the PUT method to update an existing custom page. To update a custom page, upload the new page content using the pageUpload servlet, which returns a
* temporary file name, and then call this API with the temporary file name. Warning: as of 9.0.0, updating a page using this API is deprecated.
*
* @param id ID of the Page to return (required)
* @param pageUpdateRequest Partial Page description (required)
* @deprecated
*/
@Deprecated
@RequestLine("PUT /API/portal/page/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void updatePageById(@Param("id") String id, PageUpdateRequest pageUpdateRequest);
/**
* Update the Page by ID
* Similar to updatePageById but it also returns the http response headers .
* Use the PUT method to update an existing custom page. To update a custom page, upload the new page content using the pageUpload servlet, which returns a
* temporary file name, and then call this API with the temporary file name. Warning: as of 9.0.0, updating a page using this API is deprecated.
*
* @param id ID of the Page to return (required)
* @param pageUpdateRequest Partial Page description (required)
* @deprecated
*/
@Deprecated
@RequestLine("PUT /API/portal/page/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updatePageByIdWithHttpInfo(@Param("id") String id, PageUpdateRequest pageUpdateRequest);
/**
* Upload a Page
* Upload Page Warning: as of 9.0.0, uploading a page using the portal is deprecated.
*
* @param file (optional)
* @return String
* @deprecated
*/
@Deprecated
@RequestLine("POST /portal/pageUpload")
@Headers({
"Content-Type: multipart/form-data",
"Accept: application/json,text/plain",
})
String uploadPage(@Param("file") File file);
/**
* Upload a Page
* Similar to uploadPage but it also returns the http response headers .
* Upload Page Warning: as of 9.0.0, uploading a page using the portal is deprecated.
*
* @param file (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
* @deprecated
*/
@Deprecated
@RequestLine("POST /portal/pageUpload")
@Headers({
"Content-Type: multipart/form-data",
"Accept: application/json,text/plain",
})
ApiResponse uploadPageWithHttpInfo(@Param("file") File file);
}