Obtener un intervalo de registros

Para obtener un intervalo de registros, 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 e información adicional para indicar el registro inicial y el número de registros. También puede especificar el tipo de ordenación de los registros. 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 (devuelve hasta los 100 primeros registros):
/fmi/data/versión/databases/nombre-base-de-datos/layouts/nombre-presentación/records

Formato 2 (devuelve un intervalo de registros):
/fmi/data/versión/databases/nombre-base-de-datos/layouts/nombre-presentación/records?_offset=registro-inicial&_limit=número-de-registros

Formato 3 (devuelve un intervalo ordenado de registros):
/fmi/data/versión/databases/nombre-base-de-datos/layouts/nombre-presentación/records?_offset=registro-inicial&_limit=número-de-registros&_sort=[{ "fieldName": "nombre-campo", "sortOrder": "tipo-ordenación" }, { ... }]

Formato 4 (incluye un intervalo de registros con un intervalo limitado de registros relacionados):
/fmi/data/versión/databases/nombre-base-de-datos/layouts/nombre-presentación/records?_offset=registro-inicial&_limit=número-de-registros&portal=["nombre-portal1", "nombre-portal2", ...]&_offset.nombre-portal1=registro-inicial&_limit.nombre-portal1=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.

En _offset, registro-inicial es el número del primer registro del intervalo de registros.

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

En la especificación _sort, la información debe indicarse en formato JSON. nombre-campo es el nombre del campo que se utilizará como base para ordenar los registros. Puede especificar varios nombres de campo. En tipo-ordenación, especifique la palabra clave ascend o descend para ordenar en orden ascendente o descendente, o indique un nombre de lista de valores.

Para portales:

  • La parte de portal de la URL es opcional. Si se omite portal y la presentación incluye portales, la llamada devolverá registros relacionados de todos los portales del diseño. Por lo tanto, para un mejor rendimiento en diseños con portales, use portal para especificar solo los portales de los que necesita obtener registros relacionados.

  • Solo se devuelven los registros relacionados que se pueden ver en un portal. En el cuadro de diálogo Configuración del portal de FileMaker Pro, estas opciones pueden afectar a los registros que se pueden devolver:

    • Permitir desplazamiento vertical - Si se selecciona, se devuelven todos los registros que se pueden desplazar a la vista. Si se deselecciona, solo se devuelve el número de registros entre Fila inicial y Número de filas (aquellos que son visibles sin desplazarse).

    • Filtrar registros del portal - Si se selecciona, solo se devuelven los registros filtrados.

  • 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.

  • En _offset.nombre-portal-n, registro-inicial hace referencia al número del primer registro del portal del intervalo de registros relacionados. Si no se especifica, el valor predeterminado es 1.

  • En _limit.nombre-portal-n, número-de-registros especifica el número máximo de registros relacionados que debe devolverse. Si no se especifica, el valor predeterminado es 50.

Otros parámetros de URL opcionales:

  • layout.response - Devuelve los datos de respuesta en el contexto de una presentación diferente. La presentación especificada debe ser para la misma tabla base que el diseño actual. Si se especifica una presentación de una tabla base diferente, pueden producirse resultados inesperados.

  • dateformats - Especifica el formato de los campos de fecha y de fecha y hora. El valor es 0 para los formatos de EE.  U., 1 para los formatos de la configuración regional del archivo o 2 para los formatos ISO 8601. Si no se especifica, el valor predeterminado es 0.

  • script.prerequest, script.presort, script - Ejecuta guiones de FileMaker como parte de la solicitud. Consulte Ejecutar un guión con otra petición.

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.

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

Consulte Respuestas de error.

Notas 

  • Puede utilizar parámetros opcionales para especificar las solicitudes de omisión, el orden de clasificación (_sort), el registro inicial (_offset), el número de registros (_limit) y los portales para limitar el número de registros relacionados que se devuelven. Los parámetros _offset, _limit y _sort funcionan en los registros que se encuentran en la tabla de la presentación y no en los registros del portal relacionados. Para limitar el número de registros y filas que se muestran en un conjunto relacionado, especifique el parámetro _offset.portal-name-n y _limit.Parámetros portal-name-n.

  • Si omite los valores _offset y _limit, el valor predeterminado de offset es 1 y el de limit para los registros es 100: _offset=1&_limit=100

  • Si omite la palabra clave sortOrder, el valor predeterminado es ascend (ascendente). Por ejemplo, &_sort=[{ "fieldName": "idRegistro" }] se trata como: &_sort=[{ "fieldName": "idRegistro", "sortOrder": "ascend" }].