Software AG Products 10.7 | Integrating On-Premises and Cloud Applications | Service Development | Working with REST API Descriptors | Swagger Based Provider REST API Descriptors | Working with REST Resources in a REST API Descriptor | About Operation Responses | Adding an Operation Response
 
Adding an Operation Response
You can add a response to any operation in a REST resource that is included in a REST API descriptor (RAD).
*To add a response to an operation
1. In the Package Navigator view, lock and open the RAD that contains the REST resource operation for which you want to add a response.
2. Click the REST Resources tab.
3. Expand the REST resource for which you want to add an operation response.
4. Expand the operation for which you want to add the operation response.
5. Click Responses.
Designer displays the responses for the operation.
6. Click .
7. In the Add Response dialog box, supply the following information:
In this field...
Specify...
Code
The HTTP status code that the operation can return
Description
Short description of the response.
Return Output
Whether or not the operation returns output with the response. Select one of the following:
*True if the operation returns output with the response.
Typically a REST operation returns output for successful HTTP status code, such as status code of 200.
*False if the operation does not return output with the response. This is the default.
8. Click File > Save.