Package org.bonitasoft.web.client.api

Interface FailureApi

All Superinterfaces:

ApiClient.Api

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.12.0")
public interface FailureApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FailureApi.GetArchivedBPMFailuresByCaseIdQueryParams	A convenience class for generating query parameters for the getArchivedBPMFailuresByCaseId method in a fluent style.
static class	FailureApi.GetArchivedBPMFailuresByRootCaseIdQueryParams	A convenience class for generating query parameters for the getArchivedBPMFailuresByRootCaseId method in a fluent style.
static class	FailureApi.GetBPMFailuresByCaseIdQueryParams	A convenience class for generating query parameters for the getBPMFailuresByCaseId method in a fluent style.
static class	FailureApi.GetBPMFailuresByFlowNodeInstanceIdQueryParams	A convenience class for generating query parameters for the getBPMFailuresByFlowNodeInstanceId method in a fluent style.
static class	FailureApi.GetBPMFailuresByRootCaseIdQueryParams	A convenience class for generating query parameters for the getBPMFailuresByRootCaseId method in a fluent style.

Method Summary

Modifier and Type	Method	Description
List<ArchivedBPMFailure>	getArchivedBPMFailuresByCaseId(String caseId, Integer c)	Retrieve the archived failures of an archived case (process instance) by it's sourceObjectID !
List<ArchivedBPMFailure>	getArchivedBPMFailuresByCaseId(String caseId, FailureApi.GetArchivedBPMFailuresByCaseIdQueryParams queryParams)	Retrieve the archived failures of an archived case (process instance) by it's sourceObjectID !
ApiResponse<List<ArchivedBPMFailure>>	getArchivedBPMFailuresByCaseIdWithHttpInfo(String caseId, Integer c)	Retrieve the archived failures of an archived case (process instance) by it's sourceObjectID Similar to getArchivedBPMFailuresByCaseId but it also returns the http response headers . !
ApiResponse<List<ArchivedBPMFailure>>	getArchivedBPMFailuresByCaseIdWithHttpInfo(String caseId, FailureApi.GetArchivedBPMFailuresByCaseIdQueryParams queryParams)	Retrieve the archived failures of an archived case (process instance) by it's sourceObjectID !
List<ArchivedBPMFailure>	getArchivedBPMFailuresByRootCaseId(String rootCaseId, Integer c)	Retrieve the archived failures of the archived child cases of a root case (process instance) by it's ID !
List<ArchivedBPMFailure>	getArchivedBPMFailuresByRootCaseId(String rootCaseId, FailureApi.GetArchivedBPMFailuresByRootCaseIdQueryParams queryParams)	Retrieve the archived failures of the archived child cases of a root case (process instance) by it's ID !
ApiResponse<List<ArchivedBPMFailure>>	getArchivedBPMFailuresByRootCaseIdWithHttpInfo(String rootCaseId, Integer c)	Retrieve the archived failures of the archived child cases of a root case (process instance) by it's ID Similar to getArchivedBPMFailuresByRootCaseId but it also returns the http response headers . !
ApiResponse<List<ArchivedBPMFailure>>	getArchivedBPMFailuresByRootCaseIdWithHttpInfo(String rootCaseId, FailureApi.GetArchivedBPMFailuresByRootCaseIdQueryParams queryParams)	Retrieve the archived failures of the archived child cases of a root case (process instance) by it's ID !
List<BPMFailure>	getBPMFailuresByCaseId(String caseId, Integer c)	Retrieve the failures of a case (process instance) by it's ID !
List<BPMFailure>	getBPMFailuresByCaseId(String caseId, FailureApi.GetBPMFailuresByCaseIdQueryParams queryParams)	Retrieve the failures of a case (process instance) by it's ID !
ApiResponse<List<BPMFailure>>	getBPMFailuresByCaseIdWithHttpInfo(String caseId, Integer c)	Retrieve the failures of a case (process instance) by it's ID Similar to getBPMFailuresByCaseId but it also returns the http response headers . !
ApiResponse<List<BPMFailure>>	getBPMFailuresByCaseIdWithHttpInfo(String caseId, FailureApi.GetBPMFailuresByCaseIdQueryParams queryParams)	Retrieve the failures of a case (process instance) by it's ID !
List<BPMFailure>	getBPMFailuresByFlowNodeInstanceId(String flowNodeInstanceId, Integer c)	Retrieve the failures of a flownode instance by it's ID !
List<BPMFailure>	getBPMFailuresByFlowNodeInstanceId(String flowNodeInstanceId, FailureApi.GetBPMFailuresByFlowNodeInstanceIdQueryParams queryParams)	Retrieve the failures of a flownode instance by it's ID !
ApiResponse<List<BPMFailure>>	getBPMFailuresByFlowNodeInstanceIdWithHttpInfo(String flowNodeInstanceId, Integer c)	Retrieve the failures of a flownode instance by it's ID Similar to getBPMFailuresByFlowNodeInstanceId but it also returns the http response headers . !
ApiResponse<List<BPMFailure>>	getBPMFailuresByFlowNodeInstanceIdWithHttpInfo(String flowNodeInstanceId, FailureApi.GetBPMFailuresByFlowNodeInstanceIdQueryParams queryParams)	Retrieve the failures of a flownode instance by it's ID !
List<BPMFailure>	getBPMFailuresByRootCaseId(String rootCaseId, Integer c)	Retrieve the failures of the child cases of a root case (process instance) by it's ID !
List<BPMFailure>	getBPMFailuresByRootCaseId(String rootCaseId, FailureApi.GetBPMFailuresByRootCaseIdQueryParams queryParams)	Retrieve the failures of the child cases of a root case (process instance) by it's ID !
ApiResponse<List<BPMFailure>>	getBPMFailuresByRootCaseIdWithHttpInfo(String rootCaseId, Integer c)	Retrieve the failures of the child cases of a root case (process instance) by it's ID Similar to getBPMFailuresByRootCaseId but it also returns the http response headers . !
ApiResponse<List<BPMFailure>>	getBPMFailuresByRootCaseIdWithHttpInfo(String rootCaseId, FailureApi.GetBPMFailuresByRootCaseIdQueryParams queryParams)	Retrieve the failures of the child cases of a root case (process instance) by it's ID !

