Collibra API task

The Collibra API task allows you to automate workflow actionsby leveraging Collibra REST APIs, even without dedicated Java APIs. This task handles authentication for seamless API integration.

Supported APIs

You can use the Collibra API to interact with all endpoints of Collibra APIs that have a request and response format which is XML, JSON, or plain text. You can only use this task to call APIs on the same environment and not, for example, to trigger an update from your production environment to a non-production environment. You cannot interact with Data Quality APIs.

Prerequisites

The Collibra API task is available with the update of production environments to version 2025.04. You can add this task in your workflows but you should only deploy an application containing it if the version of your target Collibra environment is 2025.04 or newer. Using a workflow with Collibra API tasks in 2025.03 or older environments results in execution errors.

Attributes: General

Attribute Description
Model ID The unique identifier of the element within the process model.
Name The name of the element displayed in the diagram.
Documentation A description and any additional information about this element.

Attributes: Details

Attribute Description
Request method The method of the request: GET, POST, PUT, DELETE, or PATCH.
Request path The path of the API endpoint, for example /rest/2.0/application/info. You can use expressions such as ${requestPath}. The host is the base URL of your environment.
Request body The body of the request, such as a JSON file which can also contain expressions, for example: {'clientId': ${clientId}, 'name': ${name}}.

The supported formats are: XML, JSON, and plain text.

To avoid unexpected behavior, do not send a body with GET or DELETE requests.
Fail status codes A list of HTTP response status codes to fail the request and throw a runtime exception. You can set code ranges with an X, for example 400, 404, 5XX.

The external API task component treats all response status codes as successful, including 4xx and 5xx.
Handle status codes A list of status codes for which the task will throw a BPMN error, which can be caught by a boundary error event. You can set code ranges with an X, for example 400, 404, 5XX.

Status codes defined here take precedence if the same status codes are defined in the Fail status codes attribute.
Response variable name The name of the process variable to store the HTTP response.

If not specified, the response is stored in the default variable <Model_ID>ResponseBody, for example CollibraApiTask_1ResponseBody.

The supported response formats are XML, JSON, and plain text.
Save request variables Determines whether all the runtime fields related to the request should be stored as process variables, such as header, path, encoding, or body. By default, only fields related to the response are stored as variables.
See all variables
  • ResponseReason
  • RequestUrl
  • RequestHeaders
  • RequestMethod
  • DisallowRedirects
  • ResponseProtocol
  • ResponseStatusCode
  • SaveResponseParameters
  • RequestBodyEncoding
  • RequestTimeout
  • FailStatusCodes
  • HandleStatusCodes
  • SaveRequestVariables
  • ResponseHeaders
  • RequestBody
  • IgnoreException
Save response details Determines whether all the fields related to the response that are not the actual response in the body should be stored as process variables, including HTTP status, headers, and so on. By default, only the response body is stored as a variable.
Result variable prefix A prefix that should be prepended to all the variables for easier grouping, which is useful when there are different external API tasks.

Attributes: Execution

Attribute Description
Exclusive Determines whether the activity or process is run as an exclusive job. An exclusive job ensures that no other asynchronous exclusive activities within the same process are performed at the same time. This helps to prevent failing jobs in concurrent scenarios.
Skip expression Defines an expression which is evaluated before executing the task. If it evaluates to true, the task is skipped.

You must opt-in to enable this feature by setting a process variable _FLOWABLE_SKIP_EXPRESSION_ENABLED with the Boolean value true.
Execution listeners Allows you to invoke Java logic after certain events:
  • Start: Executes after the activity has been started.
  • End: Executes after the activity was completed.
  • Transition: When defined on a sequence flow, executes once the flow is transition is taken.

Attributes: Visual

Attribute Description
Font size The font size of the element in the diagram.
Font weight The font weight of the element in the diagram.
Font style The font style of the element in the diagram.
Font color The font color of the element in the diagram.
Background color The background color of the element in the diagram.
Border color The border color of the element in the diagram.