Ricavare i metadati dei formati

Per recuperare i metadati dei formati, inclusi campi di un formato, portali e liste valori, utilizzare un metodo GET HTTP con endpoint API layouts e specificare il nome di un formato.

Metodo HTTP

GET

URL

Formato 1: /fmi/data/versione/databases/nome-database/layouts/nome-formato

versione – la versione di FileMaker Data API richiesta può utilizzare la v1, v2 o vLatest

nome-database – nome del database ospitato

nome-formato – nome del formato per il quale si desiderano i metadati

Formato 2: /fmi/data/versione/databases/nome-database/layouts/nome-formato?recordId=id-record

versione – la versione di FileMaker Data API richiesta può utilizzare la v1, v2 o vLatest

nome-database – nome del database ospitato

nome-formato – nome del formato per il quale si desiderano i metadati

id-record - per recuperare i dati di liste valori correlate, includere un parametro query recordId.

Intestazione HTTP

Authorization: token-sessione di connessione, dove token-sessione è il valore X-FM-Data-Access-Token univoco per la sessione del database
Parametri Nessuno.
Risposta

Un corpo della risposta con matrici fieldMetaData, portalMetaData e valueLists e una matrice di messaggi con un codice di errore 0.

Ad esempio:

Copia 
{
  "response": {
    "fieldMetaData": [
      {
        "name": "NomeCliente",
        "type": "normal",
        "displayType": "editText",
        "result": "text",
        "valueList": "Testo",
        "global": false,
        "autoEnter": false,
        "fourDigitYear": false,
        "maxRepeat": 1,
        "maxCharacters": 0
        "notEmpty": false,
        "numeric": false,
        "timeOfDay": false,
        "repetitionStart": 1,
        "repetitionEnd": 1
      }
    ],
    "portalMetaData": {},
    "valueLists": [
      {
        "name": "Regione",
        "type": "customList",
        "values": [
          {
            "displayValue": "Ovest",
            "value": "Ovest"
          }
          , 
          {
            "displayValue": "Est",
            "value": "Est"
          }
        ]
      }
    ]
  },
  "messages": [
    {
      "code": "0",
      "message": "OK"
    }
  ]
}

Vedere Risposte di errore.

Note 

  • Per le liste valori dinamiche, viene restituita una lista valori vuota quando la richiesta non include un parametro recordId come parte dell'URL.