Web services catalog

An online catalog of your registered web services can be accessed to display the documentation of your registered web services, one specific web service or a specific version of a web service.

The documentation is available via the following URLs:

• http://<server>:<port>/arcapi/catalog
• http://<server>:<port>/arcapi/help/all
• http://<server>:<port>/arcapi/help/<web-service_root_context>
• http://<server>:<port>/arcapi/help/<web-service_root_context>/<version_number>

The server and port must correspond to the ARCAD-API Server on which the web services were created. The catalog is automatically generated from the services you have created and pushed to production in the studio. Click on a web service to open the full documentation.

In this page, you will see:

• the version of the web service used by the parent API,
• the description of the web service as defined in the designer,
• the root context of the web service,
• this URL that must be used,
• the JSON Input format,
• the JSON Output format,
• the list of the messages that could be returned in case of failure.

This page is directly reachable using the following URL:

http://<arcad-api-server>:<arcad-api-port>/arcapi/help/<web-service-root-context>/<web-service-version>