Managing Infrastructure

The integration namespace infrastructure consists of one section: API Dependencies.

Create an API Dependency

API dependencies are the specification of the external APIs. When created, you are able to easily call the operation provided in the external API.

API Dependencies are created using the following master data:

Property Description
Name

This is the name of the API dependency. It is unique within a namespace. Please note that only the characters A-z (without special characters), digits and the special character "_" are permitted for naming API dependencies! Furthermore, names may not begin with a digit and the first character must be lowercase. The local identifier can not be changed after creation.

This field is mandatory.
API specification

This is the specification of the API that is being integrated. The expected formats are JSON and YAML.

This field is optional.
API Binding

API Bindings are optional specifications created per API dependency. This means that the API binding only lives as a part of the API dependency and shares its lifecycle. It is assigned a unique name internally and will not receive an identifier within the Solution Designer.

API Bindings are created in the Solution Designer together as a part of the corresponding API dependency but stored within the Configuration Management. Values specified in the Configuration Management will always overwrite the ones specified in the Solution Designer and can differ across stages and/or Solution Enoys. An API binding always consists of a JSON string that may also include an URL (as specified in OpenAPI 3).

This field is optional.
Attention: Please notice that SWAGGER Specifications will always be converted to a OPEN Api 3 Specification while uploading the file. In all cases the file will be renamed to YAML.

Edit an API Dependency

You edit the master data of an API dependency by using the Information capability and navigating to the section Master data and using the Edit master data capability or by using the inline and header Edit capability. For a description of the master data, see the section Create an API Dependency. The type and the local identifier cannot be changed. When editing the master data of an API dependency, you can overwrite the values for label, short label and notes. The overwritten values are lost as soon as the editing action has been completed.

Delete an API Dependency

You can delete the API depandency by using the inline Delete capability. Alternativerly, you can use the Information capability to access the details view and there you can use the Delete capability.

You will need to confirm the action before the selected response is permanetely deleted.