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

Returns a list of records containing all available fields for given {database} and {layout}.

Query string parameters may be used to limit and paginate the records, preventing timeouts.

Optional query string parameters

RFMmax=<n> [default: 24] Maximum number of records to return. Set 0 (zero) for all records.
RFMskip=<n> Number of records to skip past.
RFMsF<n>=<s> Search Field <n> for find criterion. Must have matching Search Value.
RFMsV<n>=<s> Search Value <n> for find criterion. Must have matching Search Field.
<s> should be in the same format as a FileMaker Find.
e.g. an exact match for 'John' would be '==John'
When URL encoded the entire parameter would appear as: 'RFMsV1=%3D%3DJohn'.
RFMscript=<name> URL encoded script name to be called after result set is generated and sorted.
RFMscriptParam=<string> URL encoded parameter string to pass to script.
RFMpreScript=<name> URL encoded script name to be called before performing the find and sorting the result set.
RFMpreScriptParam=<string> URL encoded parameter string to pass to pre-script.
RFMmetaFieldOnly Set flag to return only field metadata from layout (metaField), no record data.
RFMcontainer=<encoding> [default: DEFAULT] | BASE64
DEFAULT - The container data URL to be fetched separately.
BASE64 - Encode the container data in BASE64 as <filename>;<base64 data>
RFMfind=<SQL query> An SQL subset syntax that may include SELECT, WHERE, ORDER BY, OFFSET, LIMIT.
See the next manual section for details on performing a find request with SQL.

Example URIs and responses

Layout URI - JSON

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
{
    "nav": [
        {
            "name": "start",
            "href": "\/RESTfm\/postcodes\/layout\/brief%20postcodes.json?RFMmax=2"
        },
        {
            "name": "next",
            "href": "\/RESTfm\/postcodes\/layout\/brief%20postcodes.json?RFMmax=2&RFMskip=2"
        },
        {
            "name": "end",
            "href": "\/RESTfm\/postcodes\/layout\/brief%20postcodes.json?RFMmax=2&RFMskip=end"
        }
    ],
    "data": [
        {
            "Pcode": "0810",
            "Locality": "BRINKIN",
            "State": "NT",
            "Comments": ""
        },
        {
            "Pcode": "0810",
            "Locality": "CASUARINA",
            "State": "NT",
            "Comments": ""
        }
    ],
    "meta": [
        {
            "recordID": "5784443",
            "href": "\/RESTfm\/postcodes\/layout\/brief%20postcodes\/5784443.json"
        },
        {
            "recordID": "5784444",
            "href": "\/RESTfm\/postcodes\/layout\/brief%20postcodes\/5784444.json"
        }
    ],
    "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"
        }
    ],
    "info": {
        "tableRecordCount": "16633",
        "foundSetCount": "16633",
        "fetchCount": "2",
        "skip": 0,
        "X-RESTfm-Version": "2.0.1\/r280",
        "X-RESTfm-Protocol": "4",
        "X-RESTfm-Status": 200,
        "X-RESTfm-Reason": "OK",
        "X-RESTfm-Method": "GET"
    }
}

Layout URI - JSON - Search

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"data": [
        {
            "Pcode": "7300",
            "Locality": "DEVON HILLS",
            "State": "TAS",
            "Comments": ""
        },
        {
            "Pcode": "7300",
            "Locality": "PERTH",
            "State": "TAS",
            "Comments": ""
        },
        {
            "Pcode": "7300",
            "Locality": "POWRANNA",
            "State": "TAS",
            "Comments": ""
        }
    ]
}
Search query example. Abridged result, only 'data' section shown.

Changelog

Version Description
1.1.0 Added RFMscript, RFMscriptParam, RFMpreScript and RFMpreScriptParam query string parameters.
2.0.0 Added RFMmetaFieldOnly query string parameter.
4.0.0 Added RFMcontainer and RFMfind query string parameters.