Skip to content

Is there a way to get IFS Cloud's REST API described as a standard OpenAPI/Swagger .yaml or .json specification file, so it can be fed into a generic OpenAPI code generator to produce a client library in a language IFS doesn't provide a client for directly?

Answer

Yes — the REST API Documentation available from API Explorer is itself built from a full OpenAPI specification (in JSON format) that IFS Cloud serves directly. You can find the exact endpoint by opening your browser's developer tools, going to the Network tab, filtering for XHR requests, and refreshing the API Documentation page — that reveals a request to an $openapi-suffixed endpoint on the AllProjections.svc projection, which returns the complete OpenAPI v3 specification for your environment's API. That JSON specification can then be fed into any standard OpenAPI-based code generator (or an IDE's built-in OpenAPI client-generation tooling) to produce a client library in whatever target language you need.

← Browse Integrations and APIs questions