org.bonitasoft.web.client.api.ProcessInstanceDocumentApi 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 createProcessInstanceDocument but it also returns the http response headers .
* Create the ProcessInstanceDocument. Use a POST method to add a document to a process instances. You can upload a document from the local file system or by
* URL. Specify the process instance id and the document name in the payload. The document description is optional: if you do not specify a description, the
* description in the response is empty. The response contains a version, which is managed automatically. You cannot currently retrieve a specific version of a
* document, only the most recent version. To retrieve earlier versions of a ProcessInstanceDocument, use the archivedProcessInstanceDocument resource.
*
* @param body Partial ProcessInstanceDocument description (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /API/bpm/caseDocument")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createProcessInstanceDocumentWithHttpInfo(
ProcessInstanceDocumentCreateRequest body);
/**
* Delete the ProcessInstanceDocument by ID
* Delete the single ProcessInstanceDocument for the given ID
*
* @param id ID of the ProcessInstanceDocument to delete (required)
*/
@RequestLine("DELETE /API/bpm/caseDocument/{id}")
@Headers({
"Accept: application/json",
})
void deleteProcessInstanceDocumentById(@Param("id") String id);
/**
* Delete the ProcessInstanceDocument by ID
* Similar to deleteProcessInstanceDocumentById but it also returns the http response headers .
* Delete the single ProcessInstanceDocument for the given ID
*
* @param id ID of the ProcessInstanceDocument to delete (required)
*/
@RequestLine("DELETE /API/bpm/caseDocument/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteProcessInstanceDocumentByIdWithHttpInfo(@Param("id") String id);
/**
* Finds the ProcessInstanceDocument by ID
* Returns the single ProcessInstanceDocument for the given ID. Use a GET method to get a document from a process instances. First you get the document
* information, then you download the content. To get the document information, specify the document id in the URL. The document id is created when you upload a
* document to a process instances. There is no payload.
*
* @param id ID of the ProcessInstanceDocument to return (required)
* @return ProcessInstanceDocument
*/
@RequestLine("GET /API/bpm/caseDocument/{id}")
@Headers({
"Accept: application/json",
})
ProcessInstanceDocument getProcessInstanceDocumentById(@Param("id") String id);
/**
* Finds the ProcessInstanceDocument by ID
* Similar to getProcessInstanceDocumentById but it also returns the http response headers .
* Returns the single ProcessInstanceDocument for the given ID. Use a GET method to get a document from a process instances. First you get the document
* information, then you download the content. To get the document information, specify the document id in the URL. The document id is created when you upload a
* document to a process instances. There is no payload.
*
* @param id ID of the ProcessInstanceDocument to return (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/caseDocument/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse getProcessInstanceDocumentByIdWithHttpInfo(@Param("id") String id);
/**
* Finds ProcessInstanceDocuments
* Finds ProcessInstanceDocuments with pagination params and filters It is possible to filter on three parameters: `submittedBy`, `name` and
* `description`. * `submittedBy=\"id\"`: search for documents that were submitted by the user with the specified identifier.
* * `name=\"string\"`: search for documents with names that contain _string_. Depending on the setting for [word-based
* search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_
* at the start of the name or the start of a word in the name. * `description=\"string\"`: search for documents with descriptions that
* contain _string_. Depending on the setting for [word-based
* search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_
* at the start of the description or the start of a word in the description.
*
* @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)
* @return List<ProcessInstanceDocument>
*/
@RequestLine("GET /API/bpm/caseDocument?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
List searchProcessInstanceDocuments(@Param("p") Integer p, @Param("c") Integer c,
@Param("f") List f, @Param("o") String o);
/**
* Finds ProcessInstanceDocuments
* Similar to searchProcessInstanceDocuments but it also returns the http response headers .
* Finds ProcessInstanceDocuments with pagination params and filters It is possible to filter on three parameters: `submittedBy`, `name` and
* `description`. * `submittedBy=\"id\"`: search for documents that were submitted by the user with the specified identifier.
* * `name=\"string\"`: search for documents with names that contain _string_. Depending on the setting for [word-based
* search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_
* at the start of the name or the start of a word in the name. * `description=\"string\"`: search for documents with descriptions that
* contain _string_. Depending on the setting for [word-based
* search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_
* at the start of the description or the start of a word in the description.
*
* @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)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /API/bpm/caseDocument?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchProcessInstanceDocumentsWithHttpInfo(@Param("p") Integer p,
@Param("c") Integer c, @Param("f") List f, @Param("o") String o);
/**
* Finds ProcessInstanceDocuments
* Finds ProcessInstanceDocuments with pagination params and filters It is possible to filter on three parameters: `submittedBy`, `name` and
* `description`. * `submittedBy=\"id\"`: search for documents that were submitted by the user with the specified identifier.
* * `name=\"string\"`: search for documents with names that contain _string_. Depending on the setting for [word-based
* search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_
* at the start of the name or the start of a word in the name. * `description=\"string\"`: search for documents with descriptions that
* contain _string_. Depending on the setting for [word-based
* search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_
* at the start of the description or the start of a word in the description.
* Note, this is equivalent to the other searchProcessInstanceDocuments 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 SearchProcessInstanceDocumentsQueryParams} 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)
*
* @return List<ProcessInstanceDocument>
*/
@RequestLine("GET /API/bpm/caseDocument?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
List searchProcessInstanceDocuments(
@QueryMap(encoded = true) SearchProcessInstanceDocumentsQueryParams queryParams);
/**
* Finds ProcessInstanceDocuments
* Finds ProcessInstanceDocuments with pagination params and filters It is possible to filter on three parameters: `submittedBy`, `name` and
* `description`. * `submittedBy=\"id\"`: search for documents that were submitted by the user with the specified identifier.
* * `name=\"string\"`: search for documents with names that contain _string_. Depending on the setting for [word-based
* search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_
* at the start of the name or the start of a word in the name. * `description=\"string\"`: search for documents with descriptions that
* contain _string_. Depending on the setting for [word-based
* search](https://documentation.bonitasoft.com/bonita/latest/api/using-list-and-search-methods#word_based_search), the search returns documents with _string_
* at the start of the description or the start of a word in the description.
* Note, this is equivalent to the other searchProcessInstanceDocuments 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)
*
* @return List<ProcessInstanceDocument>
*/
@RequestLine("GET /API/bpm/caseDocument?p={p}&c={c}&f={f}&o={o}")
@Headers({
"Accept: application/json",
})
ApiResponse> searchProcessInstanceDocumentsWithHttpInfo(
@QueryMap(encoded = true) SearchProcessInstanceDocumentsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* searchProcessInstanceDocuments method in a fluent style.
*/
public static class SearchProcessInstanceDocumentsQueryParams extends HashMap {
public SearchProcessInstanceDocumentsQueryParams p(final Integer value) {
put("p", EncodingUtils.encode(value));
return this;
}
public SearchProcessInstanceDocumentsQueryParams c(final Integer value) {
put("c", EncodingUtils.encode(value));
return this;
}
public SearchProcessInstanceDocumentsQueryParams f(final List value) {
put("f", EncodingUtils.encodeCollection(value, "multi"));
return this;
}
public SearchProcessInstanceDocumentsQueryParams o(final String value) {
put("o", EncodingUtils.encode(value));
return this;
}
}
/**
* Update the ProcessInstanceDocument by ID
* Update the ProcessInstanceDocument for the given ID You update a document in a process instance by uploading a new version of the document using a PUT
* method. You can upload a document version from the local file system or by URL. The document name will be used in all the process instances of the process,
* but the combination of process instance id and document name is unique. In the URL, you specify to supply the document id. This is included in the response
* when you first add a document to a process instances. The response to PUT methods is the same as for POST methods.
*
* @param id ID of the ProcessInstanceDocument to return (required)
* @param processInstanceDocumentUpdateRequest Partial ProcessInstanceDocument description (required)
*/
@RequestLine("PUT /API/bpm/caseDocument/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void updateProcessInstanceDocumentById(@Param("id") String id,
ProcessInstanceDocumentUpdateRequest processInstanceDocumentUpdateRequest);
/**
* Update the ProcessInstanceDocument by ID
* Similar to updateProcessInstanceDocumentById but it also returns the http response headers .
* Update the ProcessInstanceDocument for the given ID You update a document in a process instance by uploading a new version of the document using a PUT
* method. You can upload a document version from the local file system or by URL. The document name will be used in all the process instances of the process,
* but the combination of process instance id and document name is unique. In the URL, you specify to supply the document id. This is included in the response
* when you first add a document to a process instances. The response to PUT methods is the same as for POST methods.
*
* @param id ID of the ProcessInstanceDocument to return (required)
* @param processInstanceDocumentUpdateRequest Partial ProcessInstanceDocument description (required)
*/
@RequestLine("PUT /API/bpm/caseDocument/{id}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse updateProcessInstanceDocumentByIdWithHttpInfo(@Param("id") String id,
ProcessInstanceDocumentUpdateRequest processInstanceDocumentUpdateRequest);
}