Obtenir des métadonnées de modèle

Pour récupérer les métadonnées de modèle, y compris les rubriques d'un modèle, les tables externes et les listes de valeurs, utilisez une méthode HTTP GET avec le point de terminaison API layouts et indiquez un nom de modèle.

Méthode HTTP

GET

URL

Format 1 : /fmi/data/version/databases/nom-base/layouts/nom-modèle

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

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

nom-modèle est le nom du modèle dont vous souhaitez obtenir les métadonnées

Format 2 : /fmi/data/version/databases/nom-base/layouts/nom-modèle?recordId=id-enregistrement

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

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

nom-modèle est le nom du modèle dont vous souhaitez obtenir les métadonnées

id-enregistrement est le paramètre de requête recordId qui permet de récupérer les données d'une liste de valeurs liée.

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

Un corps de réponse contenant les tableaux fieldMetaData, portalMetaData et valueLists, et un tableau de messages indiquant un code d'erreur de 0.

Par exemple :

Copier 
{
  "response": {
    "fieldMetaData": [
      {
        "name": "NomClient",
        "type": "normal",
        "displayType": "editText",
        "result": "text",
        "valueList": "Texte",
        "global": false,
        "autoEnter": false,
        "fourDigitYear": false,
        "maxRepeat": 1,
        "maxCharacters": 0
        "notEmpty": false,
        "numeric": false,
        "timeOfDay": false,
        "repetitionStart": 1,
        "repetitionEnd": 1
      }
    ],
    "portalMetaData": {},
    "valueLists": [
      {
        "name": "Région",
        "type": "customList",
        "values": [
          {
            "displayValue": "Ouest",
            "value": "Ouest"
          }
          , 
          {
            "displayValue": "Est",
            "value": "Est"
          }
        ]
      }
    ]
  },
  "messages": [
    {
      "code": "0",
      "message": "OK"
    }
  ]
}

Consultez la section Codes d'erreur.

Remarques 

  • Pour les listes de valeurs, une liste de valeurs vide est renvoyée lorsque la requête n'inclut pas le paramètre recordId dans l'URL.