OpenAPI

Designers can use OpenAPI documents to generate a connected system that can inherit base URLs, authentication details, and a list of operations. Then, using that connected system, the designer can create integrations for those operations. Appian will automatically generate an expression for the URL with rule inputs for any path parameters. It will also generate required headers and query parameters.

Properties

In addition to the common properties, an OpenAPI connected system has the following properties:

Field Description
System Logo An image document used to visually represent the external system or service being connected to. The logo is displayed in the integration designer and in the process modeler on integrations that connect to this system (using the Call Integration Smart Service). If no document is selected a default logo will be used instead.
OpenAPI/Swagger Document An OpenAPI documents (formerly known as a Swagger document) defines a standard interface to a RESTful API. They can be read by a human or computer to understand the capabilities of a web service without access to source code/documentation. By uploading these to your connected system, Appian can inherit base URLs, authentication details, and a list of operations.
Base URL A consistent prefix for the URLs of this connected system's integrations. This value supports environment specific configuration for variation across environments. This value can be selected from the list of base URLs that are inherited from the attached OpenAPI document.
Authentication The type of authentication that integrations leveraging this connected system will use. For authentication options, see Connected System Authentication.

Open in Github Built: Thu, Oct 14, 2021 (02:44:31 PM)

On This Page

FEEDBACK