Edit

Prise en main

4D provides you with a powerful REST server, that allows direct access to data stored in your 4D applications.

The REST server is included in 4D and 4D Server, it is automatically available in your 4D applications once it is configured.

Cette section est destinée à vous familiariser avec la fonctionnalité REST à l'aide d'un exemple simple. Nous allons :

• create and configure a basic 4D application project
• access data from the 4D project through REST using a standard browser.

To keep the example simple, we’re going to use 4D and a browser that are running on the same machine. Bien entendu, vous pouvez également utiliser une architecture distante.

Creating and configuring the 4D project

1. Launch your 4D or 4D Server application and create a new project. Vous pouvez, par exemple, le nommer "Emp4D".

2. Dans l'éditeur de structure, créez une table [Employees] et ajoutez-y les champs suivants :

   • Lastname (Alpha)
   • Firstname (Alpha)
   • Salary (Longint)

L'option "Exposer une ressource REST" est cochée par défaut pour la table et pour chaque champ ; ne modifiez pas ce paramètre.

3. Créez des formulaires, puis créez quelques employés :

4. Display the Web/REST resource page of the Settings dialog box and check the Expose as REST server option.

5. Dans le menu Exécuter, sélectionnez Démarrer le serveur Web (si nécessaire), puis sélectionnez Tester le serveur Web.

4D affiche la page d'accueil par défaut du serveur Web 4D.

Accéder aux données 4D avec le navigateur

Vous pouvez désormais lire et modifier des données dans 4D uniquement via les requêtes REST.

Toute requête d'URL 4D REST commence par / rest, pour être insérée après la zone adress:port. Par exemple, pour voir le contenu du datastore 4D, vous pouvez écrire :

http://127.0.0.1/rest/$catalog

Le serveur REST répond :

{
    "__UNIQID": "96A49F7EF2ABDE44BF32059D9ABC65C1",
    "dataClasses": [
        {
            "name": "Employees",
            "uri": "/rest/$catalog/Employees",
            "dataURI": "/rest/Employees"
        }
    ]
}

Cela signifie que le datastore contient le dataclass Employees. You can see the dataclass attributes by typing:

/rest/$catalog/Employees

Si vous souhaitez obtenir toutes les entités de la dataclass Employee, vous pouvez écrire :

/rest/Employees

Réponse :

{
    "__entityModel": "Employees",
    "__GlobalStamp": 0,
    "__COUNT": 3,
    "__FIRST": 0,
    "__ENTITIES": [
        {
            "__KEY": "1",
            "__TIMESTAMP": "2020-01-07T17:07:52.467Z",
            "__STAMP": 2,
            "ID": 1,
            "Lastname": "Brown",
            "Firstname": "Michael",
            "Salary": 25000
        },
        {
            "__KEY": "2",
            "__TIMESTAMP": "2020-01-07T17:08:14.387Z",
            "__STAMP": 2,
            "ID": 2,
            "Lastname": "Jones",
            "Firstname": "Maryanne",
            "Salary": 35000
        },
        {
            "__KEY": "3",
            "__TIMESTAMP": "2020-01-07T17:08:34.844Z",
            "__STAMP": 2,
            "ID": 3,
            "Lastname": "Smithers",
            "Firstname": "Jack",
            "Salary": 41000
        }
    ],
    "__SENT": 3
}

Il existe plusieurs possibilités pour filtrer les données à recevoir. Par exemple, pour obtenir uniquement la valeur de l'attribut "Lastname" de la 2ème entité, vous pouvez simplement écrire :

/rest/Employees(2)/Lastname

Réponse :

{
    "__entityModel": "Employees",
    "__KEY": "2",
    "__TIMESTAMP": "2020-01-07T17:08:14.387Z",
    "__STAMP": 2,
    "Lastname": "Jones"
}

The 4D REST API provides various commands to interact with the 4D applications.