This repository was archived by the owner on Oct 29, 2025. It is now read-only.
Releases: sugarcrm/rest-php-client
Releases · sugarcrm/rest-php-client
1.3.0
Merge pull request #7 from MichaelJ2324/master Fixed FileResponse Bug with Filenames
1.2.0
Merge pull request #6 from MichaelJ2324/master Better Token Management
1.1.2
Merge pull request #3 from MichaelJ2324/master Fixed Two Minor Bugs
1.1.1
Merge pull request #1 from MichaelJ2324/master Updated Unit Test, Generic Abstract Client
1.1
Updated documentation Updated README to point to Wiki. Updated some inline docs on interfaces to match documentation in Wiki.
1.0
- Create Module Records
- - POST
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->createRecord($module)->execute($record);
- - POST
- Read Module Records
- /:record - GET
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->getRecord($module,$recordID)->execute();
- /:record - GET
- List Module Records, and Filter Records using the Filter API
- /filter - POST
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->filterRecords($module)->execute($filterParams);
- /filter - POST
- Update Module Records
- /:record - PUT
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->updateRecord($module,$recordID)->execute($updatedData);
- /:record - PUT
- Delete Module Records
- /:record - DELETE
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->deleteRecord($module,$recordID)->execute();
- /:record - DELETE
- Login
- oauth2/token - POST
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->oauth2Token()->execute($loginParams);
- oauth2/token - POST
- Refresh Token
- oauth2/token - POST
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->oauth2Refresh()->data($loginParams)->execute();
- oauth2/token - POST
- Logout
- oauth2/logout - POST
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->oauth2Logout()->data($loginParams)->execute();
- oauth2/logout - POST
- Me
- me/ - GET
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->me()->execute();
- me/ - GET
- Create Related
- /:record/link/:relationship - POST
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->createRelated('Account',$recordID,'contacts')->execute($contactRecord);
- /:record/link/:relationship - POST
- Filter Related Records
- /:record/link/:relationship - GET
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->filterRelated('Accounts',$recordID,'contacts')->execute($filters);
- /:record/link/:relationship - GET
- Get Related Record
- /:record/link/:relationship/:record_id - GET
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->getRelated('Accounts',$recordID,'contacts',$contactId)->execute();
- /:record/link/:relationship/:record_id - GET
- Relate Records
- /:record/link/:relationship/:record_id - POST
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->linkRecords('Accounts',$recordID,'contacts',$contactId)->execute();
- /:record/link/:relationship/:record_id - POST
- Unlink Records
- /:record/link/:relationship/:record_id - DELETE
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->unlinkRecords('Accounts',$recordID,'contacts',$contactId)->execute();
- /:record/link/:relationship/:record_id - DELETE
- Search Globally
- search - GET
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->search()->execute($search);
- search - GET
- bulk - POST
$SugarAPI = new \SugarAPI\SDK\SugarAPI('instances.this/Pro/7700/',array('username' => 'admin','password'=>'asdf')); $SugarAPI->login(); $Accounts = $SugarAPI->filterRecords('Accounts')->setData(array('max_num'=> 5)); $Contacts = $SugarAPI->filterRecords('Contacts')->setData(array('max_num'=> 1)); $Notes = $SugarAPI->filterRecords('Notes')->setData(array('max_num'=> 3)); $Leads = $SugarAPI->filterRecords('Leads')->setData(array('max_num'=> 2)); $BulkCall = $SugarAPI->bulk()->execute(array( $Accounts, $Contacts, $Notes, $Leads )); - Upload Files to records, such as Note Records
- /:record/file/:field - POST
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->attachFile('Notes',$recordID,'filename')->execute('/path/to/file');
- /:record/file/:field - POST
- Get Files from records, such as Note Records
- /:record/file/:field - GET
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->getAttachment('Notes',$recordID,'filename')->execute();
- /:record/file/:field - GET
- Delete Files from records, such as Note Records
- /:record/file/:field - GET
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->deleteFile('Notes',$recordID,'filename')->execute();
- /:record/file/:field - GET
- Favorite Records
- /:record/favorite - PUT
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->favorite($module,$recordID)->execute();
- /:record/favorite - PUT
- UnFavorite Records
- /:record/favorite - DELETE
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->unfavorite($module,$recordID)->execute();
- /:record/favorite - DELETE
- Ping
- ping - GET
$SugarAPI = new \SugarAPI\SDK\SugarAPI(); $SugarAPI->login(); $SugarAPI->ping()->execute();
- ping - GET