Package org.bonitasoft.web.client.api

Interface ProcessInstanceCommentApi

All Superinterfaces:

ApiClient.Api

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProcessInstanceCommentApi.SearchProcessInstanceCommentsQueryParams	A convenience class for generating query parameters for the searchProcessInstanceComments method in a fluent style.

Method Summary

Modifier and Type	Method	Description
ProcessInstanceComment	createProcessInstanceComment(ProcessInstanceCommentCreateRequest body)	Create the ProcessInstanceComment Create the ProcessInstanceComment
ApiResponse<ProcessInstanceComment>	createProcessInstanceCommentWithHttpInfo(ProcessInstanceCommentCreateRequest body)	Create the ProcessInstanceComment Similar to createProcessInstanceComment but it also returns the http response headers .
List<ProcessInstanceComment>	searchProcessInstanceComments(Integer p, Integer c, List<String> f, String o)	Finds ProcessInstanceComments Finds ProcessInstanceComments with pagination params and filters - can order on `postDate` - can filter on `supervisor_id`,`user_id`,`processInstanceId` - You cannot use supervisor_id and user_id filter at the same time
List<ProcessInstanceComment>	searchProcessInstanceComments(Map<String,Object> queryParams)	Finds ProcessInstanceComments Finds ProcessInstanceComments with pagination params and filters - can order on `postDate` - can filter on `supervisor_id`,`user_id`,`processInstanceId` - You cannot use supervisor_id and user_id filter at the same time Note, this is equivalent to the other searchProcessInstanceComments method, but with the query parameters collected into a single Map parameter.
ApiResponse<List<ProcessInstanceComment>>	searchProcessInstanceCommentsWithHttpInfo(Integer p, Integer c, List<String> f, String o)	Finds ProcessInstanceComments Similar to searchProcessInstanceComments but it also returns the http response headers .
ApiResponse<List<ProcessInstanceComment>>	searchProcessInstanceCommentsWithHttpInfo(Map<String,Object> queryParams)	Finds ProcessInstanceComments Finds ProcessInstanceComments with pagination params and filters - can order on `postDate` - can filter on `supervisor_id`,`user_id`,`processInstanceId` - You cannot use supervisor_id and user_id filter at the same time Note, this is equivalent to the other searchProcessInstanceComments that receives the query parameters as a map, but this one also exposes the Http response headers

Method Detail

createProcessInstanceComment

ProcessInstanceComment createProcessInstanceComment(ProcessInstanceCommentCreateRequest body)

Create the ProcessInstanceComment Create the ProcessInstanceComment

Parameters:

body - The process instance (case) id and the comment content, in JSON (required)

Returns:

ProcessInstanceComment

createProcessInstanceCommentWithHttpInfo

ApiResponse<ProcessInstanceComment> createProcessInstanceCommentWithHttpInfo(ProcessInstanceCommentCreateRequest body)

Create the ProcessInstanceComment Similar to createProcessInstanceComment but it also returns the http response headers . Create the ProcessInstanceComment

Parameters:

body - The process instance (case) id and the comment content, in JSON (required)

Returns:

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

searchProcessInstanceComments

List<ProcessInstanceComment> searchProcessInstanceComments(Integer p,
                                                           Integer c,
                                                           List<String> f,
                                                           String o)

Finds ProcessInstanceComments Finds ProcessInstanceComments with pagination params and filters - can order on `postDate` - can filter on `supervisor_id`,`user_id`,`processInstanceId` - You cannot use supervisor_id and user_id filter at the same time

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<ProcessInstanceComment>

searchProcessInstanceCommentsWithHttpInfo

ApiResponse<List<ProcessInstanceComment>> searchProcessInstanceCommentsWithHttpInfo(Integer p,
                                                                                    Integer c,
                                                                                    List<String> f,
                                                                                    String o)

Finds ProcessInstanceComments Similar to searchProcessInstanceComments but it also returns the http response headers . Finds ProcessInstanceComments with pagination params and filters - can order on `postDate` - can filter on `supervisor_id`,`user_id`,`processInstanceId` - You cannot use supervisor_id and user_id filter at the same time

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.

searchProcessInstanceComments

List<ProcessInstanceComment> searchProcessInstanceComments(Map<String,Object> queryParams)

Finds ProcessInstanceComments Finds ProcessInstanceComments with pagination params and filters - can order on `postDate` - can filter on `supervisor_id`,`user_id`,`processInstanceId` - You cannot use supervisor_id and user_id filter at the same time Note, this is equivalent to the other searchProcessInstanceComments 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 ProcessInstanceCommentApi.SearchProcessInstanceCommentsQueryParams 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<ProcessInstanceComment>

searchProcessInstanceCommentsWithHttpInfo

ApiResponse<List<ProcessInstanceComment>> searchProcessInstanceCommentsWithHttpInfo(Map<String,Object> queryParams)

Finds ProcessInstanceComments Finds ProcessInstanceComments with pagination params and filters - can order on `postDate` - can filter on `supervisor_id`,`user_id`,`processInstanceId` - You cannot use supervisor_id and user_id filter at the same time Note, this is equivalent to the other searchProcessInstanceComments 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<ProcessInstanceComment>