User Tools
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:devel:corebosws:methodreference [2021/07/20 01:36] joebordes [Validations. Create, Update and Revise with Validations] |
en:devel:corebosws:methodreference [2022/01/08 00:31] (current) joebordes [Retrieve] |
||
|---|---|---|---|
| Line 70: | Line 70: | ||
| Get all the values the user has access to, of an existent record in the application. Given a web service ID of a record this service will return an array with all the fields and their values. | Get all the values the user has access to, of an existent record in the application. Given a web service ID of a record this service will return an array with all the fields and their values. | ||
| + | |||
| + | Note that the way coreBOS works is that you get the values in the format of the database but you must return them in the format of the user. There is a way to [[en:devel:corebosws:skipconvertfields|inform coreBOS to accept values in database format]] and there is a Global Variable (**Webservice_Return_FormattedValues**) to retrieve values in the format of the user connected to the API. | ||
| All reference type fields which are pointing to another record will have valid web service IDs. | All reference type fields which are pointing to another record will have valid web service IDs. | ||
| Line 391: | Line 393: | ||
| ^Method:|**SetRelation**| | ^Method:|**SetRelation**| | ||
| ^Purpose:|Sets relations between one record and a set of other records.| | ^Purpose:|Sets relations between one record and a set of other records.| | ||
| - | ^Profile:|SetRelation(relateThisId:string, withTheseIds:Map):Map| | + | ^Profile:|SetRelation(relate_this_id:string, with_these_ids:Map):Map| |
| ^Send as:|POST| | ^Send as:|POST| | ||
| - | ^Parameters:| => relateThisId: web service ID of the main record to relate \\ => withTheseIds: array of web service IDs to relate to the main record| | + | ^Parameters:| => relate_this_id: web service ID of the main record to relate \\ => with_these_ids: array of web service IDs to relate to the main record| |
| ^Response:| | | ^Response:| | | ||
| ^Examples:|[[https://github.com/tsolucio/coreBOSwsDevelopment/blob/master/testcode/424lib_setrelated.php|Development Tool]]| | ^Examples:|[[https://github.com/tsolucio/coreBOSwsDevelopment/blob/master/testcode/424lib_setrelated.php|Development Tool]]| | ||
| Line 399: | Line 401: | ||
| ^Method:|**UnsetRelation**| | ^Method:|**UnsetRelation**| | ||
| ^Purpose:|Deletes relations between one record and a set of other records.| | ^Purpose:|Deletes relations between one record and a set of other records.| | ||
| - | ^Profile:|UnsetRelation(unrelateThisId:string, withTheseIds:Map):Map| | + | ^Profile:|UnsetRelation(unrelate_this_id:string, with_these_ids:Map):Map| |
| ^Send as:|POST| | ^Send as:|POST| | ||
| - | ^Parameters:| => unrelateThisId: web service ID of the main record to unrelate \\ => withTheseIds: array of web service IDs to unrelate from the main record| | + | ^Parameters:| => unrelate_this_id: web service ID of the main record to unrelate \\ => with_these_ids: array of web service IDs to unrelate from the main record| |
| ^Response:| | | ^Response:| | | ||
| ^Examples:|[[https://github.com/tsolucio/coreBOSwsDevelopment/blob/master/testcode/424lib_setrelated.php|Development Tool]]| | ^Examples:|[[https://github.com/tsolucio/coreBOSwsDevelopment/blob/master/testcode/424lib_setrelated.php|Development Tool]]| | ||
