<commit_before># Mendix REST Services module

<img src="images/logo.png" style="float: right; padding: 0 0 20px 20px; width:300px" align="right"/>

Welcome to the Rest Services module. This module can be used in [Mendix](http://www.mendix.com/) apps as toolkit if you want to achieve one of the following three purposes:

1. Consume JSON REST based services
2. Publish data or microflows through REST API's
3. (Real time) Synchronization of data between Mendix applications

## Related resources
* RestServices on [GitHub](https://github.com/mendix/RestServices)
* Restservices in the [Mendix Appstore](https://appstore.mendix.com/link/app/rest%20services)
* Blog post: [Consuming your first REST service](http://www.mendix.com/blog/consuming-first-rest-service/)
* Blog post: [REST Part II: Publishing Microflows with REST](http://www.mendix.com/blog/rest-part-ii-publishing-microflows-rest/)

# Table of Contents

* [Getting Started](#getting-started)
* [Consuming REST services](#consuming-rest-services)
* [Publishing REST services](#publishing-rest-services)
  - [Microflows](#publishing-a-microflow)
  - [Data](#publishing-a-data-service)
* [(Real time) data synchronization](#data-synchronization)
* [About JSON serialization](#json-serialization)
* [About JSON deserialization](#json-deserialization)
* [Working with files / binary data](#sending-and-receiving-files)
* [Overview of all functions](#complete-function-reference)
* [Notes for contributers](#development-notes)
* [Changelog](#changelog)

# Getting Started

1. The *RestServices* module can be downloaded from within the Mendix Business Modeler in the Mendix Appstore into any model that is build with Mendix 6.0.1+.
2. The RestServices module depends on the on the [Community Commons](https://appstore.mendix.com/link/app/community%20commons) module, version 6.1 or higher. Download this module as well if it is not already part of your project.
3. *[Optional]* If you want to publish REST services or use the data synchronization features, add `IVK_OpenServiceOverview` to your main navigation if you want to use the administrative features of the RestServices module. Make sure to map your administrative project role to the `Administrator` role in the RestServices module as well.
4. *[Optional]* If you want to publish REST services, add `StartPublishServices` to the startup sequence of your application. Also, the 'rest/' request handler needs to be opened if running in the Mendix Standard Cloud (or on premise).
5. It is strongly recommended to **not** use the default HSQLDB engine if you want to publish RestServices while running locally.<commit_msg>Add navigation layout to dependency list<commit_after># Mendix REST Services module

<img src="images/logo.png" style="float: right; padding: 0 0 20px 20px; width:300px" align="right"/>

Welcome to the Rest Services module. This module can be used in [Mendix](http://www.mendix.com/) apps as toolkit if you want to achieve one of the following three purposes:

1. Consume JSON REST based services
2. Publish data or microflows through REST API's
3. (Real time) Synchronization of data between Mendix applications

## Related resources
* RestServices on [GitHub](https://github.com/mendix/RestServices)
* Restservices in the [Mendix Appstore](https://appstore.mendix.com/link/app/rest%20services)
* Blog post: [Consuming your first REST service](http://www.mendix.com/blog/consuming-first-rest-service/)
* Blog post: [REST Part II: Publishing Microflows with REST](http://www.mendix.com/blog/rest-part-ii-publishing-microflows-rest/)

# Table of Contents

* [Getting Started](#getting-started)
* [Consuming REST services](#consuming-rest-services)
* [Publishing REST services](#publishing-rest-services)
  - [Microflows](#publishing-a-microflow)
  - [Data](#publishing-a-data-service)
* [(Real time) data synchronization](#data-synchronization)
* [About JSON serialization](#json-serialization)
* [About JSON deserialization](#json-deserialization)
* [Working with files / binary data](#sending-and-receiving-files)
* [Overview of all functions](#complete-function-reference)
* [Notes for contributers](#development-notes)
* [Changelog](#changelog)

# Getting Started

1. The *RestServices* module can be downloaded from within the Mendix Business Modeler in the Mendix Appstore into any model that is build with Mendix 6.0.1+.
2. The RestServices module depends on the on the [Community Commons](https://appstore.mendix.com/link/app/community%20commons) module, version 6.1 or higher. Download this module as well if it is not already part of your project.
3. The RestServices module depends on the on the [Navigation Layout](https://appstore.mendix.com/link/app/navigationlayout) module, version 1.0 or higher. Download this module as well if it is not already part of your project.
4. *[Optional]* If you want to publish REST services or use the data synchronization features, add `IVK_OpenServiceOverview` to your main navigation if you want to use the administrative features of the RestServices module. Make sure to map your administrative project role to the `Administrator` role in the RestServices module as well.
5. *[Optional]* If you want to publish REST services, add `StartPublishServices` to the startup sequence of your application. Also, the 'rest/' request handler needs to be opened if running in the Mendix Standard Cloud (or on premise).
6. It is strongly recommended to **not** use the default HSQLDB engine if you want to publish RestServices while running locally.
{'fraction_non_alphanumeric': 0.09728260869565217, 'fraction_numerical': 0.009963768115942028, 'mean_word_length': 5.252548131370329, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 7, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 5, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4363932', 'n_tokens_mistral': 1614, 'n_tokens_neox': 1469, 'n_words': 624}