Viewing the Automation API Documentation

The FlexApp Packaging Automation API can be used to integrate silent, automatic capturing of FlexApp, and FlexApp One packages into existing automation platforms or scripts.

Scenario 1 - Automated Packaging Queue / Batch Jobs

FPA Primary Package Manager and FPA Package Capture Agent(s) used in a "queue-like" manner. The Primary Package Manager accepts capture job submissions and submits them to available Package Capture Agent(s). Jobs can be submitted in batches or singularly.

  1. Enable the API documentation "Swagger" page on the Primary Service and restart it.
  2. At an elevated cmd prompt, enter the following:
Copy
"C:\Program Files (x86)\Liquidware Labs\FlexApp Packaging Automation\Primary-Service.exe" update /EnableSwagger
                net stop lw-primary-service
            net start lw-primary-service

Note: You can now see the available API endpoints by accessing the Primary Service's web port: https://<primaryName>:9075/

  1. To disable the API Swagger page, re-run the same commands used to enable it, except omit the /EnableSwagger argument.

Scenario 2 - Single-instance capture scenarios / No batching

FPA Package Capture Agent used in standalone, single-threaded manner as part of existing automation or script workflows. This can be used in a DEVOPS scenario where an internal application is updated/built regularly. The new builds can automatically, and immediately, be captured as a FlexApp and FlexApp One package.

  1. Enable the API documentation "Swagger" page on the Agent Service and restart it.
  2. At an elevated cmd prompt, enter the following:
Copy
"C:\Program Files (x86)\Liquidware Labs\FlexApp Packaging Automation\Agent-Service.exe" update /EnableSwagger
                net stop lw-agent-service
            net start lw-agent-service

Note: You can now see the available API endpoints by accessing the Agent Service's web port: https://<primaryName>:9075/

  1. To disable the API Swagger page, re-run the same commands used to enable it, except omit the /EnableSwagger argument.

Note: For additional information, or to download the latest version of FlexApp Packaging Automation, please refer to the FlexApp Packaging Automation documentation.