HTTP Task

HTTP Task

An HTTP task submits an HTTP call and stores the result.

Attributes

Group Attribute Description

General

ID

A unique ID for the element. The ID is used to refer to a model element from outside of the diagram (for example, from a CMMN Action button in a form or when referring to a model element, such as plan item ID, in a CMMN REST call). For convenience, this ID can be edited.

Name

The name of the element. This is the name displayed in the diagram. If no run-time name is specified, this name is also used in the running case.

Description

The description attribute additionally adds a description to the component.

Documentation

Documentation intended to explain concepts of its use for future reference.

Details

Request URL

Request URL of the HTTP call. Can contain expressions, e.g., 'http://your-system.example.com/your-endpoint/${someVariable}'.

Result variable prefix

A prefix that is added to the result variable name for easier grouping. The following variables are affected: responseProtocol, responseReason, responseStatusCode, responseHeaders, responseBody, errorMessage.

Request timeout

Request timeout in milliseconds.

Request method

Request method to be used in the HTTP call: GET, POST, PUT or DELETE.

Fail status codes

List of Http response status codes to fail the request and throw a FlowableException. Code ranges can be set with an X: Example: 400, 404, 5XX

Request body encoding

Encoding of the request body.

Request body

Request body to be sent, e.g., a JSON file. You can use expressions, e.g., {'clientId': ${clientId}, 'name': ${name}}

Asynchronous

When enabled, the behavior of the plan item is executed as an asynchronous job. This happens when the plan item transitions to the ACTIVE state. During the execution of the behavior, the plan item is set to an intermediate ASYNC_ACTIVE state.

Ignore exception

Determines whether exceptions are ignored and stored in the variable indicated in the response variable.

Save response as JSON

Determines whether the response variable is stored as a JSON variable instead of a String.

Save request variables

Determines whether all request variables are stored. By default, only response related variables are stored as variables.

Save response as a transient variable

Determines whether the response variables should be stored as transient.

HttpTask.class.title

HttpTask.class.description

Handle status codes

List of status codes for which the task throws a BpmnError which can be caught by a boundary error event. Code ranges can be set with an X: Example: 400, 404, 5XX. Status codes in handleStatusCodes override those in failStatusCodes when they are set in both.

Save response details

Determines whether response variables including HTTP status, headers, etc. are stored. By default, only the response body is stored as a variable.

Request headers

Line-separated HTTP request headers.

Response variable name

The variable name in which the HTTP response is stored.

Disallow redirects

Determines whether HTTP redirects are allowed.

Required

Select this option to mark the element as required (exclamation mark decorator).

Required plan items must either be in the state COMPLETED, TERMINATED or DISABLED for their parent stage to complete.

Repetition

Select this option to mark the element as repeatable (number sign decorator).

By default, only one instance of a plan item may be created at runtime. Repeatable plan items do not have that limitation.

The combination of this property, Manual activation, and no entry sentry has a special meaning called Automatic repetition: As a previous instance of the plan item completes, a new instance is automatically created and set into state Enabled.

Completion neutral

Completion neutral influences the plan item’s parent stage completes.

Plan items in the state AVAILABLE may prevent the parent stage (or case) from automatically completing. By checking this property, the plan item behaves neutral with respect to the completion of the parent container.

Activation

Manual activation

Select this option to mark the element to have Manual activation (right arrow 'play' decorator).

Plan items with Manual activation move from state AVAILABLE to state ENABLED once they trigger. A plan item in state ENABLED exposes an action button that allows the user to manually start the plan item.

More

Lifecycle listeners

Allows you to define lifecycle listeners for a plan item. Lifecycle listeners allow you to execute an expression, a delegate expression or a class when a plan item transitions from one state to another.

Visual

Font weight

The font weight of the element in the diagram.

Font size

The font size of the element in the diagram.

Font color

The font color of the element in the diagram.

Font style

The font style 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.