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

Creates new records in {database} and {layout} from the records provided. Returns the full data of all created records.

Optional query string parameters

RFMsuppressData Set flag to suppress 'data' section from response.
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.

Example message, URI and response

Bulk URI - JSON - POST Message

1
2
3
4
5
6
7
8
9
10
11
12
{
    "data": [
        {
            "Pcode": "9998",
            "Locality": "A New Location 1"
        },
        {
            "Pcode": "9999",
            "Locality": "A New Location 2"
        }
    ]
}
Example bulk JSON format CREATE message.

Bulk URI - JSON - POST Response

http://demo.restfm.com/RESTfm/postcodes/bulk/brief%20postcodes.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
{
    "meta": [
        {
            "recordID": "9913809"
        },
        {
            "recordID": "9913810"
        }
    ],
    "data": [
        {
            "Pcode": "9998",
            "Locality": "A New Location 1",
            "State": "",
            "Comments": ""
        },
        {
            "Pcode": "9999",
            "Locality": "A New Location 2",
            "State": "",
            "Comments": ""
        }
    ],
    "info": {
        "X-RESTfm-Version": "3.0.0beta\/r420",
        "X-RESTfm-Protocol": "4",
        "X-RESTfm-Status": 200,
        "X-RESTfm-Reason": "OK",
        "X-RESTfm-Method": "POST"
    },
    "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 CREATE response.

Changelog

Version Description
3.0.0 Added support for bulk operations.