Consumed REST Services

Last update: Edit


Representational State Transfer (REST) is an approach to consume or expose resources. Over recent years it has gained popularity because of it’s simplicity, because no extensive schemas or contracts are needed to transfer data between endpoints. It uses

  • HTTP URLs to locate resources,
  • HTTP headers to authenticate and specify content types (such as XML or JSON)
  • HTTP methods to identify operations on resources, such as GET (retrieve data) or POST (send data).

Lack of contracts and schemas give you an easy start using REST. Many REST endpoints return complex data however. The JSON Structure document helps with giving structure to JSON data: from an example JSON snippet, a lightweight schema is extracted that is used in Mapping Documents. An Import Mapping document converts JSON (or XML) to Mendix objects, and an Export Mapping document serializes Mendix objects to JSON (or XML).


JavaScript Object Notation (JSON) is a lightweight representation of data.

	"name": "John Smith",
	"age": 23,
		"street": "Dopeylane 14",
		"city": "Worchestire"

Above the object ‘person’ is described with the corresponding values for the attributes ‘name’, ‘age’ and the referred object ‘address’.


It is not possible to specify a timeout value.


How to consume REST natively with Mendix