API flow properties
To get to the API flow properties, click either the start or end events, or click the Show API Flow properties link on the left hand side panel.
Request tab
This table shows the properties of the Request tab:
| Name | Description |
|---|---|
| Method | Select an operation: GET, POST, PUT or DELETE. |
| Endpoint Name | Specify the API endpoint name, group of APIs in one API suite. In the first release this must be unique. |
| Endpoint Path | Specify part of URL path identifying the API endpoint. In the first release this must be unique. |
| Resource Name | Specify the API name. |
| Resource Path | You must specify the end of an URL path identifying the resource with the definition of all path parameters. Path parameters must be defined in curly brackets {}, for example: /resourcepath/{PathParameterName}/ |
Request body tab
This table shows the properties of the Request Body tab:
| Name | Description |
|---|---|
| Presence | Select the presence of the request body: Required, Optional or None. |
| Content Type | The request content type is automatically defined as Application/JSON. |
| Name | Specify the request body parameter name. |
| Description | Optionally, specify the body parameter description. |
| Schema | Specify the request body schema, it must be valid a JSON object. |
| Example | Optionally, specify an example of a request body, it must be valid JSON. |
Response tab
This table shows the properties of the Response tab:
| Name | Description |
|---|---|
| Content Type | Response content type is automatically defined as Application/JSON. |
| Body | Specify response body, it must be valid JSON. You can use API Flow parameters with JSON Path expressions. See API Flow parameters.
Because the response must be valid JSON object, you cannot define the API Flow parameter alone, for example: If that is required, leave the response body field empty. The API Flow response defaults to the response of the previous API Gateway step. You cannot leave the response body field empty in case the last step is parallel branch. |
Test tab
Use the Test tab to specify the request parameters and request body. Click to test the complete API Flow. The final API Flow response is displayed in the Response area.