Skip to main content

Reference

 

OutSystems

OutSystems APIs

OutSystems provides APIs that allow you to extend the capabilities of your applications. With these APIs you can integrate your applications with external systems, and programmatically access OutSystems features.

Check here the available APIs:

Business Processes

API Name Available As Description
BPT API Referenced extension Provides performance monitoring data collected from the environments managed by LifeTime.
Processes API Referenced system module Provides a highly scalable mechanism to perform logging.
EPA TaskBox API Referenced module Provides access to the BPT taskbox, allowing you to extend its functionality according to your specifications.

Charts

API Name Available As Description
Charts API Referenced module Allows you to plot charts for the web and mobile devices.

Client-side Behavior

API Name Available As Description
outsystems.api.preloader API Referenced extension and JavaScript file A JavaScript API that allows you to prefetch static resources (css, js, png, gif. jpg, jpeg, woff) for a list of modules.
outsystems.api.requestInfo API Predefined JavaScript object A JavaScript API that provides methods to get information about the current request and session.

Database

API Name Available As Description
DbCleaner API Referenced module Provides you the actions to drop tables and columns in the database related with entities, attributes, or module versions.
PlatformRuntime API Referenced extension Allows your applications to switch the database connection in runtime.
RuntimePublic.Db API .NET classes Allows your extensions modules to call the databases configured in the environment console.

Emails

API Name Available As Description
Emails API Referenced system module Allows you to access data about your Emails.

End-User Management

API Name Available As Description
Users API Referenced module Allows you to programmatically manage OutSystems Users and Roles.

Infrastructure and IT Users management

API Name Available As Description
LifeTime Deployment API v2 REST API Allows you to manage applications, modules, environments and deployments of your OutSystems infrastructure. Version 2 of the API adds support for deployment zones.
LifeTime Deployment API v1 REST API Allows you to manage applications, modules, environments and deployments of your OutSystems infrastructure.
LifeTime Services API SOAP web services Provides you functionality to manage the infrastructure made available by OutSystems.
LifeTime SDK Referenced module API for extending the LifeTime functionality including developing your own plug-ins.

Integration

API Name Available As Description
BinaryData API Referenced extension API to manipulate binary content such as conversions from and to Text or Base64 Text, encoding conversion, binary content length, and binary data comparison.
EnhancedWebReferences API Referenced extension (Deprecated API) API to dynamically change Web Service and Web Reference URLs, SOAP headers, credentials, and proxies.
HTTPRequestHandler API Referenced extension API with functionality to allow you to manipulate HTTP Requests and Responses.
REST Extensibility API .NET classes API that enables you to access the content of requests and responses used by methods consumed from other REST APIs.
SAP Extensibility API .NET libraries API that enables you to customize your connection and calls to SAP remote functions through an extension.
SOAP Extensibility API .NET classes API that enables you to modify the SOAP connection, request and/or response message through an extension.

Monitoring and Traceability

API Name Available As Description
Asynchronous Logging API Referenced extension Provides a highly scalable mechanism to perform logging.
PerformanceMonitoring API REST API Provides you REST API methods to retrieve or register request events of your applications. Request events contain metrics about the user experience of your applications.

Scripting

API Name Available As Description
IncludeJavaScript API Referenced extension Allows you to programmatically include JavaScript snippets in all Web Screens.
JavaScript API Predefined JavaScript objects Allows you to call OutSystems specific actions and act upon mobile app events in your JavaScript code, to tweak and customize the mobile app experience of the final user.

System Actions

API Name Available As Description
System Actions Referenced system module Contains client and server actions that allow you to operate on system elements like lists and activities.

Security and Cryptography

API Name Available As Description
PlatformPasswordUtils API Referenced extension Provides you actions for validating and securely storing passwords in the database, compliant with established cryptographic practices.
Sanitization API Referenced extension Provides methods to avoid code injection in HTML, JavaScript and SQL snippets that need to include untrusted content, i.e., content gathered from end-users.

Text

API Name Available As Description
Text API Referenced extension Provides functionality to manipulate texts as, for example: search and replace using a regular expression, split, join, or format DateTimes.

Articles in this Section

  • Asynchronous Logging API
  • BinaryData API
    Provides Actions to manipulate BinaryData contents, such as retrieving the length or transforming binary content into Text.
  • BPT API
    Low-level API to create custom inboxes for process activities.
  • DbCleaner API
    Allows freeing-up database space.
  • Emails API
    The Emails API allows you to get information from the OutSystems data model to customize and extend the design of your Emails.
  • EnhancedWebReferences API
    API to dynamically change Web Service and Web Reference URLs, SOAP headers, credentials, and proxies.
  • EPA Taskbox API
    The Embedded Process Automation (EPA) automatically displays in the user's web browser all pending activities in a floating taskbox. The Embedded Process Automation (EPA) automatically displays in the user's web browser all pending activities in a floating taskbox.
  • HTTPRequestHandler API
    Provides actions to manipulate HTTP Requests and Responses.
  • IncludeJavascript API
  • LifeTime Deployment API v1
    Allows you to manage applications, modules, environments and deployments of your OutSystems infrastructure.
  • LifeTime SDK
    Core layout components and APIs used by LifeTime and its plugins.
  • LifeTime Services API
    Provides you functionality to manage the infrastructure made available by OutSystems.
  • outsystems.api.preloader API
    A JavaScript API that allows you to prefetch static resources (css, js, png, gif. jpg, jpeg, woff) for a list of modules.
  • outsystems.api.requestInfo API
    A JavaScript API that provides methods to get information about the current request and session.
  • PerformanceMonitoring API
    API to access logged request events by OutSystems Platform with valuable data for your analytics. You can use it to analyze the user experience of your applications.
  • PlatformPasswordUtils API
    Provides actions for validating and securely storing passwords in the database, compliant with established cryptographic practices.
  • PlatformRuntime API
    Allows manipulating runtime configurations for the environment.
  • Processes API
    The Processes API allows you to get information from the OutSystems data model to customize and extend the design of your Processes.
  • REST Extensibility API
    Enables you to access the content of requests and responses used by methods consumed from other REST APIs in .NET.
  • Sanitization API
    API that provides methods to avoid code injection in HTML, Javascript and SQL snippets that need to include untrusted content, i.e., content gathered from end-users.
  • SAP Extensibility API
    The OutSystems SAP Extensibility API enables you to customize your connection and calls to SAP remote functions through an extension.
  • SOAP Extensibility API
    Enables you to modify the SOAP connection, request and/or response message in an extension.
  • System Actions
    List of System Actions (both server actions and client actions) available in OutSystems, including list operations.
  • Text API
    Provides actions to manipulate character strings such as joining, splitting, search and replace using regular expressions, and custom formatting of DateTime expressions.
  • Users API
    API to manage users, groups and roles.
  • Was this article helpful?