Exposed REST API
Collaborate with us
Edit this page on GitHub
Exposed REST API
- Getting started
- Developing an Application
- Application Templates
- Use Data
- Data Modeling
- Edit data while developing
- Query Data
- Fetch and display data from the database in OutSystems
- Fetch and display data from an integration
- Filter Query Results
- Sort Results in an Aggregate
- Calculate Values from Grouped Data
- Aggregate a Column into a Single Value
- Implement asynchronous data fetching using Aggregates
- Create a Calculated Attribute in an Aggregate
- Get Distinct Values from the Database
- SQL Queries
- Implement encryption and decryption for HIPAA compliance
- Secure the Data of your Mobile Apps
- Download a file through browser
- Bootstrap an Entity Using an Excel File
- Use Structures and Records to Create Compound Data Types
- Use Site Properties to Configure Behaviors at Runtime
- Sessions in Web Applications
- Share a Client Variable between apps
- Use Resources
- Caching
- Offline
- Design UI
- Screen
- Accessibility
- Screen Templates
- Creating Screen Templates
- Creating and editing tables
- Inputs
- Forms
- Images
- Look and Feel
- Reuse UI
- Accelerators
- Patterns
- Using Mobile and Reactive Patterns
- Using Traditional Web Patterns
- Navigation
- Translating the app UI
- Multilingual Reactive Web and Mobile Apps
- Implement Application Logic
- Edit expressions
- AI-assisted development
- Actions in Reactive Web and Mobile Apps
- Actions in Web Applications
- Screen and Block Lifecycle Events
- Use a For Each to Iterate a List
- Update List Items on a Screen
- Use Ajax to Refresh Part of a Screen
- Send an Email From a Web Application
- Emails in Mobile and Reactive Web Apps
- Handle Exceptions
- Use Processes (BPT)
- Use Timers
- Reuse and Refactor
- Secure the Application
- End User management
- User Roles
- Restrict Access to an Internal Network
- Secure HTTP Requests
- Troubleshooting Applications
- Merge the Work
- SEO in Reactive Web Apps
- Testing your application
- Service Studio Shortcuts
- Delivering Mobile Apps
- Customize Your Mobile App
- Generate and Distribute Your Mobile App
- Mobile App Update Scenarios
- Technical Preview - Configure mobile apps updates distribution
- Mobile Apps Build Service
- Distribute as a progressive web app
- Harden the protection of mobile apps with AppShield
- Compliance with Third Party Licenses
- Extensibility and Integration
- Artificial Intelligence
- Use the Azure LUIS Connector in OutSystems apps
- Use the Azure QnA Maker Connector in OutSystems apps
- Use the Azure ML Connector in your OutSystems applications
- Use the AI Language Analysis component in your OutSystems apps
- Create AI-powered chatbots
- The chatbot architecture
- Get started: create an FAQ chatbot for your app
- Chatbot configuration wizard
- Create advanced logic for more AI functionalities
- Create custom chatbot UI
- Reply with cards
- Add a chatbot UI block to your app
- Create and configure the chatbot webhook module
- Create and deploy a knowledge base in Azure
- Create the chatbot resources in Azure
- Reference
- The Azure resources reference
- Mobile Plugins
- JavaScript
- Create connectors with Integration Builder
- How Integration Builder works
- How to set up Integration Builder
- Use Integration Builder
- Structure of generated integrations
- Troubleshooting Integration Builder
- REST
- Consume REST APIs
- Expose REST APIs
- Expose a REST API
- Add Basic Authentication to an Exposed REST API
- Add Custom Authentication to an Exposed REST API
- Customize REST URLs
- Customize REST API Responses
- Preprocess REST API Requests
- Change the HTTP Status Code of a REST API
- Throw a Custom Error in an Exposed REST API
- Document an Exposed REST API
- PATCH method on exposed REST services
- Troubleshoot a REST API
- SOAP
- Set the logging level of REST and SOAP integrations
- Extend Logic with Your Own Code
- Integrate with an External Database
- Configure OutSystems to Send Emails
- Artificial Intelligence
- Managing the Applications Lifecycle
- Manage Your OutSystems Infrastructure
- Deploy Applications
- Tag a Version
- Deploy an Application
- Deployment Plans
- Technical Preview - Configure Site Properties During Deployment
- Configure Application Settings After Deployment
- Deploy an Application with Dependencies
- Deploy a Single Module
- Plan a Deployment for the Operations Team
- Deploy in a Short Deployment Window
- Deploy to an Environment with Applications with Errors
- Deploy an Integration With an External Database
- Apply a Hotfix
- Repair Deployed Applications
- Refactor an Application
- Rollback to a Previous Version
- Selective Deployment Using Deployment Zones
- Override the Default Mobile Extensibility Configurations
- Gather user feedback
- Manage IT Users
- Understand the Permission Model for IT Users
- Create and Assign Roles
- Create an IT User
- Create an IT Team
- Set Up the Permissions in a Team
- Grant Permissions for Specific Applications
- Control Who Creates Applications
- Allow Managers to Handle Permissions of IT Teams
- Allow Integrations With External Databases
- Find Out the Permissions of IT Users
- Secure the Applications
- Monitor and Troubleshoot
- Manage technical debt with Architecture Dashboard
- How does Architecture Dashboard work
- How to set up Architecture Dashboard
- Getting started with Architecture Dashboard
- Get an overview of the overall technical debt
- Code Analysis Patterns
- How to enable or disable auto-classification
- How to change module classifications
- How to configure Architecture Dashboard probes in OutSystems 10
- How to update the Architecture Dashboard probes
- How to request a synchronization
- How to use a proxy to connect to Architecture Dashboard
- Architecture Dashboard FAQs
- Troubleshooting
- Test Automation in the Delivery Lifecycle
- Lifecycle Management and Data Protection
- Setting Up OutSystems
- Possible setups for an OutSystems infrastructure
- OutSystems system requirements
- OutSystems network requirements
- Default Platform Server and database configurations
- Configure your OutSystems environment
- Configure the infrastructure management console
- Unattended Installation and Upgrade
- OutSystems on Microsoft Azure
- Reference
- OutSystems Language
- Data
- Extensibility and Integration
- Mapping External DB Data Types to OutSystems Data Types
- REST APIs
- Consumed REST API
- Mapping REST Data Types to OutSystems Data Types
- REST API
- REST API Method
- Input Parameter (REST API Method)
- Output Parameter (REST API Method)
- Structure (REST API Method)
- Structure Attribute (REST API Method)
- REST API Callback
- Input Parameter (REST API Callback)
- Output Parameter (REST API Callback)
- Structure (REST API Callback)
- Structure Attribute (REST API Callback)
- Exposed REST API
- Built-in HTTP Status Codes
- Supported Media Types in REST API Requests
- REST API
- REST API Method
- Input Parameter (REST API Method)
- Output Parameter (REST API Method)
- REST API Callback
- Input Parameter (REST Service API Callback)
- Output Parameter (REST Service API Callback)
- Structure (REST Service API Callback)
- Structure Attribute (REST Service API Callback)
- REST API Callback (Authentication)
- Input Parameter (REST Authentication)
- Consumed REST API
- SOAP Web Services
- Consumed SOAP Web Service
- Mapping XML Data Types to OutSystems Data Types
- Consumed SOAP Web Services Constraints
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPClient.final.md
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPAction.final.md
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPActionInput.final.md
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPActionOutput.final.md
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPDynamicUsernameInput.final.md
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPDynamicPasswordInput.final.md
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPCallbackActionFlow.final.md
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPStaticEntity.final.md
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPStaticEntityAttribute.final.md
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPStructure.final.md
- ref/lang/auto/ServiceStudio.Plugin.SOAP.SOAPStructureAttribute.final.md
- Deprecated Implementation
- ref/lang/auto/Class.SOAP Web Service (Deprecated).final.md
- ref/lang/auto/Class.Web Service Method (Deprecated SOAP).final.md
- ref/lang/auto/Class.Input Parameter (Deprecated SOAP).final.md
- ref/lang/auto/Class.Output Parameter (Deprecated SOAP).final.md
- Structure (Deprecated SOAP)
- Structure Attribute (Deprecated SOAP)
- Exposed SOAP Web Service
- Consumed SOAP Web Service
- Logic
- Interfaces
- Platform Utilities
- Processes
- Workspace
- Traditional Web
- Web Interfaces
- Adding Data and Logic
- Designing Screens
- Button Widget
- Cell Widget
- Check Box Widget
- Combo Box Widget
- Comment Widget
- Container Widget
- Editable Table Widget
- Edit Record Widget
- Expression Widget
- Form Widget
- Header Row Widget
- If Widget
- Image Widget
- Input Password Widget
- Input Widget
- Label Widget
- Link Widget
- List Box Widget
- List Records Widget
- Placeholder Widget
- Radio Button Widget
- Row Widget
- Show Record Widget
- Table Records Widget
- Table Widget
- Text Widget
- Upload Widget
- Web Block Widget
- Patterns
- Accordion Reference
- Alert Reference
- Align Center Reference
- Animate Reference
- Animated Label Reference
- Badge Reference
- Balloon Reference
- Blank Slate Reference
- Breadcrumbs Reference
- Bullets Reference
- Button Group Reference
- Card Reference
- Card Background Reference
- Card Sectioned Reference
- Carousel Reference
- Chat Message Reference
- Character Count Reference
- Columns Reference
- Counter Reference
- Date Picker Reference
- Dropdown Reference
- Dropdown Select Reference
- Fieldset Reference
- File Upload Reference
- Flip Content Reference
- Floating Actions Reference
- Gallery Reference
- Icon Badge Reference
- Iframe Reference
- Input with Icon Reference
- Layout Login Reference
- Layout Login Split Reference
- Layout Popup Reference
- Layout Side Menu Reference
- Layout Top Menu Reference
- Light Box Image Reference
- Load on Visible Reference
- Login Form Reference
- Modal Reference
- Navigation Bar Reference
- Panel Reference
- Progress Bar Reference
- Progress Circle Reference
- Range Slider Reference
- Range Slider Interval Reference
- Responsive Table Reference
- Search Reference
- Balloon Search Reference
- Section Reference
- Section Index Reference
- Separator Reference
- Sidebar Reference
- Stacked Icon UI Pattern Reference
- Tabs Reference
- Tag Reference
- Timeline Reference
- Time Picker Reference
- Toggle Button Reference
- Tooltip Reference
- User Initials Reference
- Video Reference
- Wizard Reference
- Designing the Layout
- Navigating in the Application
- Web Logic Tools
- Web System Events
- Module
- Web Interfaces
- Configuration Tool
- Errors and Warnings
- Errors
- 1-Click Publish Required Error
- Change target directory error
- Concurrent Publishing Error
- Connection Error
- Database Upgrade Error
- Duplicated Page Name
- Empty 'OnException'
- Empty Widget
- Environment Fault Error
- Expression Overflow Error
- Grid Dimensions Overflow Error
- Incompatible Date Formats Error
- Incompatible Version Error
- Internal Error
- Invalid Action Flow Error
- Invalid Page Name
- Invalid Format
- Invalid Parameter Order
- Invalid Aggregate Error
- Invalid Argument Value Error
- Invalid Attribute Error
- Invalid Blocks Error
- Invalid Client Function
- Invalid Column Reference Error
- Invalid Combo Box Widget Error
- Invalid Data Action
- Invalid Data Dependency
- Invalid Data Type Error
- Invalid Entity Error
- Invalid Entity Index Error
- Invalid Error Handler Error
- Invalid Error Handler Flow Error
- Invalid Excel Handling Error
- Invalid Excel Import Error
- Invalid Expression Error
- Invalid Extensibility Configurations
- Invalid Extension Error
- Invalid External Site Error
- Invalid Flow Error
- Invalid Group Error
- Invalid HTTP Method Error
- Invalid Image Error
- Invalid JavaScript
- Invalid Join Error
- Invalid Link Error
- Invalid List Box Widget Error
- Invalid Module Error
- Invalid Numeric Value Error
- Invalid Property Error
- Invalid Property Value Error
- Invalid Public Action Error
- Invalid Public Block Error
- Invalid Public Screen Block Error
- Invalid Public Structure Error
- Invalid Receive In Error
- Invalid Record Error
- Invalid Record List Indexer Error
- Invalid Reference Error
- Invalid Request Format Error
- Invalid Response Format Error
- Invalid Screen Error
- Invalid SOAP Static Entity Usage Error
- Invalid SQL Error
- Invalid Structure Error
- Invalid Text Value Error
- Invalid Theme Error
- Invalid Transition
- Invalid URL Path Error
- Invalid Use of Grid Units Error
- Invalid User Function Error
- Invalid Username or Password Error
- Invalid Variable Error
- Licensing Error
- Locked Module Error
- Mobile Debugger Related Errors
- module Name Conflict Error
- Module Version Error
- Multiple Date Formats Error
- Old Producer Error
- Publishing Error
- Recursive Theme Hierarchy Error
- Required Input Parameter Error
- Required Output Parameter Error
- Required Permission Error
- Required Property Value Error
- Reserved Page Name
- Unknown Object
- Unused Callback Error
- Unused Input Parameter Error
- Warnings
- Application Configuration Warning
- Audit Suggestion Warning
- Coherence Suggestion Warning
- Data Dependency Warning
- Database Integrity Suggestion Warning
- Debugger Not Started Warning
- Deprecated jQuery Version Warning
- Expression Should Be Escaped Warning
- Grid Dimensions Overflow Warning
- HTML Injection Warning
- Incompatible Consumer Warning
- Inconsistent Dependency Warning
- Internal Warning
- Invalid Argument Value Warning
- Invalid Theme Warning
- Invalid Widget Warning
- JavaScript Injection Warning
- Licensing Warning
- Maintenance Suggestion Warning
- Missing Dependency Warning
- Missing Entity Association Warning
- Missing Entity Filter Warning
- Missing Entity Warning
- Missing Module Warning
- Missing Process Detail Warning
- Missing User Provider Warning
- Modified or Missing Reference Warning
- Module Name Changed Warning
- No Error Handling Warning
- Open Redirect Warning
- Outdated Consumer Info
- Outdated Producer Warning
- Outdated Subscriber Warning
- Performance Suggestion Warning
- Physical Table Name Changed Warning
- Possible Data Loss Warning
- Potential Incompatible Consumer Warning
- Potential Loop at Runtime Warning
- Scalability Suggestion Warning
- Security Warning
- SQL Injection Warning
- Unexpected Attribute Warning
- Unexpected Data Type Warning
- Unexpected Database Warning
- Unexpected Error Handler Warning
- Unexpected Link Warning
- Unexpected SQL Warning
- Unexpected Widget Warning
- Unused Action Warning
- Unused Attribute Warning
- Unused Connector Warning
- Unused Element Warning
- Unused User Action Warning
- Upgrade Information Warning
- Usability Suggestion Warning
- Integration Studio Errors
- Compiler Error
- Connection Error
- Environment Fault Error
- Expression Overflow error
- Extension Name Conflict Error
- Invalid Attribute Error
- Invalid Data Type Error
- Invalid Entity Error
- Invalid Expression Error
- Invalid Extension Error
- Invalid Parameter Error
- Invalid Property Value Error
- Invalid Resource Error
- Invalid Structure Error
- Invalid Text Value Error
- Merge Templates Error
- Missing Resource Error
- Publishing Error
- Resource in Use Error
- Integration Studio Warnings
- Errors
- Integration Studio
- OutSystems APIs
- Asynchronous Logging API
- BinaryData API
- BPT API
- Charts API
- DbCleaner API
- Emails API
- EnhancedWebReferences API
- EPA Taskbox API
- HTTPRequestHandler API
- IncludeJavascript API
- JavaScript API
- LifeTime API v2
- LifeTime SDK
- LifeTime Services API
- outsystems.api.preloader API
- outsystems.api.requestInfo API
- PerformanceMonitoring API
- PlatformPasswordUtils API
- PlatformRuntime API
- Processes API
- REST Extensibility API
- RuntimePublic.Db API
- Sanitization API
- SOAP Extensibility API
- System Actions
- Text API
- Users API
- OutSystems Language
