Obtener metadatos de la presentación

Para recuperar metadatos de una presentación que incluyan campos de una presentación, portales y listas de valores, utilice un método HTTP GET con el punto de conexión de API layouts y especifique un nombre de presentación.

Método HTTP

GET

URL

Formato 1: /fmi/data/versión/databases/nombre-base-de-datos/layouts/nombre-presentación

versión: la versión de FileMaker Data API solicitada puede utilizar v1, v2 o vLatest.

nombre-base-de-datos: el nombre de la base de datos alojada.

nombre-presentación: el nombre de la presentación para la que desea obtener metadatos.

Formato 2: /fmi/data/versión/databases/nombre-base-de-datos/layouts/nombre-presentación?recordId=id-registro

versión: la versión de FileMaker Data API solicitada puede utilizar v1, v2 o vLatest.

nombre-base-de-datos: el nombre de la base de datos alojada.

nombre-presentación: el nombre de la presentación para la que desea obtener metadatos.

id-registro: para recuperar los datos de listas de valores, incluya un parámetro de consulta recordId.

Encabezado HTTP

Authorization: Bearer token-sesión, donde token-sesión es el valor exclusivo de X-FM-Data-Access-Token para la sesión de la base de datos.
Parámetros Ninguno
Respuesta

Un cuerpo de respuesta con las matrices fieldMetaData, portalMetaData y valueLists, y una matriz de mensajes que muestra el código de error 0.

Por ejemplo:

Copiar 
{
  "response": {
    "fieldMetaData": [
      {
        "name": "NombreCliente",
        "type": "normal",
        "displayType": "editText",
        "result": "text",
        "valueList": "Texto",
        "global": false,
        "autoEnter": false,
        "fourDigitYear": false,
        "maxRepeat": 1,
        "maxCharacters": 0
        "notEmpty": false,
        "numeric": false,
        "timeOfDay": false,
        "repetitionStart": 1,
        "repetitionEnd": 1
      }
    ],
    "portalMetaData": {},
    "valueLists": [
      {
        "name": "Región",
        "type": "customList",
        "values": [
          {
            "displayValue": "Oeste",
            "value": "Oeste"
          }
          , 
          {
            "displayValue": "Este",
            "value": "Este"
          }
        ]
      }
    ]
  },
  "messages": [
    {
      "code": "0",
      "message": "OK"
    }
  ]
}

Consulte Respuestas de error.

Notas 

  • En las listas de valores dinámicos, se devuelve una lista de valores vacía si la solicitud no incluye un parámetro recordId como parte de la dirección URL.