Method Details

getArchivedBPMFailuresByCaseId

List<ArchivedBPMFailure> getArchivedBPMFailuresByCaseId(String caseId,
 Integer c)

Retrieve the archived failures of an archived case (process instance) by it's sourceObjectID  Returns the most recent archived failures for the given archived case sourceObjectID

Parameters:

caseId - The original identifier (sourceObjectID) of the case from which to retrieve the failures (required)

c - maximum number of elements to retrieve (required)

Returns:

List<ArchivedBPMFailure>

getArchivedBPMFailuresByCaseIdWithHttpInfo

ApiResponse<List<ArchivedBPMFailure>> getArchivedBPMFailuresByCaseIdWithHttpInfo(String caseId,
 Integer c)

Retrieve the archived failures of an archived case (process instance) by it's sourceObjectID Similar to getArchivedBPMFailuresByCaseId but it also returns the http response headers .  Returns the most recent archived failures for the given archived case sourceObjectID

Parameters:

caseId - The original identifier (sourceObjectID) of the case from which to retrieve the failures (required)

c - maximum number of elements to retrieve (required)

Returns:

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

getArchivedBPMFailuresByCaseId

List<ArchivedBPMFailure> getArchivedBPMFailuresByCaseId(String caseId,
 FailureApi.GetArchivedBPMFailuresByCaseIdQueryParams queryParams)

Retrieve the archived failures of an archived case (process instance) by it's sourceObjectID  Returns the most recent archived failures for the given archived case sourceObjectID Note, this is equivalent to the other getArchivedBPMFailuresByCaseId 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 FailureApi.GetArchivedBPMFailuresByCaseIdQueryParams class that allows for building up this map in a fluent style.

Parameters:

