Obtener un único registro

Para obtener un registro, utilice un método HTTP GET con el punto de conexión de API records y especifique el nombre de la base de datos, la presentación y el ID de registro. También puede especificar información del portal para limitar el número de registros relacionados que se devuelven.

Método HTTP

GET

URL

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

Formato 2: /fmi/data/versión/databases/nombre-base-de-datos/layouts/nombre-presentación/records/id-registro?portal=["nombre-portal-n", ...] &_offset.nombre-portal=registro-inicial &_limit.nombre-portal=número-de-registros

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

  • Versión 1 (v1): la estructura de los datos del portal devueltos se basa en la configuración de vista (vista Formulario o Tabla) de la presentación especificada.

    • Vista Formulario: devuelve todos los registros relacionados.

    • Vista Tabla: devuelve el primer registro relacionado.

    Nota  Al cambiar la configuración de vista, se modifica la estructura de datos del portal para el valor devuelto.

  • Versión 2 (v2): la estructura de los datos del portal devueltos se basa en la vista Formulario.

  • Última versión (vLatest): el comportamiento se basa en la última versión de la API.

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

nombre-presentación: el nombre de la presentación que se utilizará como contexto para la obtención del registro.

id-registro: el ID del registro que se va a obtener.

Para la palabra clave del portal:

nombre-portal-n hace referencia al portal que contiene los registros relacionados. Un nombre de portal puede ser el nombre del objeto que se muestra en el Inspector de FileMaker Pro o el nombre de la tabla relacionada. Puede especificar varios nombres de portal.

La parte de portal de la URL es opcional. Si la presentación incluye portales, especifique los nombres de portal para mejorar el rendimiento. Si se omite la parte de portal, la llamada devolverá todos los registros relacionados de todos los portales de la presentación.

En _offset.nombre-portal-n, registro-inicial hace referencia al número del primer registro del portal del intervalo de registros relacionados.

En _limit.nombre-portal-n, número-de-registros especifica el número máximo de registros relacionados que debe devolverse.

Si desea obtener los datos de respuesta en el contexto de una presentación diferente, utilice el parámetro layout.response en la URL. La presentación especificada por layout.response debe ser una presentación de la misma tabla. Si se especifica una presentación de una tabla diferente, pueden producirse resultados inesperados.

Puede ejecutar guiones de FileMaker como parte de esta solicitud. Para ello, incluya los parámetros script.prerequest, script.presort y script en la URL. Consulte Ejecutar guiones de FileMaker.

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

Los datos de registros en formato JSON y una matriz de mensajes que muestra el código de error 0.

Por ejemplo:

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

Consulte Respuestas de error.

Notas 

  • Para que se devuelvan datos de filas del portal específicas, utilice _offset.nombre-portal y _limit.nombre-portal. Un nombre de portal puede ser el nombre del objeto que se muestra en el Inspector de FileMaker Pro o el nombre de la tabla relacionada. Si omite los valores de desplazamiento y límite de las filas del portal, el valor predeterminado para el desplazamiento es 1 y el límite predeterminado para los registros del portal es 50.