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 : nom de la base de données hébergée

nom-modè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 les tables externes :

  • La partie de l'URL correspondant à la table externe est facultative. Si l'option portal est omise et que le modèle inclut des tables externes, l'appel renverra les enregistrements liés de toutes les tables externes du modèle. Ainsi, pour de meilleures performances sur les modèles avec tables externes, utilisez l'option portal afin de spécifier uniquement les tables externes dont vous avez besoin pour obtenir des enregistrements liés.

  • Seuls les enregistrements liés qui peuvent être consultés dans une table externe sont renvoyés. Dans la boîte de dialogue Table externe de FileMaker Pro, ces options sont susceptibles d'affecter les enregistrements qui peuvent être renvoyés :

    • Barre de défilement vertical - Si cette option est sélectionnée, tous les enregistrements qui peuvent être affichés grâce au défilement sont renvoyés. En cas de désélection, seul le nombre d'enregistrements entre Rangée initiale et Nombre de rangées (celles visibles sans défilement) est renvoyé.

    • Filtrer les enregistrements de la table externe - Si cette option est sélectionnée, seuls les enregistrements filtrés sont renvoyés.

  • 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.

  • 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. Si l'option n'est pas définie, la valeur par défaut est 1.

  • Pour _limit.nom-table-n, nombre-enregistrements précise le nombre maximal d'enregistrements liés à renvoyer. Si l'option n'est pas définie, la valeur par défaut est 50.

Autres paramètres d'URL facultatifs :

  • layout.response - Renvoie les données de réponse dans un modèle différent. Le modèle spécifié doit se rapporter à la même table de base que le modèle actuel. L'indication d'un modèle pour une autre table de base peut produire des résultats inattendus.

  • dateformats - Spécifie le format des rubriques de date et d'horodatage. La valeur est 0 pour les formats américains, 1 pour les formats des paramètres régionaux du fichier ou 2 pour les formats ISO 8601. Si elle n'est pas définie, la valeur par défaut est 0.

  • script.prerequest, script.presort, script - Exécute des scripts FileMaker dans le cadre de la requête. Consultez la section Exécuter un script avec une autre requête.

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 (_sort), l'enregistrement de départ (_offset), le nombre d'enregistrements (_limit) et les tables externes pour limiter le nombre d'enregistrements liés renvoyés. Les paramètres _offset, _limit et _sort couvrent les enregistrements trouvés dans la table du modèle et les enregistrements de tables externes non liés. Pour limiter le nombre d'enregistrements et de rangées à afficher dans un ensemble lié, spécifiez les paramètres _offset.nom-table-n et _limit.nom-table-n.

  • Si vous n'indiquez aucune valeur _offset et _limit, 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" }]