Skip to Content

HTTP v2 (Beta) Connector

Summary

The Jitterbit Harmony HTTP v2 (Beta) Connector establishes access to an HTTP server through a RESTful web service (REST API).

Note

This connector is currently released as a beta version. Feedback on bugs and suggested enhancements can be provided through your Customer Success Manager (CSM).

The HTTP v2 (Beta) connector provides an interface for creating an HTTP v2 (Beta) connection, the foundation used for generating instances of HTTP v2 (Beta) activities. These activities, once configured, interact with an HTTP server through the connection.

The HTTP v2 (Beta) connector is accessed from the design component palette's Connections tab (see Design Component Palette).

For other ways to connect to a RESTful web service and a comparison with the HTTP connector, see REST-based Connector Considerations.

Connector Overview

This connector is used to first configure an HTTP v2 (Beta) connection. Activity types associated with that connection are then used to create instances of activities that can be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Whether an activity instance can be used as a source or a target depends on whether the web service requires a structured request or returns a structured response. Each activity instance can be configured with request and response schemas using either user-provided custom schemas or default schemas included with the connector.

Together, a specific HTTP v2 (Beta) connection and its activities are referred to as an HTTP v2 (Beta) endpoint:

HTTP v2 (Beta) activity types

  • PATCH: Applies partial modifications to an existing resource on an HTTP server and can be used as a source or target in an operation.

  • HEAD: Retrieves the status line and header section of a resource on an HTTP server and can be used as a source or target in an operation.

  • POST: Creates a new resource on an HTTP server and can be used as a source or target in an operation.

  • GET: Retrieves information about a resource on an HTTP server and can be used as a source or target in an operation.

  • OPTIONS: Retrieves information about the communication options for a resource on an HTTP server and can be used as a source or target in an operation.

  • DELETE: Deletes a resource on an HTTP server and can be used as a source or target in an operation.

  • PUT: Replaces an existing resource on an HTTP server and can be used as a source or target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The HTTP v2 (Beta) connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The HTTP v2 (Beta) connector is used to interact with an HTTP server using a user-specified REST API. The HTTP v2 (Beta) connector's request and response schemas are defined from either user-provided custom schemas or default schemas included with the connector.

Troubleshooting

If you experience issues with the HTTP v2 (Beta) connector, these troubleshooting steps are recommended:

  1. Ensure the HTTP v2 (Beta) connection is successful by using the Test button in the configuration screen. If the connection is not successful, the error returned may provide an indication as to the problem.

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.http" level="DEBUG"/>

  5. If using Private Agents, you can check the agent logs for more information.