Versions Compared

Key

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

...

To view Endpoint URL of a web service provider activity:

  1. Go to Develop > Services > Web Services > Provider (API) .
  2. Click Endpoint in the WSDL/Documentation column corresponding to the web service activity.



    This displays the Endpoint URL in the new tab of your browser.


                

...

To view API documentation of a web service activity:

  1. Go to Develop > Services > Web Services > Provider (API) .
  2. Click API Doc in the WSDL/Documentation column corresponding to the particular web service activity.



    Info

    Click API Doc to view the API documentation of all web service provider activities.

  3. This displays the API documentation of the selected web service provider activity in the new tab of your browser.



    Option NameDescription
    Show/HideShow or hides all APIs.
    List OperationsDisplays the list view of all the expanded APIs.
    Expand OperationsExpands all APIs to view details.
    Info

    The list of all web service activities populates on the screen, in case you are viewing API documentation of all web service activities.

     

    Select the activity from the left menu to view API details of a particular activity.

  4. Click API method or Expand Operations to view API details. 



  5. Provide the details in the fields and click Try it out to view the response.



...

  1. Go to .../<AdeptiaInstallFolder>/AdeptiaServer/ServerKernel/etc folder.
  2. Open server-configure.properties file in the Text Editor.
  3. Set the path of the logo/image in the abpm.webservice.rest.apidoc.imagepath property. The default URL is "images/api_doc_header.png". 

...

Changing Logo/Image in API Documentation

...

  1. The dimension of the image should be between 50x50 and 50x650. Supported image types are PNG,

...

  1. JPG, GIF, and BMP."

 

...

  1. Save the file.