Skip to content
This repository was archived by the owner on Oct 29, 2025. It is now read-only.

Releases: sugarcrm/rest-php-client

1.3.0

23 Aug 18:02

Choose a tag to compare

Merge pull request #7 from MichaelJ2324/master

Fixed FileResponse Bug with Filenames

1.2.0

10 Aug 15:18

Choose a tag to compare

Merge pull request #6 from MichaelJ2324/master

Better Token Management

1.1.2

02 Jun 16:09

Choose a tag to compare

Merge pull request #3 from MichaelJ2324/master

Fixed Two Minor Bugs

1.1.1

11 May 19:52

Choose a tag to compare

Merge pull request #1 from MichaelJ2324/master

Updated Unit Test, Generic Abstract Client

1.1

09 May 16:03

Choose a tag to compare

1.1
Updated documentation

Updated README to point to Wiki. Updated some inline docs on interfaces
to match documentation in Wiki.

1.0

02 May 21:36

Choose a tag to compare

1.0
  • Create Module Records
    • - POST
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->createRecord($module)->execute($record);
      
  • Read Module Records
    • /:record - GET
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->getRecord($module,$recordID)->execute();
      
  • List Module Records, and Filter Records using the Filter API
    • /filter - POST
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->filterRecords($module)->execute($filterParams);
      
  • Update Module Records
    • /:record - PUT
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->updateRecord($module,$recordID)->execute($updatedData);
      
  • Delete Module Records
    • /:record - DELETE
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->deleteRecord($module,$recordID)->execute();
      
  • Login
    • oauth2/token - POST
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->oauth2Token()->execute($loginParams);
      
  • Refresh Token
    • oauth2/token - POST
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->oauth2Refresh()->data($loginParams)->execute();
      
  • Logout
    • oauth2/logout - POST
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->oauth2Logout()->data($loginParams)->execute();
      
  • Me
    • me/ - GET
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->me()->execute();
      
  • Create Related
    • /:record/link/:relationship - POST
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->createRelated('Account',$recordID,'contacts')->execute($contactRecord);
      
  • Filter Related Records
    • /:record/link/:relationship - GET
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->filterRelated('Accounts',$recordID,'contacts')->execute($filters);
      
  • Get Related Record
    • /:record/link/:relationship/:record_id - GET
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->getRelated('Accounts',$recordID,'contacts',$contactId)->execute();
      
  • Relate Records
    • /:record/link/:relationship/:record_id - POST
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->linkRecords('Accounts',$recordID,'contacts',$contactId)->execute();
      
  • Unlink Records
    • /:record/link/:relationship/:record_id - DELETE
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->unlinkRecords('Accounts',$recordID,'contacts',$contactId)->execute();
      
  • Search Globally
    • search - GET
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->search()->execute($search);
      
  • 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');
      
  • 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();
      
  • 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();
      
  • Favorite Records
    • /:record/favorite - PUT
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->favorite($module,$recordID)->execute();
      
  • UnFavorite Records
    • /:record/favorite - DELETE
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->unfavorite($module,$recordID)->execute();
      
  • Ping
    • ping - GET
      $SugarAPI = new \SugarAPI\SDK\SugarAPI();
      $SugarAPI->login();
      $SugarAPI->ping()->execute();