URI /RESTfm/{database}/layout/{layout}/{recordID} Delete - DELETE
URI /RESTfm/{database}/layout/{layout}/{recordID}
Deletes a single record identified by the FileMaker internal {recordID} from {database} and {layout}.
Optional {recordID} format - {unique-key-recordID}
<fieldName>=<uniqueValue> | 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 entire string should be URL encoded. e.g. 'myField===1234', when URL encoded, becomes: 'myField%3D%3D%3D1234' |
Optional query string parameters
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 URI and response
{ "data": [ ], "meta": [ ], "info": { "X-RESTfm-Version": "2.0.1\/r280", "X-RESTfm-Protocol": "4", "X-RESTfm-Status": 200, "X-RESTfm-Reason": "OK", "X-RESTfm-Method": "DELETE" } }
Example JSON format HTTP DELETE response.
Common error responses
{ "data": [ ], "meta": [ ], "info": { "X-RESTfm-FM-Status": "101", "X-RESTfm-FM-Reason": "Record is missing", "X-RESTfm-Version": "2.0.1\/r280", "X-RESTfm-Protocol": "4", "X-RESTfm-Status": 404, "X-RESTfm-Reason": "Not Found", "X-RESTfm-Method": "DELETE" } }
Example JSON format DELETE error response from nonexistent {recordID}.
Changelog
Version | Description |
---|---|
2.0.0 | Added support for {unique-key-recordID}. |
< 2.0.0 | Prior to version 2.0.0 the success response appeared as:204 No Content Error responses appeared as: Error 404 (101: Record is missing) |
1.1.0 | Added RFMscript, RFMscriptParam, RFMpreScript and RFMpreScriptParam query string parameters. |