URI /RESTfm/{database}/bulk/{layout} Read - GET

URI /RESTfm/{database}/bulk/{layout}

Returns the requested list of records for a given {database} and {layout}.

Note: The message must be submitted using HTTP POST since HTTP GET cannot contain a message body.

Required query string parameter

RFMmethod=GET|READ

A method override of GET or READ must be specified as HTTP GET cannot contain a message body.

Optional alternative {recordID} format - {unique-key-recordID}

May be used in place of the FileMaker internal record identifier {recordID}.
The uniqueValue should be in the same format as a FileMaker Find.
e.g. an exact match for '1234' would be '==1234'
The final string would then appear as: 'myField===1234'

Example message, URI and response

This example demonstrates a request for records using both {recordID} and {unique-key-recordID}

types.

Note: We override the method with READ (GET), since this message must be submitted with POST.

{
    "meta": [
        {
            "recordID": "9897169"
        },
        {
            "recordID": "9897170"
        },
        {
            "recordID": "Pcode===0811"
        },
        {
            "recordID": "Pcode===0813"
        }
    ]
}

Example bulk JSON format READ message.

http://demo.restfm.com/RESTfm/postcodes/bulk/brief%20postcodes.json?RFMmethod=READ

{
    "meta": [
        {
            "recordID": "9897169"
        },
        {
            "recordID": "9897170"
        },
        {
            "recordID": "9897171"
        },
        {
            "recordID": "9897183"
        }
    ],
    "data": [
        {
            "Pcode": "0810",
            "Locality": "WAGAMAN",
            "State": "NT",
            "Comments": ""
        },
        {
            "Pcode": "0810",
            "Locality": "WANGURI",
            "State": "NT",
            "Comments": ""
        },
        {
            "Pcode": "0811",
            "Locality": "CASUARINA",
            "State": "NT",
            "Comments": "PO Boxes"
        },
        {
            "Pcode": "0813",
            "Locality": "KARAMA",
            "State": "NT",
            "Comments": "PO Boxes"
        }
    ],
    "info": {
        "X-RESTfm-Version": "3.0.0beta\/r420",
        "X-RESTfm-Protocol": "4",
        "X-RESTfm-Status": 200,
        "X-RESTfm-Reason": "OK",
        "X-RESTfm-Method": "GET"
    },
    "metaField": [
        {
            "name": "Pcode",
            "autoEntered": 0,
            "global": 0,
            "maxRepeat": 1,
            "resultType": "text"
        },
        {
            "name": "Locality",
            "autoEntered": 0,
            "global": 0,
            "maxRepeat": 1,
            "resultType": "text"
        },
        {
            "name": "State",
            "autoEntered": 0,
            "global": 0,
            "maxRepeat": 1,
            "resultType": "text"
        },
        {
            "name": "Comments",
            "autoEntered": 0,
            "global": 0,
            "maxRepeat": 1,
            "resultType": "text"
        }
    ]
}

Example bulk JSON format READ response.

Changelog

Version	Description
3.0.0	Added support for bulk operations.