Opening the Swagger documentation for the WFM public API

To view the Swagger documentation for the WFM public API, you will need to set the /system/WORKBRAIN_PARAMETERS/ALLOW_API_DOCUMENTATION registry to YES from a default of NO.

After setting the registry to YES, you can view the API documentation using this syntax for the URL to generate the Swagger file and display the public APIs in JSON format:

  • <wfmserver URL>/wfmOpenApi

For example, if WFM is deployed at https://mywfmserverurl.infor.com:8443/wbwin/menu.jsp, you will be able to view the JSON format of the API documentation at https://mywfmserverurl.infor.com:8443/wbwin/wfmOpenApi.

You can also view version specific APIs with the following syntax. Version one is displayed by default with the above format. To display version 2 of the public API, specify this URL:

  • <wfmserver URL>/wfmOpenApi?version=2

For more information on setting the registry, see Infor Workforce Management Registry Parameter Reference Guide.