Package org.bonitasoft.web.client.api

Interface ConnectorInstanceApi

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

  • Method Details

    • searchConnectorInstances

      List<ConnectorInstance> searchConnectorInstances(Integer p, Integer c, List<String> f, String o, String s)
      Finds ConnectorInstances Finds ConnectorInstances attached to a process or a flow node with pagination params and filters. You can filter on: * `containerId`: the process instance or flow node instance ID * `state`: the connector state `TO_BE_EXECUTED`, `EXECUTING`, `TO_RE_EXECUTE`, `DONE`, `FAILED`, `SKIPPED` * `containerType`: the type of container: either `flowNode` or `process` (since version 10.3 - 2025.1) * `name`: the connector name (since version 10.3 - 2025.1) * `version`: the connector version (since version 10.3 - 2025.1) * `connectorId`: the connector definition ID (since version 10.3 - 2025.1) * `activationEvent`: the container event on which the connector is instanciated: either `ON_ENTER` or `ON_FINISH` (since version 10.3 - 2025.1)
      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)
      s - can search on attributes (optional)
      Returns:
      List<ConnectorInstance>

    • searchConnectorInstancesWithHttpInfo

      ApiResponse<List<ConnectorInstance>> searchConnectorInstancesWithHttpInfo(Integer p, Integer c, List<String> f, String o, String s)
      Finds ConnectorInstances Similar to searchConnectorInstances but it also returns the http response headers . Finds ConnectorInstances attached to a process or a flow node with pagination params and filters. You can filter on: * `containerId`: the process instance or flow node instance ID * `state`: the connector state `TO_BE_EXECUTED`, `EXECUTING`, `TO_RE_EXECUTE`, `DONE`, `FAILED`, `SKIPPED` * `containerType`: the type of container: either `flowNode` or `process` (since version 10.3 - 2025.1) * `name`: the connector name (since version 10.3 - 2025.1) * `version`: the connector version (since version 10.3 - 2025.1) * `connectorId`: the connector definition ID (since version 10.3 - 2025.1) * `activationEvent`: the container event on which the connector is instanciated: either `ON_ENTER` or `ON_FINISH` (since version 10.3 - 2025.1)
      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)
      s - can search on attributes (optional)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchConnectorInstances

      List<ConnectorInstance> searchConnectorInstances(ConnectorInstanceApi.SearchConnectorInstancesQueryParams queryParams)
      Finds ConnectorInstances Finds ConnectorInstances attached to a process or a flow node with pagination params and filters. You can filter on: * `containerId`: the process instance or flow node instance ID * `state`: the connector state `TO_BE_EXECUTED`, `EXECUTING`, `TO_RE_EXECUTE`, `DONE`, `FAILED`, `SKIPPED` * `containerType`: the type of container: either `flowNode` or `process` (since version 10.3 - 2025.1) * `name`: the connector name (since version 10.3 - 2025.1) * `version`: the connector version (since version 10.3 - 2025.1) * `connectorId`: the connector definition ID (since version 10.3 - 2025.1) * `activationEvent`: the container event on which the connector is instanciated: either `ON_ENTER` or `ON_FINISH` (since version 10.3 - 2025.1) Note, this is equivalent to the other searchConnectorInstances 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 ConnectorInstanceApi.SearchConnectorInstancesQueryParams 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)
      • s - can search on attributes (optional)
      Returns:
      List<ConnectorInstance>

    • searchConnectorInstancesWithHttpInfo

      ApiResponse<List<ConnectorInstance>> searchConnectorInstancesWithHttpInfo(ConnectorInstanceApi.SearchConnectorInstancesQueryParams queryParams)
      Finds ConnectorInstances Finds ConnectorInstances attached to a process or a flow node with pagination params and filters. You can filter on: * `containerId`: the process instance or flow node instance ID * `state`: the connector state `TO_BE_EXECUTED`, `EXECUTING`, `TO_RE_EXECUTE`, `DONE`, `FAILED`, `SKIPPED` * `containerType`: the type of container: either `flowNode` or `process` (since version 10.3 - 2025.1) * `name`: the connector name (since version 10.3 - 2025.1) * `version`: the connector version (since version 10.3 - 2025.1) * `connectorId`: the connector definition ID (since version 10.3 - 2025.1) * `activationEvent`: the container event on which the connector is instanciated: either `ON_ENTER` or `ON_FINISH` (since version 10.3 - 2025.1) Note, this is equivalent to the other searchConnectorInstances 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)
      • s - can search on attributes (optional)
      Returns:
      List<ConnectorInstance>