Layoutmetadaten abrufen

Um Layoutmetadaten einschließlich Feldern in einem Layout, Ausschnitten und Wertelisten abzurufen, verwenden Sie eine HTTP GET-Methode mit dem API-Endpunkt layouts und geben einen Layoutnamen an.

HTTP-Methode

GET

URL

Format 1: /fmi/data/version/databases/datenbankname/layouts/layoutname

version – die angeforderte FileMaker Data API-Version, kann v1, v2 oder vLatest sein

datenbankname – der Name der bereitgestellten Datenbank

layoutname – der Name des Layouts, für das Sie Metadaten wünschen

Format 2: /fmi/data/version/databases/datenbankname/layouts/layoutname?recordId=datensatzid

version – die angeforderte FileMaker Data API-Version, kann v1, v2 oder vLatest sein

datenbankname – der Name der bereitgestellten Datenbank

layoutname – der Name des Layouts, für das Sie Metadaten wünschen

datensatzid – um Wertelistenbezugsdaten abzurufen, schließen Sie einen Query-Parameter recordId ein.

HTTP-Header

Authorization: session-token des Inhabers, wobei session-token den eindeutigen Wert des X-FM-Data-Access-Token für die Datenbanksitzung darstellt
Parameter Keine
Antwort

Ein Antwortteil mit fieldMetaData-, portalMetaData- und valueLists-Array und ein Meldungsarray mit einem Fehlercode 0.

Beispiel:

Kopieren 
{
  "response": {
    "fieldMetaData": [
      {
        "name": "Kundenname",
        "type": "normal",
        "displayType": "editText",
        "result": "text",
        "valueList": "Text",
        "global": false,
        "autoEnter": false,
        "fourDigitYear": false,
        "maxRepeat": 1,
        "maxCharacters": 0
        "notEmpty": false,
        "numeric": false,
        "timeOfDay": false,
        "repetitionStart": 1,
        "repetitionEnd": 1
      }
    ],
    "portalMetaData": {},
    "valueLists": [
      {
        "name": "Region",
        "type": "customList",
        "values": [
          {
            "displayValue": "West",
            "value": "West"
          }
          , 
          {
            "displayValue": "Ost",
            "value": "Ost"
          }
        ]
      }
    ]
  },
  "messages": [
    {
      "code": "0",
      "message": "OK"
    }
  ]
}

Siehe Fehlerantworten.

Hinweise 

  • Für dynamische Wertelisten wird eine leere Werteliste zurückgegeben, wenn die Abfrage keinen recordId-Parameter als Teil der URL enthält.