Accessing the REST API

Modified on Thu, 23 Apr at 12:20 PM

The REST API allows automated access to various system functions, such as documents or forms. The system provides an integrated API documentation for this purpose.

Accessing the API Documentation

The documentation is accessible directly via your formcycle server. You only need the base URL of your system and append the corresponding paths.

HTML Documentation

The HTML version is intended for use in the browser and provides a clear overview of all available endpoints.

The following areas are available:

/api/rest/public/security/doc/openapi.html
/api/rest/public/doc/openapi.html
/api/rest/public/forms/doc/openapi.html
/api/rest/public/form-records/doc/openapi.html
/api/rest/public/users/doc/openapi.html
/api/rest/public/user-portals/doc/openapi.html

Example:

https://your-server.com/api/rest/public/users/doc/openapi.html

If formcycle is operated under a subpath (e.g. https://your-server.com/formcycle), this must be included in the URL.
Example: https://your-server.com/formcycle/api/rest/public/users/doc/openapi.html

JSON Format

The JSON version is suitable for further processing in tools or for automatic integration.

/api/rest/public/security/doc/openapi.json
/api/rest/public/doc/openapi.json
/api/rest/public/forms/doc/openapi.json
/api/rest/public/form-records/doc/openapi.json
/api/rest/public/users/doc/openapi.json
/api/rest/public/user-portals/doc/openapi.json

YAML Format

Alternatively, the documentation is also available in YAML format.

/api/rest/public/security/doc/openapi.yaml
/api/rest/public/doc/openapi.yaml
/api/rest/public/forms/doc/openapi.yaml
/api/rest/public/form-records/doc/openapi.yaml
/api/rest/public/users/doc/openapi.yaml
/api/rest/public/user-portals/doc/openapi.yaml

Notes

The API documentation is based on the OpenAPI standard.
Depending on the system configuration, access may only be possible with the appropriate permissions.