Obtenir une plage d'enregistrements

Pour obtenir une plage d'enregistrements, utilisez une méthode HTTP GET avec le point de terminaison API records en indiquant le nom de la base de données, le modèle et des informations supplémentaires (enregistrement de départ et nombre d'enregistrements). Précisez éventuellement l'ordre de tri des enregistrements. Vous pouvez également indiquer des informations de table externe pour limiter le nombre d'enregistrements liés renvoyés.

Méthode HTTP

GET

URL

Format 1 (renvoie jusqu'aux 100 premiers enregistrements) :
/fmi/data/version/databases/nom-base/layouts/nom-modèle/records

Format 2 (renvoie une plage d'enregistrements) :
/fmi/data/version/databases/nom-base/layouts/nom-modèle/records?_offset=enregistrement-départ&_limit=nombre-enregistrements

Format 3 (renvoie une plage d'enregistrements triée) :
/fmi/data/version/databases/nom-base/layouts/nom-modèle/records?_offset=enregistrement-départ&_limit=nombre-enregistrements&_sort=[{ "fieldName": "nom-rubrique", "sortOrder": "ordre-tri" }, { ... }]

Format 4 (inclut une plage d'enregistrements avec une plage limitée d'enregistrements liés) :
/fmi/data/version/databases/nom-base/layouts/nom-modèle/records?_offset=enregistrement-départ&_limit=nombre-enregistrements&portal=["nom-table1", "nom-table2", ...]&_offset.nom-table1=enregistrement-départ &_limit.nom-table2=nombre-enregistrements

version : la version FileMaker Data API demandée peut utiliser v1, v2 ou vLatest

  • version 1 (v1) : la structure des données de table externe renvoyées dépend du paramètre d'affichage (Affichage sous forme de formulaire ou Affichage sous forme de tableau) du modèle spécifiquement utilisé.

    • Affichage sous forme de formulaire : renvoie tous les enregistrements liés

    • Affichage sous forme de tableau : renvoie le premier enregistrement lié

      Remarque  Le fait de modifier le paramètre d'affichage modifie également la structure des données de la table externe pour la valeur renvoyée.

  • version 2 (v2) : la structure des données de la table externe renvoyées est basée sur un Affichage sous forme de formulaire.

  • dernière version (vLatest) : le comportement est basé sur la dernière version de l'API.

nom-base est le nom de la base de données hébergée

nom-modèle est le nom du modèle servant de contexte à l'obtention de l'enregistrement

Pour _offset, enregistrement-départ est le numéro d'enregistrement du premier enregistrement de la plage.

Pour _limit, nombre-enregistrements précise le nombre maximal d'enregistrements à renvoyer.

Pour la spécification _sort, les informations doivent être spécifiées au format JSON. nom-rubrique est le nom d'une rubrique servant de base au tri des enregistrements. Vous pouvez indiquer plusieurs noms de rubrique. Pour ordre-tri, indiquez le mot-clé ascend ou descend ou précisez un nom de liste de valeurs.

Pour le mot-clé de la table externe :

nom-table-n est une table externe contenant les enregistrements liés. Un nom de table externe peut être le nom de l'objet tel qu'indiqué dans l'Inspecteur de FileMaker Pro ou le nom de la table liée. Vous pouvez indiquer plusieurs noms de table externe.

La partie de l'URL correspondant à la table externe est facultative. Si le modèle inclut des tables externes, indiquez leur nom pour améliorer les performances. Si la partie relative aux tables externes est ignorée, l'appel renvoie tous les enregistrements liés dans toutes les tables externes du modèle.

Pour _offset.nom-table-n, enregistrement-départ est le numéro d'enregistrement du premier enregistrement de table externe de la plage d'enregistrements liés.

Pour _limit.nom-table-n, nombre-enregistrements précise le nombre maximal d'enregistrements liés à renvoyer.

Si vous voulez que les données de la réponse suivent un modèle différent, utilisez le paramètre layout.response dans l'URL.

Vous pouvez exécuter des scripts FileMaker dans le cadre de cette requête en insérant les paramètres script.prerequest, script.presort et script dans l'URL. Consultez la section Exécuter des scripts FileMaker.

En-tête HTTP

Authorization: Bearer jeton-session, où jeton-session est la valeur X-FM-Data-Access-Token unique de la session de base de données
Paramètres Aucun
Réponse

Les données de l'enregistrement au format JSON et un tableau de messages indiquant un code d'erreur de 0.

Copier 
{
  "response": {
    "data": [
       ... 
    ]
  },
  "messages": [{"code":"0","message":"OK"}]
}

Consultez la section Codes d'erreur.

Remarques 

  • Vous pouvez utiliser les paramètres facultatifs pour indiquer les requêtes à ignorer, l'ordre de tri, l'enregistrement de départ (décalage), le nombre d'enregistrements (limite) et les tables externes pour limiter le nombre d'enregistrements liés renvoyés. Les paramètres de décalage, de limite et de tri couvrent les enregistrements trouvés dans la table du modèle et les enregistrements de table externe non liés. Pour limiter le nombre d'enregistrements et de rangées à afficher dans un ensemble lié, précisez les paramètres offset.nom-table et limit.nom-table.

  • Si vous n'indiquez aucune valeur de décalage et de limite, le décalage par défaut est de 1 et la limite de 100 enregistrements : _offset=1&_limit=100

  • Sans mot-clé sortOrder, la valeur par défaut est ascend. Par exemple, &_sort=[{ "fieldName": "Idenregistrement" }] est traité comme : &_sort=[{ "fieldName": "Idenregistrement", "sortOrder": "ascend" }]

  • Si vous n'indiquez aucune valeur de décalage ou de limite pour les rangées de la table externe, le décalage par défaut est de 1 et la limite par défaut est de 50 enregistrements. Un nom de table externe peut être le nom de l'objet tel qu'indiqué dans l'Inspecteur de FileMaker Pro ou le nom de la table liée.