Factory Lens — Usage Guide

Overview

Factory Lens exposes secure REST APIs that allow you to retrieve dependency and integration metadata from an OutSystems 11 factory.

It can be used to support:

• Architecture discovery
• Dependency analysis
• Integration inventory
• Impact analysis
• Governance dashboards
• AI-assisted architecture documentation
• Automated diagram generation

Factory Lens exposes metadata such as:

• Application dependencies
• Module-to-module dependencies
• Strong and weak dependencies
• Referenced elements
• Consumed REST integrations
• Exposed REST integrations
• Consumed SOAP integrations
• Exposed SOAP integrations

API Authentication

All Factory Lens APIs are protected using an API key.

The API key must be sent in every request using the following HTTP header:

x-api-key: <your-api-key>

Requests without a valid API key will be rejected with:

401 Unauthorized

Step 1 — Generate an API key
Generate a strong random API key.
Example format:
flens_<random-secure-token>

Step 2 — Store the API key in Factory Lens
The API key is configured in the FactoryLensAPI module using a Secret Site Property.
In Service Center:
Go to Factory.
Open Modules.
Search for:
FactoryLensAPI
Open the module details.
Go to Site Properties.
Find the API key site property.
Example name:
FactoryLensAPIKey
or, if your implementation stores a hash:
FactoryLensAPIKeyHash
Set the value.
Save the configuration.
Because this is a Secret Site Property, the value is stored securely and should not be exposed in logs, screens, or API responses.

Common API endpoints
The available endpoints may depend on the installed version of Factory Lens.
Typical endpoints include:
GET /FactoryLensAPI/rest/v1/dependencies/modules
GET /FactoryLensAPI/rest/v1/dependencies/modules/details
GET /FactoryLensAPI/rest/v1/integrations/rest/consumed
GET /FactoryLensAPI/rest/v1/integrations/rest/exposed
GET /FactoryLensAPI/rest/v1/integrations/soap/consumed
GET /FactoryLensAPI/rest/v1/integrations/soap/exposed
GET /FactoryLensAPI/rest/v1/integrations
Example with filters:
GET /FactoryLensAPI/rest/v1/dependencies/modules?applicationName=Customer%20Portal&direction=BOTH
Example integration query:
GET /FactoryLensAPI/rest/v1/integrations?protocol=REST&direction=CONSUMED

Minimal setup checklist
Before using Factory Lens, confirm that:
FactoryLensAPI is published.
The API key Secret Site Property is configured.
The API key is sent using the x-api-key header.
The required System and Extended Metamodel entities are referenced.
The dependency endpoints return data.
The integration endpoints return data.
Factory Lens Demo points to the correct API base URL.