caseId - The original identifier (sourceObjectID) of the case from which to retrieve the failures (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• c - maximum number of elements to retrieve (required)

Returns:

List<ArchivedBPMFailure>

getArchivedBPMFailuresByCaseIdWithHttpInfo

ApiResponse<List<ArchivedBPMFailure>> getArchivedBPMFailuresByCaseIdWithHttpInfo(String caseId,
 FailureApi.GetArchivedBPMFailuresByCaseIdQueryParams queryParams)

Retrieve the archived failures of an archived case (process instance) by it's sourceObjectID  Returns the most recent archived failures for the given archived case sourceObjectID Note, this is equivalent to the other getArchivedBPMFailuresByCaseId that receives the query parameters as a map, but this one also exposes the Http response headers

Parameters:

caseId - The original identifier (sourceObjectID) of the case from which to retrieve the failures (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• c - maximum number of elements to retrieve (required)

Returns:

List<ArchivedBPMFailure>

getArchivedBPMFailuresByRootCaseId

List<ArchivedBPMFailure> getArchivedBPMFailuresByRootCaseId(String rootCaseId,
 Integer c)

Retrieve the archived failures of the archived child cases of a root case (process instance) by it's ID  Returns the most recent archived failures among all the archived child cases (started by call activities) of a case

Parameters:

rootCaseId - The identifier of the root case from which to retrieve the archived failures (its sourceObjectID if the root case is archived) (required)

c - maximum number of elements to retrieve (required)

Returns:

List<ArchivedBPMFailure>

getArchivedBPMFailuresByRootCaseIdWithHttpInfo

ApiResponse<List<ArchivedBPMFailure>> getArchivedBPMFailuresByRootCaseIdWithHttpInfo(String rootCaseId,
 Integer c)

Retrieve the archived failures of the archived child cases of a root case (process instance) by it's ID Similar to getArchivedBPMFailuresByRootCaseId but it also returns the http response headers .  Returns the most recent archived failures among all the archived child cases (started by call activities) of a case

Parameters:

rootCaseId - The identifier of the root case from which to retrieve the archived failures (its sourceObjectID if the root case is archived) (required)

c - maximum number of elements to retrieve (required)

Returns:

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

getArchivedBPMFailuresByRootCaseId

List<ArchivedBPMFailure> getArchivedBPMFailuresByRootCaseId(String rootCaseId,
 FailureApi.GetArchivedBPMFailuresByRootCaseIdQueryParams queryParams)

Retrieve the archived failures of the archived child cases of a root case (process instance) by it's ID  Returns the most recent archived failures among all the archived child cases (started by call activities) of a case Note, this is equivalent to the other getArchivedBPMFailuresByRootCaseId 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 FailureApi.GetArchivedBPMFailuresByRootCaseIdQueryParams class that allows for building up this map in a fluent style.

Parameters:

rootCaseId - The identifier of the root case from which to retrieve the archived failures (its sourceObjectID if the root case is archived) (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• c - maximum number of elements to retrieve (required)

Returns:

List<ArchivedBPMFailure>

getArchivedBPMFailuresByRootCaseIdWithHttpInfo

ApiResponse<List<ArchivedBPMFailure>> getArchivedBPMFailuresByRootCaseIdWithHttpInfo(String rootCaseId,
 FailureApi.GetArchivedBPMFailuresByRootCaseIdQueryParams queryParams)

Retrieve the archived failures of the archived child cases of a root case (process instance) by it's ID  Returns the most recent archived failures among all the archived child cases (started by call activities) of a case Note, this is equivalent to the other getArchivedBPMFailuresByRootCaseId that receives the query parameters as a map, but this one also exposes the Http response headers

Parameters:

rootCaseId - The identifier of the root case from which to retrieve the archived failures (its sourceObjectID if the root case is archived) (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• c - maximum number of elements to retrieve (required)

Returns:

List<ArchivedBPMFailure>

getBPMFailuresByCaseId

List<BPMFailure> getBPMFailuresByCaseId(String caseId,
 Integer c)

Retrieve the failures of a case (process instance) by it's ID  Returns the most recent failures for the given case

Parameters:

caseId - The identifier of the case from which to retrieve the failures (required)

c - maximum number of elements to retrieve (required)

Returns:

List<BPMFailure>

getBPMFailuresByCaseIdWithHttpInfo

ApiResponse<List<BPMFailure>> getBPMFailuresByCaseIdWithHttpInfo(String caseId,
 Integer c)

Retrieve the failures of a case (process instance) by it's ID Similar to getBPMFailuresByCaseId but it also returns the http response headers .  Returns the most recent failures for the given case

Parameters:

caseId - The identifier of the case from which to retrieve the failures (required)

c - maximum number of elements to retrieve (required)

Returns:

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

getBPMFailuresByCaseId

List<BPMFailure> getBPMFailuresByCaseId(String caseId,
 FailureApi.GetBPMFailuresByCaseIdQueryParams queryParams)

Retrieve the failures of a case (process instance) by it's ID  Returns the most recent failures for the given case Note, this is equivalent to the other getBPMFailuresByCaseId 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 FailureApi.GetBPMFailuresByCaseIdQueryParams class that allows for building up this map in a fluent style.

Parameters:

caseId - The identifier of the case from which to retrieve the failures (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• c - maximum number of elements to retrieve (required)

Returns:

List<BPMFailure>

getBPMFailuresByCaseIdWithHttpInfo

ApiResponse<List<BPMFailure>> getBPMFailuresByCaseIdWithHttpInfo(String caseId,
 FailureApi.GetBPMFailuresByCaseIdQueryParams queryParams)

Retrieve the failures of a case (process instance) by it's ID  Returns the most recent failures for the given case Note, this is equivalent to the other getBPMFailuresByCaseId that receives the query parameters as a map, but this one also exposes the Http response headers

Parameters:

caseId - The identifier of the case from which to retrieve the failures (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• c - maximum number of elements to retrieve (required)

Returns:

List<BPMFailure>

getBPMFailuresByFlowNodeInstanceId

List<BPMFailure> getBPMFailuresByFlowNodeInstanceId(String flowNodeInstanceId,
 Integer c)

Retrieve the failures of a flownode instance by it's ID  Returns the most recent failures for the given flownode ID

Parameters:

flowNodeInstanceId - The identifier of the flownode instance from which to retrieve the failures (required)

c - maximum number of elements to retrieve (required)

Returns:

List<BPMFailure>

getBPMFailuresByFlowNodeInstanceIdWithHttpInfo

ApiResponse<List<BPMFailure>> getBPMFailuresByFlowNodeInstanceIdWithHttpInfo(String flowNodeInstanceId,
 Integer c)

Retrieve the failures of a flownode instance by it's ID Similar to getBPMFailuresByFlowNodeInstanceId but it also returns the http response headers .  Returns the most recent failures for the given flownode ID

Parameters:

flowNodeInstanceId - The identifier of the flownode instance from which to retrieve the failures (required)

c - maximum number of elements to retrieve (required)

Returns:

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

getBPMFailuresByFlowNodeInstanceId

List<BPMFailure> getBPMFailuresByFlowNodeInstanceId(String flowNodeInstanceId,
 FailureApi.GetBPMFailuresByFlowNodeInstanceIdQueryParams queryParams)

Retrieve the failures of a flownode instance by it's ID  Returns the most recent failures for the given flownode ID Note, this is equivalent to the other getBPMFailuresByFlowNodeInstanceId 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 FailureApi.GetBPMFailuresByFlowNodeInstanceIdQueryParams class that allows for building up this map in a fluent style.

Parameters:

flowNodeInstanceId - The identifier of the flownode instance from which to retrieve the failures (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• c - maximum number of elements to retrieve (required)

Returns:

List<BPMFailure>

getBPMFailuresByFlowNodeInstanceIdWithHttpInfo

ApiResponse<List<BPMFailure>> getBPMFailuresByFlowNodeInstanceIdWithHttpInfo(String flowNodeInstanceId,
 FailureApi.GetBPMFailuresByFlowNodeInstanceIdQueryParams queryParams)

Retrieve the failures of a flownode instance by it's ID  Returns the most recent failures for the given flownode ID Note, this is equivalent to the other getBPMFailuresByFlowNodeInstanceId that receives the query parameters as a map, but this one also exposes the Http response headers

Parameters:

flowNodeInstanceId - The identifier of the flownode instance from which to retrieve the failures (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• c - maximum number of elements to retrieve (required)

Returns:

List<BPMFailure>

getBPMFailuresByRootCaseId

List<BPMFailure> getBPMFailuresByRootCaseId(String rootCaseId,
 Integer c)

Retrieve the failures of the child cases of a root case (process instance) by it's ID  Returns the most recent failures among all the child cases (started by call activities) of a case

Parameters:

rootCaseId - The identifier of the root case from which to retrieve the failures (its sourceObjectID if the root case is archived) (required)

c - maximum number of elements to retrieve (required)

Returns:

List<BPMFailure>

getBPMFailuresByRootCaseIdWithHttpInfo

ApiResponse<List<BPMFailure>> getBPMFailuresByRootCaseIdWithHttpInfo(String rootCaseId,
 Integer c)

Retrieve the failures of the child cases of a root case (process instance) by it's ID Similar to getBPMFailuresByRootCaseId but it also returns the http response headers .  Returns the most recent failures among all the child cases (started by call activities) of a case

Parameters:

rootCaseId - The identifier of the root case from which to retrieve the failures (its sourceObjectID if the root case is archived) (required)

c - maximum number of elements to retrieve (required)

Returns:

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

getBPMFailuresByRootCaseId

List<BPMFailure> getBPMFailuresByRootCaseId(String rootCaseId,
 FailureApi.GetBPMFailuresByRootCaseIdQueryParams queryParams)

Retrieve the failures of the child cases of a root case (process instance) by it's ID  Returns the most recent failures among all the child cases (started by call activities) of a case Note, this is equivalent to the other getBPMFailuresByRootCaseId 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 FailureApi.GetBPMFailuresByRootCaseIdQueryParams class that allows for building up this map in a fluent style.

Parameters:

rootCaseId - The identifier of the root case from which to retrieve the failures (its sourceObjectID if the root case is archived) (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• c - maximum number of elements to retrieve (required)

Returns:

List<BPMFailure>

getBPMFailuresByRootCaseIdWithHttpInfo

ApiResponse<List<BPMFailure>> getBPMFailuresByRootCaseIdWithHttpInfo(String rootCaseId,
 FailureApi.GetBPMFailuresByRootCaseIdQueryParams queryParams)

Retrieve the failures of the child cases of a root case (process instance) by it's ID  Returns the most recent failures among all the child cases (started by call activities) of a case Note, this is equivalent to the other getBPMFailuresByRootCaseId that receives the query parameters as a map, but this one also exposes the Http response headers

Parameters:

rootCaseId - The identifier of the root case from which to retrieve the failures (its sourceObjectID if the root case is archived) (required)

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• c - maximum number of elements to retrieve (required)

Returns:

List<BPMFailure>