Closed syntithenai closed 8 years ago
REST module.
[] indicates an optional value
<> indicate a required value
To start, you need an authentication token which can be retrieved from the by sending a GET request to token
/rest/token/?api=[&username=&password=]
Username and password are not required if there is already a logged in user
This token needs to be appended to every subsequent request.
To get a single record send a GET request to
/rest/index//id/?token=
To search/retrieve multiple records send a GET request to
/rest/index//[fieldname]/[value]?token=
Fields marked deleted are excluded from the list request, to access all records regardless of deleted status use the deleted request.
/rest/deleted//[fieldname]/[value]?token=
Both index and delete support advanced search criteria ie /rest/index//?token= where works as follows
/LIMIT/10/namelike/fred/agebetween/40___60
/SKIP/10/LIMIT/10/AND/name_like/fred/OR/age_between/020/agegreater/80/END/namelike/jill
To delete records, send a POST request to
/rest/delete//[id]?token=
To save records POST record data to
/rest/save//?token=
REST module.
[] indicates an optional value
<> indicate a required value
To start, you need an authentication token which can be retrieved from the by sending a GET request to token
/rest/token/?api=[&username=&password=]
Username and password are not required if there is already a logged in user
This token needs to be appended to every subsequent request.
To get a single record send a GET request to
/rest/index//id/?token=
To search/retrieve multiple records send a GET request to
/rest/index//[fieldname]/[value]?token=
Fields marked deleted are excluded from the list request, to access all records regardless of deleted status use the deleted request.
/rest/deleted//[fieldname]/[value]?token=
Both index and delete support advanced search criteria ie /rest/index//?token=
where works as follows
fred and age 4-60
/LIMIT/10/namelike/fred/agebetween/40___60
freds aged 0-20,80+ or jill
/SKIP/10/LIMIT/10/AND/name_like/fred/OR/age_between/020/agegreater/80/END/namelike/jill
To delete records, send a POST request to
/rest/delete//[id]?token=
To save records POST record data to
/rest/save//?token=