webMethods 10.2 | Service Development Help | Working with REST API Descriptors | Working with REST Resources in a REST API Descriptor | About Operation Responses
 
About Operation Responses
 
Adding an Operation Response
Removing an Operation Response
An operation response is a possible response a client can expect when invoking an operation in the REST API descriptor. When you add a REST resource to a REST API descriptor, Designer creates two responses for each operation in the REST resources:
*Successful with a returned HTTP status code of 200.
*Access Denied with a returned HTTP status code of 401.
You can add or delete operation responses. For example, you might want to have a response for successful execution of an operation and a separate response for each known error the operation can return. Designer requires that an operation have at least one response. If an operation has only one response, it is a best practice to make sure that the response is for successful execution of the operation.
When an operation returns output, the returned output needs to have some explanation, such as the returned parameters. In general, Integration Server derives the output from the output signature of a service corresponding to the REST operation. If a service has output parameters, Integration Server generates a REST definition that corresponds to the output signature.
When an operation returns output with the response and the operation has output parameters, the HTTP status code includes a hyperlink. When clicked, Designer opens the REST Definitions tab and displays the response document for the operation.

Copyright © 2017-2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release