Package org.bonitasoft.web.client.api

Interface ArchivedProcessInstanceDocumentApi

All Superinterfaces:

ApiClient.Api

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public interface ArchivedProcessInstanceDocumentApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ArchivedProcessInstanceDocumentApi.SearchArchivedProcessInstanceDocumentsQueryParams	A convenience class for generating query parameters for the searchArchivedProcessInstanceDocuments method in a fluent style.

Method Summary

Modifier and Type	Method	Description
void	deleteArchivedProcessInstanceDocumentById(String id)	Delete the ArchivedProcessInstanceDocument by ID Delete the single ArchivedProcessInstanceDocument for the given ID
ApiResponse<Void>	deleteArchivedProcessInstanceDocumentByIdWithHttpInfo(String id)	Delete the ArchivedProcessInstanceDocument by ID Similar to deleteArchivedProcessInstanceDocumentById but it also returns the http response headers .
List<ArchivedProcessInstanceDocument>	searchArchivedProcessInstanceDocuments(Integer p, Integer c, List<String> f, String o)	Finds ArchivedProcessInstanceDocuments Finds ArchivedProcessInstanceDocuments with pagination params and filters You can filter on : * `sourceObjectId=\"id\"`: search for documents by specifying the original document id.
List<ArchivedProcessInstanceDocument>	searchArchivedProcessInstanceDocuments(Map<String,Object> queryParams)	Finds ArchivedProcessInstanceDocuments Finds ArchivedProcessInstanceDocuments with pagination params and filters You can filter on : * `sourceObjectId=\"id\"`: search for documents by specifying the original document id.
ApiResponse<List<ArchivedProcessInstanceDocument>>	searchArchivedProcessInstanceDocumentsWithHttpInfo(Integer p, Integer c, List<String> f, String o)	Finds ArchivedProcessInstanceDocuments Similar to searchArchivedProcessInstanceDocuments but it also returns the http response headers .
ApiResponse<List<ArchivedProcessInstanceDocument>>	searchArchivedProcessInstanceDocumentsWithHttpInfo(Map<String,Object> queryParams)	Finds ArchivedProcessInstanceDocuments Finds ArchivedProcessInstanceDocuments with pagination params and filters You can filter on : * `sourceObjectId=\"id\"`: search for documents by specifying the original document id.

Method Detail

deleteArchivedProcessInstanceDocumentById

void deleteArchivedProcessInstanceDocumentById(String id)

Delete the ArchivedProcessInstanceDocument by ID Delete the single ArchivedProcessInstanceDocument for the given ID

Parameters:

id - ID of the ArchivedProcessInstanceDocument to delete (required)

deleteArchivedProcessInstanceDocumentByIdWithHttpInfo

ApiResponse<Void> deleteArchivedProcessInstanceDocumentByIdWithHttpInfo(String id)

Delete the ArchivedProcessInstanceDocument by ID Similar to deleteArchivedProcessInstanceDocumentById but it also returns the http response headers . Delete the single ArchivedProcessInstanceDocument for the given ID

Parameters:

id - ID of the ArchivedProcessInstanceDocument to delete (required)

searchArchivedProcessInstanceDocuments

List<ArchivedProcessInstanceDocument> searchArchivedProcessInstanceDocuments(Integer p,
                                                                             Integer c,
                                                                             List<String> f,
                                                                             String o)

Finds ArchivedProcessInstanceDocuments Finds ArchivedProcessInstanceDocuments with pagination params and filters You can filter on : * `sourceObjectId=\"id\"`: search for documents by specifying the original document id. This is useful if you know the id of a ProcessInstanceDocument and you wish to retrieve all its previous versions.. * `caseId=\"id\"`: search for documents with the specified open process instance id. * `archivedProcessInstanceId=\"id\"`: search for documents with the specified archvied process instance id. * `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](using-list-and-search-methods.md), 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](using-list-and-search-methods.md), the search returns documents with _string_ at the start of the description or the start of a word in the description.

Parameters:

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)

Returns:

List<ArchivedProcessInstanceDocument>

searchArchivedProcessInstanceDocumentsWithHttpInfo

ApiResponse<List<ArchivedProcessInstanceDocument>> searchArchivedProcessInstanceDocumentsWithHttpInfo(Integer p,
                                                                                                      Integer c,
                                                                                                      List<String> f,
                                                                                                      String o)

Finds ArchivedProcessInstanceDocuments Similar to searchArchivedProcessInstanceDocuments but it also returns the http response headers . Finds ArchivedProcessInstanceDocuments with pagination params and filters You can filter on : * `sourceObjectId=\"id\"`: search for documents by specifying the original document id. This is useful if you know the id of a ProcessInstanceDocument and you wish to retrieve all its previous versions.. * `caseId=\"id\"`: search for documents with the specified open process instance id. * `archivedProcessInstanceId=\"id\"`: search for documents with the specified archvied process instance id. * `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](using-list-and-search-methods.md), 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](using-list-and-search-methods.md), the search returns documents with _string_ at the start of the description or the start of a word in the description.

Parameters:

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)

Returns:

A ApiResponse that wraps the response boyd and the http headers.

searchArchivedProcessInstanceDocuments

List<ArchivedProcessInstanceDocument> searchArchivedProcessInstanceDocuments(Map<String,Object> queryParams)

Finds ArchivedProcessInstanceDocuments Finds ArchivedProcessInstanceDocuments with pagination params and filters You can filter on : * `sourceObjectId=\"id\"`: search for documents by specifying the original document id. This is useful if you know the id of a ProcessInstanceDocument and you wish to retrieve all its previous versions.. * `caseId=\"id\"`: search for documents with the specified open process instance id. * `archivedProcessInstanceId=\"id\"`: search for documents with the specified archvied process instance id. * `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](using-list-and-search-methods.md), 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](using-list-and-search-methods.md), 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 searchArchivedProcessInstanceDocuments 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 ArchivedProcessInstanceDocumentApi.SearchArchivedProcessInstanceDocumentsQueryParams class that allows for building up this map in a fluent style.

Parameters:

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)

Returns:

List<ArchivedProcessInstanceDocument>

searchArchivedProcessInstanceDocumentsWithHttpInfo

ApiResponse<List<ArchivedProcessInstanceDocument>> searchArchivedProcessInstanceDocumentsWithHttpInfo(Map<String,Object> queryParams)

Finds ArchivedProcessInstanceDocuments Finds ArchivedProcessInstanceDocuments with pagination params and filters You can filter on : * `sourceObjectId=\"id\"`: search for documents by specifying the original document id. This is useful if you know the id of a ProcessInstanceDocument and you wish to retrieve all its previous versions.. * `caseId=\"id\"`: search for documents with the specified open process instance id. * `archivedProcessInstanceId=\"id\"`: search for documents with the specified archvied process instance id. * `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](using-list-and-search-methods.md), 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](using-list-and-search-methods.md), 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 searchArchivedProcessInstanceDocuments that receives the query parameters as a map, but this one also exposes the Http response headers

Parameters:

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)

Returns:

List<ArchivedProcessInstanceDocument>