Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Click Configure > WEB SERVICES > REST Provider.
  2. On the REST Provider screen, click to the Restful web service.
  3. Click Add DocumentationClick Edit Documentation.

  4. The Add API 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

    NameName of the API Documentation. By default, it shows the provider's value as the name.
    DescriptionDescription about the API Documentation.
    EmailValid email address to send queries.
    TitleTitle of your API documentation. It must contain alphanumeric and few special characters (_ - . : , @ $ ? \\ and space) and must start with an Alphabet/Underscore/Number)


    Method Details

    Description

    SummaryPurpose of the method.
    NotesDescription of the method.
    API ParametersList of parameters, if provided at the time of creating Web Service Provider activity.
    Method PresentationStatus code of the request, response, and fault. You can also provide the description of the status code.


  5. Click Save.

...