Limitations of API Wrapper¶
This section describes the four steps of the API Wrapper Action creation process. In addition, it lists the supported and unsupported input/output parameters.
If you encounter errors with a botlet, refer to the Swagger Error and Exceptions List for more details.
The API Wrapper Action Creation contains four steps:
- Add action parameters
- Enter API information
- Inbound mapping rules
- Outbound mapping rules
Note: The following sections will list supported and not supported operations in each step.
1. Add Action Parameters¶
First, you are required to fill the input and output parameters. Input parameters are used to fill in the API request. Supported and not supported input entity types are shown below in Table 1.
Table 1. Supported and not supported input parameters
Output parameters are used to store the selected value in the API response. Table 2 shows the supported and not supported output parameters.
Table 2. Supported and not supported output parameters
2. Enter API Information¶
In this step, fill the API parameters you need to configure:
API methods (i.e., supported methods: POST, GET, PUT, PATCH, DELETE), headers, and body
3. Inbound Mapping Rules¶
In this step, you are required to mark out URL parameters. In most cases, the URL and body will be changed for different API requests, so URL and body parameters are supported to be changed. Headers cannot be changed. Refer to image 1 and image 2 below.
Image 1. Supported inbound mapping parameters
Image 2. Headers cannot be changed
4. Outbound Mapping Rules¶
Outbound mapping rules require that you map the outbound API response to the output entities. You can drop the API response field to two kinds of Output entities fields: Atomic type and List type
Table 3 and table 4 show the supported and not supported <API response field, Output entities field> pairs.
Table 3. Outbound to Atomic type
Image 3. JSON object value (without array) to Atomic type
Image 4. JSON object value (with array, first one) to Atomic type
Image 5. JSON object value (with array, not first one) to Atomic type
Table 4. Outbound to list
Image 6. JSON object value (with one-dimensional array) to list of atomic type
Image 7. JSON object value (with one-dimensional array) to list of user defined type
Image 8. JSON object value (with one-dimensional array) to user defined type with list
Image 9. JSON object value (with multidimensional array) to list of Atomic type
Image 10. JSON object value (without array) to list of Atomic type