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

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

Returns all available fields in 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'

Example URI and response

{
    "data": [
        {
            "Pcode": "0810",
            "Locality": "BRINKIN",
            "State": "NT",
            "Comments": ""
        }
    ],
    "meta": [
        {
            "recordID": "5867694",
            "href": "\/RESTfm\/postcodes\/layout\/brief%20postcodes\/5867694.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": {
        "X-RESTfm-Version": "2.0.1\/r280",
        "X-RESTfm-Protocol": "4",
        "X-RESTfm-Status": 200,
        "X-RESTfm-Reason": "OK",
        "X-RESTfm-Method": "GET"
    }
}
{
    "data": [
        {
            "Pcode": "0811",
            "Locality": "CASUARINA",
            "State": "NT",
            "Comments": "PO Boxes"
        }
    ]
}
Example JSON format GET response using a unique-key-recordID. Abridged result, only 'data' section shown.

Changelog

Version Description
2.0.0 Added support for {unique-key-recordID}.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us