Obtenir un seul enregistrement

Pour obtenir un seul enregistrement, 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 l'identifiant de l'enregistrement. 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 : /fmi/data/version/databases/nom-base/layouts/nom-modèle/records/id-enregistrement

Format 2 : /fmi/data/version/databases/nom-base/layouts/nom-modèle/records/id-enregistrement?portal=["nom-table-n", ...] &_offset.nom-table=enregistrement-départ &_limit.nom-table=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

id-enregistrement est l'identifiant de l'enregistrement à obtenir

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. Le modèle indiqué par layout.response doit être un modèle pour la même table. L'indication d'un modèle pour une autre table peut produire des résultats inattendus.

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.

Par exemple :

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

Consultez la section Codes d'erreur.

Remarques 

  • Afin de renvoyer des données pour des rangées précises de la table externe, utilisez _offset.nom-table et _limit.nom-table. 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. 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 de 50 enregistrements.