Écrire des appels d'API OData

OData utilise les méthodes HTTP suivantes :

• POST

  Utilisée pour Créer une table, Créer un index de rubrique, Créer un enregistrement, Mettre à jour les références d'enregistrement et Exécuter des scripts.

• GET

  Utilisée pour Obtenir la structure et les métadonnées de base de données, les Options de requête et Demander des données.

• PATCH

  Utilisée pour Mettre à jour un enregistrement, Mettre à jour les références d'enregistrement, Mettre à jour des rubriques Conteneur dans un enregistrement à l'aide de données codées en base64, Mettre à jour une rubrique Conteneur dans un enregistrement à l'aide de données binaires et Ajouter des rubriques à une table.

• PUT

  Utilisée pour Créer un enregistrement, Mettre à jour un enregistrement, Mettre à jour les références d'enregistrement, Mettre à jour des rubriques Conteneur dans un enregistrement à l'aide de données codées en base64, Mettre à jour une rubrique Conteneur dans un enregistrement à l'aide de données binaires et Ajouter des rubriques à une table.

• DELETE

  Utilisée pour Supprimer une table, Supprimer une rubrique d'une table, Supprimer un enregistrement et Mettre à jour les références d'enregistrement.

OData utilise les en-têtes suivants :

• Authorization : doit être fournie avec toutes les requêtes. Pour le format requis, consultez la section Créer une connexion authentifiée à l'hôte.

• Accept : indique le format de la réponse attendue. Si cela est spécifié, il doit être l'un des suivants :

  • application/json (par défaut)

  • application/atom+xml (ou application/xml)

  • texte/html

  Pour les applications JSON, l'option propre à JSON IEEE754Compatible=true est prise en charge ; elle indique que les rubriques de type Edm.Int64 et Edm.Decimal sont renvoyées sous forme de valeurs de chaîne de caractères. Consultez la page Format JSON OData 4.01 (en anglais).

  La valeur est remplacée par celle de l'option de requête $format, si cela est spécifié. Consultez la section « Header Accept » de la page Protocole OData 4.01 (en anglais).

• Content-Type : indique le format du corps de la requête pour les méthodes POST, PATCH et PUT. Si cela est spécifié, il doit être l'un des suivants :

  • application/json (par défaut)

  • application/atom+xml (ou application/xml)

  • multipart/mixed (pour les opérations $batch)

  • ou, pour mettre à jour une rubrique Conteneur à l'aide de données binaires, une valeur définie dans Mettre à jour une rubrique Conteneur dans un enregistrement à l'aide de données binaires

  Consultez la section « Header Content-Type » de la page Protocole OData 4.01 (en anglais).

• OData-Version : indique la version du protocole OData. FileMaker Cloud et FileMaker Server prennent en charge OData 4.0. Consultez la section « Header OData-Version » de la page Protocole OData 4.01 (en anglais).

• OData-MaxVersion : indique la version maximale du protocole OData. FileMaker Cloud et FileMaker Server prennent en charge OData 4.0. Consultez la section « Header OData-MaxVersion » de la page Protocole OData 4.01 (en anglais).

• Préférez :

  Les valeurs de protocole OData 4.01 suivantes sont prises en charge :

  • odata.continue-on-error

  • odata.maxpagesize

  • return=representation

  • return=minimal

  Consultez la section « Header Prefer » de la page Protocole OData 4.01 (en anglais).

  Les valeurs spécifiques à FileMaker suivantes sont prises en charge :

  • fmodata.basic-timestamp : pour répondre avec le format d'horodatage FileMaker au lieu du format d'heure Zulu

  • fmodata.gmtoffset : pour répondre avec la différence d'horodatage de l'heure de Greenwich

  • fmodata.entity-ids : pour répondre avec des identifiants de table et de rubrique

  • fmodata.include-specialcolumns : pour répondre avec ROWID et ROWMODID

https://hôte/fmi/odata/version/nom-base

hôte : nom d'hôte FileMaker Cloud ou FileMaker Server.

version : version OData, toujours v4.

nom-base : nom de la base de données hébergée.

Exemple : /fmi/odata/v4/GestionDeContenu