Developer Function: Script: $p.apiUpdate

2026-09-182026-09-18

Overview¶

Describes the methods that allow updating records and Wikis via Ajax POST requests.

How To Use¶

JavaScript¶

$p.apiUpdate({
    id: <Record ID>,
    data: {
        <Update data>
    },
    done: <Optional Processing>,
    fail: <Optional Processing>,
    always: <Optional Processing>
});

Description Of Each Parameter¶

Parameter name	Description
Record ID	Record ID to operate on
Update data	json data to be POSTed
Optional processing	Processing when API communication is successful (done: required), when it fails (fail: optional), and when it is completed (always: optional)

How To Write¶

JavaScript¶

$p.apiUpdate({
    id: 123,
    data: {
        ApiVersion: 1.1,
        ClassHash: {
            ClassA: 'test data'
        }
    },
    done: function (data) {
        console.log(data);
    },
    fail: function (data) {
        console.log(data);
    },
    always: function (data) {
        console.log(data);
    }
});