Page Comparison

To add API Documentation for RESTful web services:

1. Click Configure > WEB SERVICES > REST Provider.
2. On the REST Provider screen, click to the Restful web service.

3. Click Edit Documentation.

4. The Edit Documentation window appears with API and Method Details for the chosen RESTful web service. By default, the values in the API Details section are filled automatically based on the chosen web service. You can change the values as per your requirements.

   

   API Details	Description
   Title	Title of your API documentation. It must contain alphanumeric and few special characters (_ - . : , @ $ ? \\ and space) and must start with an Alphabet/Underscore/Number).
   Description	A short description of the API Documentation.
   Email	Valid email address to send queries.
   License Name	The name of the license for the API endpoint.
   License URL	The URL of the license for the API endpoint.
   Version	A version for the API. It lets the user know exactly what sort of differences exist between the newest version and the version they are using.
   Name	Name of the API Documentation. By default, it shows the provider's value as the name.
   Server Description	The name of the environment that will be displayed adjacent to the server URL in the API documentation. For example: Sandbox, Production, Testing etc.

   
   

   Method Details	Description
   Summary	Purpose of the method.
   Notes	Description of the method.
   API Parameters	List of parameters, if provided at the time of creating Web Service Provider activity.
   Method Presentation	Status code of the request, response, and fault. You can also provide the description of the status code.

   
   

5. Click Save.
   

...